Patch
/api/pay/v1/intents/{intent_id}
This endpoint allows you to update an existing intent by sending an HTTP PATCH request to the specified URL with the intent ID. The intent can only be changed when it is active.
Request Parameters
intent_id(string, required)
Request Body
amount(number, optional): Amount of the transaction.return_url(string, optional ): GET URL to return to after transaction completion.notification_url(string, optional ): POST URL for transaction notification as the transaction is completed.
Response Parameters
id(number): The unique identifier of the intent.payment_intent(string): The type of payment intent.transaction_type(string): The type of transaction.expiry_date(string): The expiry date of the intent.status(string): The status of the intent.payment_type(string): The type of payment.currency(string): The currency of the transaction.amount(number): The amount of the transaction.return_url(string): The URL to return to after the transaction.notification_url(string): The URL for transaction notifications.card_layout(string): The layout of the card inputs in ccElement and ccMotoElement.element(object): An object containing specific elements for credit card, moto, and online banking transactions:ccElement(string): Credit card element.ccMotoElement(string): Moto (Mail Order/Telephone Order) element.obElement(string): Open banking element.ddElement(string): Direct debit element.gpElement(string): Google Pay element.apElement(string): Apple Pay element.
merchant_id(number): The identifier of the merchant.transaction_unique(string): The unique identifier of the transaction.
Security
HTTP
Type bearer
Header parameters
Authorization
string
ExampleBearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJtZXJjaGFudF9pZCI6NDM5OCwic2VjcmV0X2tleSI6IjYzMTBlNDhiZGQwZTQzODE0NTlhNjJiNDZkMmM0ZmQ2ZThhYjY1YTJhNGQ1MjA1YzZjM2RkZWJmYmJhZWJiZjgiLCJleHAiOjE3MjA3MDcyNjZ9.91qa4veQ9xGVM-Jc_3_i_vaykEdYarRwUzb-37aLD0c
Path parameters
intent_id
stringRequired
Body parameters
object
Example{
"notification_url": "https://www.blinkpayment.co.uk/notification",
"return_url": "https://www.blinkpayment.co.uk/return"
}
Responses
200
Successful response