Create Saved Pay Card

Creates a new full payment method and token, which can be used to pay for an existing order

SecurityLimepay-SecretKey
Request
Request Body schema: application/json
required
object (PaymentAmount)

The amount and currency of the order, unsurcharged, used if the checkout amount is the same for all payment types (ie paymentTypeAmounts is omitted)

cardPaymentSourceId
required
string

PaymentSourceId of a saved card

cardCvc
string

Tokenised CVC for the card

customerId
string

Optional Customer ID to associate this full payment with. If the PaymentSourceId belongs to a Customer, this ID must match.

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

Responses
201

Success

202

PaymentActionRequired

400
401
403
404
405
406
409
422
429
500
503
post/payments/saved-card
Request samples
application/json
{
  • "paymentAmount": {
    },
  • "cardPaymentSourceId": "psrc_ZkqRkIi-rDZ4MCZW",
  • "cardCvc": "string",
  • "customerId": "cust_ZkqRkIi-rDZ4MCZR",
  • "threeDsSessionId": "string"
}
Response samples
application/json
{
  • "paymentTokenId": "ptkn_ZkqRkoi-rDZ4MCZq",
  • "payCardId": "card_ZkqRk4i-rDZ4MCZr"
}
Copyright © April Solutions 2023. All right reserved.