Payment instrument

A payment instrument represents a saved digital payment method associated with a consumer. It is automatically generated for all successful payment charge requests or can be explicitly created using the Create a Payment Instrument call.

An existing payment instrument ID is used to initiate recurring transactions or streamline the checkout process for returning customers by utilizing their saved payment details. Learn more about recurring payments.

📘

The instrument object is also used in the Create payment charge call to provide details for certain payment methods.

Each payment instrument is associated with an instrument type:

• BANK_ACCOUNT: Stores the key components of a bank account (name, account number, bank code), IBAN and SWIFT code.
• PASSTHROUGH_WALLET: Stores any reusable components provided by payment methods where the funds are debited through an underlying payment source.
• RAW_CARD: Used to provide card details in the clear for the payment method CARD. Transmitting sensitive card data has significant PCI DSS implications, any RAW_CARD data provided will be converted to the instrument type CARD_PPRO_VAULTED.
• CARD_PPRO_VAULTED: All card payments processed through PPRO are tokenized and securely stored in our vault. The payment instrument stores the card details, replacing the PAN and CVV with an alias. Learn more about PPRO's vault.
• CARD_NETWORK_TOKEN: If you are already collecting network tokens from card networks such as Visa, Mastercard, and American Express, you can use these tokens to make payments by providing the network token and one-time use cryptogram. Learn more about network tokens.
• MOCK: Used in the sandbox environment only for the payment method MOCK. Learn more about mock processor.

Mapping of payment methods to instrument type: