Last updated 3 minutes ago

Payment Instruments

What is a payment instrument?

A payment instrument is like a payment card, bank account, PayPal account, or more.
It's required for collecting payments electronically.

The payment instruments are not a singular resource, but rather used to refer to the concept, which is made up of specific resources like payment cards and bank accounts.

Lifecycle

We recommend creating payment instruments via our FramePay library to help minimize PCI DSS compliance and automate the collection of risk metadata and lead source data.

A payment card has a lifecycle of being inactive or verification-needed.
After the first approved transaction, it is marked as active.
If it reaches the expiration date, it is marked as expired. At any time, it can be deactivated which effectively removes it from being used.

Usage

A customer may have a default payment instrument. Within other API resources, it is often referenced as a paymentInstrument object, like this:

payment-cardbank-accountpaypal
"paymentInstrument": {
    "method": "payment-card",
    "paymentCardId": "<id generated by API>"
}
"paymentInstrument": {
    "method": "paypal",
    "payPalAccountId": "<id generated by API>"
}
Note: Not all payment instruments are suitable for recurring autopay transactions.