payment-instruments
Register a payment instrument for a customer
Accepts a Basis Theory vault token id only (vaultToken.id). Do not send a vault provider field.
POST
Register a payment instrument for a customer
Authorizations
Merchant API key bearer token. Legacy wire prefixes api_key_ and api_ are also accepted.
Body
application/json
Payment instrument registration payload. vaultToken is { id } only; Basis Theory is inferred server-side.
Vault token reference. Send the Basis Theory token id only; provider is inferred server-side.
Name on the instrument (cardholder or bank account owner) — forwarded to Finix PI name
Minimum string length:
1Minimum string length:
1Response
201 - application/json
Available options:
card, bank_account - Option 1
- Option 2
Available options:
pending, active, failed, disabled Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$