Sign in
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.

Changes

Changed in 1 of the 2 revisions of this API.1037

  • 7db6ad75e16d1037See the full diff
    • ▲

      added the new required request property /////

      new-required-request-property

    • ▲

      added the new required request property /////

      new-required-request-property

    • ▲

      added the new required request property /////

      new-required-request-property

    • ▲

      added the new required request property /////

      new-required-request-property

    • ▲

      added subschema #3 to the request body allOf list

      request-body-all-of-added

    • ▲

      the //// request property type changed from no type to object

      request-property-type-changed

    • ▲

      the //// request property type changed from no type to object

      request-property-type-changed

    • ▲

      the //// response's property type changed from no type to object for status

      response-property-type-changed

    • ▲

      the //// response's property type changed from no type to object for status

      response-property-type-changed

    • ▲

      removed the required property //// from the response with the status

      response-required-property-removed

    • ●

      removed subschema #2 from the //// request property allOf list

      request-property-all-of-removed

    • ●

      removed subschema #2 from the //// request property allOf list

      request-property-all-of-removed

    • ●

      removed the request property ////

      request-property-removed

    • ○

      added subschema #3 to the response body allOf list for the response status

      response-body-all-of-added

    • ○

      removed subschema #2 from the //// response property allOf list for the response status

      response-property-all-of-removed

    • ○

      removed subschema #2 from the //// response property allOf list for the response status

      response-property-all-of-removed

    • ○

      added the required property ///// to the response with the status

      response-required-property-added

    • ○

      added the required property ///// to the response with the status

      response-required-property-added

    • ○

      added the required property ///// to the response with the status

      response-required-property-added

    • ○

      added the required property ///// to the response with the status

      response-required-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog