Pay Order

Pay for an order using a payment token. Make sure you read the Error Handling page as you will need to add some logic to handle a 3DS challenge for card based payments.

3DS may be required for several reasons including

  • Explicitly requesting it in the request
  • An eligibility requirement to establish a pay plan
  • Required by the card issuer
SecurityMarketplace Api Key | Merchant Secret Token | Pay By Link Token
Request
path Parameters
orderId
required
string
Request Body schema: application/json
required
One of:
required
object (Confirm3DSComplete1)

When 3DS is required, a card based PayOrder call returns status code 200 with response type ThreeDSAuthorisationRequired containing the details needed to complete the 3DS challenge. Use this action to complete the pay order process after the 3DS challenge is complete. See 3D-Secure Utilisation for further details.

Responses
200
400
401
404
405
409
422
429
500
501
503
post/orders/{orderId}/pay
Request samples
application/json
{
  • "Confirm3DSComplete": {
    }
}
Response samples
application/json
{
  • "PayOrderComplete": {
    }
}
Copyright © April Solutions 2023. All right reserved.