Update intent by Id

Patch
/api/pay/v1/intents/5548

This endpoint allows you to update an existing intent by sending an HTTP PATCH request to the specified URL with the intent ID. This is used for changing the return or notification_url.

Parameters

intent_id (string, required)

Request Body

  • notification_url (string): The URL to receive notifications.
  • return_url (string): The URL to redirect after the intent is updated.

Response

Upon a successful request, the server will respond with the updated intent object, including the following fields:

  • id (integer): The ID of the intent.
  • payment_intent (string): The payment intent associated with the 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 (integer): The amount of the transaction.
  • return_url (string): The URL to redirect after the intent is updated.
  • notification_url (string): The URL to receive notifications.
  • card_layout (string): The layout of the card.
  • element (object): An object containing specific elements related to the intent.
  • merchant_id (integer): The ID of the merchant associated with the intent.
  • transaction_unique (string): The unique identifier for the transaction.
Security
HTTP
Type bearer
Header parameters
Authorization
string
ExampleBearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJtZXJjaGFudF9pZCI6NDM5OCwic2VjcmV0X2tleSI6IjYzMTBlNDhiZGQwZTQzODE0NTlhNjJiNDZkMmM0ZmQ2ZThhYjY1YTJhNGQ1MjA1YzZjM2RkZWJmYmJhZWJiZjgiLCJleHAiOjE3MjA3MDcyNjZ9.91qa4veQ9xGVM-Jc_3_i_vaykEdYarRwUzb-37aLD0c
Body parameters
object
Example{ "notification_url": "https://www.blinkpayment.co.uk/notification", "return_url": "https://www.blinkpayment.co.uk/return" }
Responses
200

Successful response