Skip to main content
POST
Register a payment instrument for a customer

Authorizations

Authorization
string
header
required

Merchant API key bearer token.

Headers

Idempotency-Key
string
required

Client-supplied unique key for safe retries of this mutating request. Scoped per merchant or resource as documented on each endpoint.

Example:

"idem-01"

Body

application/json

Payment instrument registration payload. vaultToken requires id, provider, and kind; fingerprint is optional when the Element provides it.

vaultToken
object
required
instrumentHolderName
string
required

Name on the instrument (cardholder or bank account owner) — forwarded to Finix PI name

Minimum string length: 1
customerId
string
required
billingAddress
object
metadata
object

Response

201 - application/json
paymentInstrumentId
string
required
type
enum<string>
required
Available options:
card,
bank_account
displayDetails
object
required
status
enum<string>
required
Available options:
pending,
active,
failed,
disabled
createdAt
string<date-time>
required
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))$
metadata
object