Create 3DS Card Payment Plan

post {protocol}://{domain}/helpdesk/payment/plans/3dscard

POST request for creating a 3DSv2 Card Payment Plan or Arrangement.
If the payment is due today, it will use tokenise and charge
If the payment is due in the future it will use tokenise
Whether Payment Plan or Arrangement is used is decided based on config.
If a challenge is requested by the bank it will include a challengeRequested object in the response body.

Query Params

reference

integer

Reference number of account to user to charge, if x-access-token is sent, this is ignored

Body Params

amount

number

required

The payment amount for the plan. Required.

settlementAmount

number

Optional. The amount to be settled.

date

string

required

Required. The date for the payment in the plan, formatted as YYYY-MM-DD.

frequency

string

required

Required. Frequency of the payment

cardUUID

string | null

Optional. The UUID of the saved card to use.

cardDetails

object

Schema for providing card and associated address details.

firstName

string

Optional. First name of the cardholder.

lastName

string

Optional. Last name of the cardholder.

dob

string

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

string

Optional. Email address of the cardholder.

rememberCard

boolean

Optional. Whether to remember the card for future transactions.

browserData

object

Browser-related data for the transaction.

notificationUrl

string

Optional. URL where transaction notifications will be sent.

contactUrl

string

Optional. URL for users to contact the merchant.

requestChallenge

boolean

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

Responses

Language

Credentials

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://public.glabs.financial-cloud.co.uk/helpdesk/payment/plans/3dscard \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "frequency": "monthly"
8
}
9
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

2013DSv2 Card Payment Plan created successfully

400There was an error creating the Payment Plan

500Internal Server Error