curl --request POST \
--url https://vault.staging.crossmint.com/api/2026-09-16/payment-methods \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"bankAccount": {
"accountHolder": {
"address": {
"city": "Dubai",
"line1": "Sheikh Zayed Road 1"
},
"name": "Omar Haddad"
},
"entityType": "individual",
"iban": "AE460090000000123456789"
},
"type": "bank-account-ae",
"userLocator": "email:omar.haddad@example.ae"
}
'{
"bankAccount": {
"accountHolder": {
"address": {
"city": "Dubai",
"line1": "Sheikh Zayed Road 1"
},
"name": "Omar Haddad"
},
"accountSuffix": "6789",
"country": "AE",
"currency": "aed",
"entityType": "individual"
},
"createdAt": "2026-10-19T09:00:00.000Z",
"paymentMethodId": "7c1e5a93-2d4b-4f68-a0c9-3b8e6d2f1a47",
"reason": null,
"status": "pending",
"statusReason": null,
"type": "bank-account-ae",
"updatedAt": "2026-10-19T09:00:12.000Z"
}Create Payment Method
Saves a payment method for a user so it can be reused across Checkout, Onramp, and Offramp orders. Sensitive fields (PAN, CVC, account numbers, IBANs, Bre-B keys) must be submitted through vault.crossmint.com, which tokenizes them before forwarding to Crossmint servers. Duplicate detection prevents saving the same card or account twice for the same user.
Supported types are card, the bank-account variants (bank-account-us, bank-account-mx-clabe, bank-account-co, bank-account-sepa-iban, bank-account-ph) and bre-b.
API scope required: payment-methods.create
curl --request POST \
--url https://vault.staging.crossmint.com/api/2026-09-16/payment-methods \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"bankAccount": {
"accountHolder": {
"address": {
"city": "Dubai",
"line1": "Sheikh Zayed Road 1"
},
"name": "Omar Haddad"
},
"entityType": "individual",
"iban": "AE460090000000123456789"
},
"type": "bank-account-ae",
"userLocator": "email:omar.haddad@example.ae"
}
'{
"bankAccount": {
"accountHolder": {
"address": {
"city": "Dubai",
"line1": "Sheikh Zayed Road 1"
},
"name": "Omar Haddad"
},
"accountSuffix": "6789",
"country": "AE",
"currency": "aed",
"entityType": "individual"
},
"createdAt": "2026-10-19T09:00:00.000Z",
"paymentMethodId": "7c1e5a93-2d4b-4f68-a0c9-3b8e6d2f1a47",
"reason": null,
"status": "pending",
"statusReason": null,
"type": "bank-account-ae",
"updatedAt": "2026-10-19T09:00:12.000Z"
}CrossmintPaymentMethodManagement component. Card data is collected directly by Crossmint in the browser and never touches your servers, so you do not need to be PCI compliant to use it.vault.staging.crossmint.com or vault.crossmint.com), which tokenizes sensitive fields before forwarding to the API. Raw card numbers, CVCs, and bank account numbers never reach api.crossmint.com directly.Authorizations
Body
- MX CLABE
- CR bank account
- VN bank account
- NG bank account
- PH bank account
- TH bank account
- ID bank account
- JO bank account
- IL bank account
- TR bank account
- AE bank account
- US bank account
- CO bank account
- SEPA IBAN
- CO Bre-B key
- Card
Send the sub-object that matches type.
Identifies the target user when authenticating with a server API key. Format: <type>:<value> (e.g., email:alice@example.com, userId:abc123, phoneNumber:+12125551234, twitter:alice). Required for API-key authentication; ignored when authenticating with a JWT (the JWT subject is used).
1Response
The saved payment method, including the derived displayName and the type-specific sub-object (card, bankAccount, or breB).
- CO bank account
- MX CLABE
- AE bank account
- ID bank account
- IL bank account
- JO bank account
- NG bank account
- PH bank account
- TH bank account
- TR bank account
- VN bank account
- US bank account
- SEPA IBAN
- CR bank account
- CO Bre-B key
- Card
A saved payment method. Sensitive fields (full PAN, CVC, full account numbers, IBANs, Bre-B keys) are never included.
Whether a payout provider serves this destination. 'pending' while the readiness checks run, 'active' when a provider advertises a rail for it, 'rejected' when it cannot receive funds, 'deleted' when it was deleted. This describes the destination only, never the payer's eligibility. 'pending' moves to 'active', 'rejected' or 'deleted'; 'active' moves to 'rejected' or 'deleted'; 'rejected' moves only to 'deleted'. Branch on this field, never on statusReason.
active, deleted, pending, rejected Why the status is 'rejected'. Null on every other status, and on a rejection with no established destination condition. Known values today: destination-not-found, destination-closed, destination-cannot-receive, no-rail-available. New codes can appear at any time, so branch on status and treat an unrecognised code as the status alone.
Was this page helpful?

