Skip to content

Update payment details

Request

Update details about existing payment.

Security
bearer and basic and apiKey
Path
idstringrequired

PayId assigned by Axepta Online in the initial request.

Bodyapplication/jsonrequired
transIdstring, <= 64 characters

Transaction ID provided by you which should be unique for each payment.

amountobject(amountMini)

Amount object of the payment plan.

refNrstring

Your unique reference number for the specific operation. You can pass this value to reconcile different operations in a payment (authorization, capture, refund, etc) individually.

orderobject(order)
billingAddressobject(billingAddress)
shippingobject(shipping)
customerInfoobject(customerInfoUpdate)

Information about the customer.

eventTokenstring

Intent of the updating the payment details.Note: Not all event tokens are applicable for all payment method types. Refer payment method specific pages in our product guide to know the relevant event tokens for a specific payment method.

Enum:"UPDATE_ORDER_DETAILS""UPDATE_ADDRESS""UPDATE_REFERENCE""RESEND_INVOICE""DELETE_PERSONAL_DATA"
paymentMethodsobject(paymentUpdate)
curl -i -X PATCH \
  -u '<username>:<password>' \
  'https://test.paymentpage.axepta.bnpparibas/api/v2/payments/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "amount": {
      "value": 1000,
      "currency": "EUR"
    },
    "paymentMethods": {
      "amazonPay": {
        "merchantCountryCode": "EU"
      }
    }
  }'

Responses

Successful operation

Bodyapplication/json
payIdstring

A unique identifier assigned by Axepta Online to the payment. This ID remains constant throughout the lifecycle of the payment and is used to track and reference the payment across all subsequent operations, such as authorization, capture, refund, or cancellation.

merchantIdstring

Merchant ID assigned by Axepta Online.

transIdstring

Transaction ID provided by you in the request.

xIdstring

A unique identifier assigned by Axepta Online for each operation in the payment. For example: xId will be different for the authorization and capture operations of a payment whereas payId will be same.

refNrstring

Reference number provided by you in the request.

statusstring

Status of the transaction.

responseCodestring

Response code of the transaction.

responseDescriptionstring

Response description associated with the response code.

metadataobject
paymentMethodsobject(paymentUpdateResponse)
Response
{ "merchantId": "test_merchant_id", "payId": "6c7c66e5352241c19d82c175a01f713a", "xId": "93c4093c6d3644fcb6c60484f7a831fd", "transId": "98582271-63d2-4b90-9422-5fb597a4c41d", "status": "OK", "responseCode": "00000000", "responseDescription": "success" }