PApalette-labs-inc
payments

Register payment instrument

Changed on

Register a payment instrument for use in order creation.

post/payment-instruments

Request

Request body

idstring required

A unique identifier for this instrument instance, assigned by the platform.

handler_idstring required

The unique identifier for the handler instance that produced this instrument. This corresponds to the 'id' field in the Payment Handler definition.

type'evm_auth_capture_escrow' required

The broad category of the instrument (e.g., 'card', 'tokenized_card'). Specific schemas will constrain this to a constant value.

displayobject

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

payment_info_hashstring required

Hash that identifies the on-chain payment authorization.

operatorstring required

Operator address used to compute the payment info hash.

payerstring required

Payer address used to compute the payment info hash.

receiverstring required

Receiver address used for captures.

preapproval_expires_atstring date-time required

Pre-approval expiration timestamp (RFC 3339).

authorization_expires_atstring date-time required

Authorization expiration timestamp (RFC 3339).

refund_expires_atstring date-time required

Refund expiration timestamp (RFC 3339).

noncestring required

Unique nonce used to compute the payment info hash.

chain_idinteger required

EVM chain id for the escrow contract.

contractstring required

Escrow contract address on the target chain.

Response

Payment instrument registered.

idstring required

A unique identifier for this instrument instance, assigned by the platform.

handler_idstring required

The unique identifier for the handler instance that produced this instrument. This corresponds to the 'id' field in the Payment Handler definition.

type'evm_auth_capture_escrow' required

The broad category of the instrument (e.g., 'card', 'tokenized_card'). Specific schemas will constrain this to a constant value.

displayobject

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

payment_info_hashstring required

Hash that identifies the on-chain payment authorization.

operatorstring required

Operator address used to compute the payment info hash.

payerstring required

Payer address used to compute the payment info hash.

receiverstring required

Receiver address used for captures.

preapproval_expires_atstring date-time required

Pre-approval expiration timestamp (RFC 3339).

authorization_expires_atstring date-time required

Authorization expiration timestamp (RFC 3339).

refund_expires_atstring date-time required

Refund expiration timestamp (RFC 3339).

noncestring required

Unique nonce used to compute the payment info hash.

chain_idinteger required

EVM chain id for the escrow contract.

contractstring required

Escrow contract address on the target chain.

Changes

  • c2c61c76b0d0Revision changes
    • breaking

      request property / was restricted to a list of enum values

    • breaking

      the request property type changed from no type to object

    • breaking

      the response property const value evm_auth_capture_escrow was removed for the status

    • breaking

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

    • warning

      added the new evm_auth_capture_escrow enum value to the / response property for the response status

    • info

      request body became optional

    • info

      the request property const value evm_auth_capture_escrow was removed

    • info

      added the new evm_auth_capture_escrow enum value to the request property /

  • 7db6ad75e16dRevision changes
    • breaking

      added the new required request property /////

    • breaking

      added the new required request property /////

    • breaking

      added the new required request property /////

    • breaking

      added the new required request property /////

    • breaking

      added subschema #3 to the request body allOf list

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • warning

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

    • warning

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

    • warning

      removed the request property ////

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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