Payment Instruments
List payment instruments
List the cards stored in the vault for a merchant. An instrument is
created automatically when a card transaction succeeds and the acquirer
returns a vault token. Use the vault_token value to charge the stored
card again, as described in the returning customers guide.
Merchant API keys list their own instruments. Partner API keys must
include merchant_id for a linked merchant.
query Parameters
statusFilter by status.
merchant_idRequired for partner API keys. Must be a merchant linked to the authenticated partner.
per_pageNumber of instruments per page (1-100, default 25).
pagePage number (1+).
List payment instruments › Responses
successmessagecodeRevoke a payment instrument
Revoke a stored card so its vault token can no longer initiate transactions. Revocation is idempotent: revoking an already revoked instrument succeeds without changing anything. If the same card is stored again later, the instrument reactivates with the same token.
Merchant API keys revoke their own instruments. Partner API keys can revoke instruments of linked merchants.
path Parameters
paymentInstrument_public_idThe payment instrument id.
Revoke a payment instrument › Responses
successmessagecode