Submit details for a payment

post /payments/details

Submits details for a payment created using /payments. This step is only needed when no final state has been reached on the /payments request, for example when the shopper was redirected to another page to complete the payment.

Endpoint destination URL
Click to copy

Header parameters

Idempotency-Key string

A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).

Request parameters

authenticationData object

Data for 3DS authentication.

details object Required

Use this collection to submit the details that were returned as a result of the /payments call.

paymentData string
Max length: 100000

The paymentData value from the /payments response. Required if the /payments response returns this value.

threeDSAuthenticationOnly boolean Deprecated in version 69

Use authenticationData.authenticationOnly instead.

Change the authenticationOnly indicator originally set in the /payments request. Only needs to be set if you want to modify the value set previously.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

  • 200 - OK

    The request has succeeded.

    Show more Show less
  • 400 - Bad Request

    A problem reading or understanding the request.

    Show more Show less
  • 401 - Unauthorized

    Authentication required.

    Show more Show less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show more Show less
  • 422 - Unprocessable Entity

    A request validation error.

    Show more Show less
  • 500 - Internal Server Error

    The server could not process the request.

    Show more Show less
  • Request
  • Click to copy
  • Response
  • Click to copy