Create Pay Plan

Create a pay plan and payment token from a successful pay plan offer. The payment token can be used to pay for an order for the matching amount and merchant.

If called with a customer JWT, the pay plan is created for that customer, otherwise the customer must be provided via the Customer-Id request header.

SecurityMarketplace API Key | Merchant Public Token | Merchant Secret Token | Customer JWT | Merchant JWT | Marketplace JWT
Request
Request Body schema: application/json
required
termsAndConditionsAccepted
required
boolean

Has the customer accepted the terms and conditions of the pay plan

required
object (OfferDetails)

Details of the pay plan offered to the customer

offerVerificationToken
required
string

Tamper detection digital signature

required
BankTransfer (object) or Card (object) or SavedPaymentSource (object) (PaymentSource)
threeDsSessionId
string

3DS session id, optional as it is only used in extended 3DS scenarios such as Cardinal 3DS2, which performs an extended device data check cycle returning a session id that is passed to the backend as part of the payment token data

SurchargeQuoted (object) or SurchargeSpecified (object) (SurchargeRequirement)
Responses
200
400
401
403
404
405
406
409
422
429
500
503
post/payplans
Request samples
application/json
{
  • "termsAndConditionsAccepted": true,
  • "offerDetails": {
    },
  • "offerVerificationToken": "string",
  • "paymentSource": {
    },
  • "threeDsSessionId": "string",
  • "surchargeRequirement": {
    }
}
Response samples
application/json
{
  • "payPlan": {
    },
  • "paymentTokenId": "ptkn_Z2OS0pJDfRbNb_Sz"
}
Copyright © April Solutions 2023. All right reserved.