v2

latestOpenAPI 3.1.0raw.githubusercontent.com2026-02-10204364.2 KB
payments

Register payment instrument

Register a payment instrument for use in order creation.

post/payment-instruments

Request body

idstring required

Unique instrument identifier.

handler_idstring required

Handler instance identifier.

type'evm_auth_capture_escrow' required

Instrument category (e.g., 'card', 'tokenized_card').

displayobject

Display information for the instrument. Each payment instrument schema defines its specific display properties, as outlined by the payment handler.

payment_info_hashstring required

Hash identifying the on-chain payment authorization.

operatorstring required

Operator address.

payerstring required

Payer address.

chain_idinteger required

EVM chain id.

contractstring required

Escrow contract address.

receiverstring required

Receiver address for captures.

preapproval_expires_atstring date-time required

Pre-approval expiration (RFC 3339).

authorization_expires_atstring date-time required

Authorization expiration (RFC 3339).

refund_expires_atstring date-time required

Refund expiration (RFC 3339).

noncestring required

Unique nonce for payment info hash computation.

Response

Payment instrument registered.

idstring required

Unique instrument identifier.

handler_idstring required

Handler instance identifier.

type'evm_auth_capture_escrow' required

Instrument category (e.g., 'card', 'tokenized_card').

displayobject

Display information for the instrument. Each payment instrument schema defines its specific display properties, as outlined by the payment handler.

payment_info_hashstring required

Hash identifying the on-chain payment authorization.

operatorstring required

Operator address.

payerstring required

Payer address.

chain_idinteger required

EVM chain id.

contractstring required

Escrow contract address.

receiverstring required

Receiver address for captures.

preapproval_expires_atstring date-time required

Pre-approval expiration (RFC 3339).

authorization_expires_atstring date-time required

Authorization expiration (RFC 3339).

refund_expires_atstring date-time required

Refund expiration (RFC 3339).

noncestring required

Unique nonce for payment info hash computation.