API Reference

Challenge 3DSv2 Card

POST request for completing the challenge flow for a 3DSv2 Card - Payment Plans and Arrangements.
Whether Payment Plan or Arrangement is used is decided based on config.
Note that the request body for an Arrangement challenge is different to that of a payment plan challenge (see examples).

Log in to see full request history
Query Params
integer

Reference number of account to save card to while logged out, if x-access-token is sent, this is ignored

string

Reference uuid for paymentToken

Body Params

The body to complete the challenge flow for a 3DSv2 Card. Note that payment plans require paymentPlanLUUID, whereas arrangements do not

string
required

Required. Challenge Request Encoded String for 3DSv2 authentication.

string
required

Required. Original transaction ID for referencing the challenge.

cardDetails
object
required

Schema for providing card and associated address details.

string

Optional. Required only if the challenge is for a payment plan.

string
required

Required. Date for the payment plan, formatted as YYYY-MM-DD.

string
required

Required. Frequency of the payment

number
required

Required. Amount for the payment plan.

string
required

Required. First name of the cardholder.

string
required

Required. Last name of the cardholder.

string
required

Required. Date of birth of the cardholder, formatted as YYYY-MM-DD.

string
required

Required. Email address of the cardholder.

browserData
object
required

Browser-related data for the transaction.

string
required

Required. URL where transaction notifications will be sent.

string
required

Required. URL for contacting the merchant.

boolean

Optional. Whether a 3D Secure challenge should be requested.

Responses

Language
Credentials
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json