curl --request POST \
--url https://vault.staging.crossmint.com/api/unstable/payment-methods \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <x-api-key>' \
--data '
{
"bankAccount": {
"accountNumber": "1234567890",
"accountType": "savings",
"bankCode": "001",
"billing": {
"address": {
"city": "Bogotá",
"country": "CO",
"line1": "Carrera 7",
"postalCode": "110010",
"stateOrRegion": "DC"
},
"name": "Carlos Gómez",
"phone": "+573001234567"
},
"country": "CO",
"currency": "cop",
"documentNumber": "1234567890",
"documentType": "cc",
"entityType": "individual"
},
"type": "bank-account-co",
"userLocator": "email:carlos.gomez@example.com"
}
'{
"bankAccount": {
"accountSuffix": "7890",
"accountType": "savings",
"bankCode": "001",
"bankName": null,
"country": "CO",
"currency": "cop",
"entityType": "individual"
},
"createdAt": "2026-08-20T19:10:00.000Z",
"paymentMethodId": "1cad2281-bd3d-4219-8787-7dfea94c60b1",
"reason": null,
"status": "pending",
"statusReason": null,
"type": "bank-account-co",
"updatedAt": "2026-08-20T19:12:11.000Z"
}Create Payment Method
Save a payment method for a user so it can be used with Checkout, Onramp, and Offramp orders
curl --request POST \
--url https://vault.staging.crossmint.com/api/unstable/payment-methods \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <x-api-key>' \
--data '
{
"bankAccount": {
"accountNumber": "1234567890",
"accountType": "savings",
"bankCode": "001",
"billing": {
"address": {
"city": "Bogotá",
"country": "CO",
"line1": "Carrera 7",
"postalCode": "110010",
"stateOrRegion": "DC"
},
"name": "Carlos Gómez",
"phone": "+573001234567"
},
"country": "CO",
"currency": "cop",
"documentNumber": "1234567890",
"documentType": "cc",
"entityType": "individual"
},
"type": "bank-account-co",
"userLocator": "email:carlos.gomez@example.com"
}
'{
"bankAccount": {
"accountSuffix": "7890",
"accountType": "savings",
"bankCode": "001",
"bankName": null,
"country": "CO",
"currency": "cop",
"entityType": "individual"
},
"createdAt": "2026-08-20T19:10:00.000Z",
"paymentMethodId": "1cad2281-bd3d-4219-8787-7dfea94c60b1",
"reason": null,
"status": "pending",
"statusReason": null,
"type": "bank-account-co",
"updatedAt": "2026-08-20T19:12:11.000Z"
}Returns
Returns a PaymentMethod object.Headers
API key required for authentication
Body
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
Show child attributes
Show child attributes
Account identifier type: Mexican bank account identified by an 18-digit CLABE. type names the account identifier / capture schema Crossmint collects — never the payment rail; rail selection happens at payment execution time.
bank-account-mx-clabe The client's own name for this payment method. Free text, echoed back on every read.
1 - 255Identifies 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 payment method has been successfully created
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
Show child attributes
Show child attributes
ISO 8601 timestamp when this payment method was created.
"2024-01-15T10:30:00.000Z"
1Deprecated. Use statusReason, which carries the same value.
Whether this destination can receive a payout right now. 'pending' while the readiness checks run, 'active' when a provider has confirmed a rail, 'rejected' when it cannot receive funds, 'deleted' when it was deleted. 'pending' moves to 'active', 'rejected' or 'deleted'; 'active' and 'rejected' move 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.
bank-account-mx-clabe ISO 8601 timestamp when this payment method was last modified.
"2024-01-15T10:30:00.000Z"
The client's own name for this payment method, when one was sent.
1Read-only. ISO 8601 timestamp of the most recent successful offramp payout funded by this bank account. Absent if none.
"2024-01-15T10:30:00.000Z"
Was this page helpful?