Sign in
banking.v1.PaymentsService

CancelPayment

Withdraw an order the CALLER opened, while it is still pending. Anyone else is refused.

post/banking.v1.PaymentsService/CancelPayment

Request

  • The document declares no server URL.
  • Auth: none required

Headers

Connect-Protocol-Version1 required

Define the version of the Connect protocol

Connect-Timeout-Msnumber

Define the timeout, in ms

Request body

payment_idstring

Response

Success

idstring
state'PAYMENT_STATE_UNSPECIFIED' | 'PAYMENT_STATE_PENDING' | 'PAYMENT_STATE_APPROVED' | 'PAYMENT_STATE_EXECUTED' | 'PAYMENT_STATE_EXECUTION_FAILED' | 'PAYMENT_STATE_REJECTED' | 'PAYMENT_STATE_EXPIRED' | 'PAYMENT_STATE_CANCELLED'

Where an order stands. Terminal everywhere except PENDING and APPROVED.

tierstring

internal | service | external — DERIVED from the destination, never supplied.

amountstring

Decimal USDT string, as everywhere else on this wire.

reasonstring

Why, in the initiator's words. Required, shown verbatim, never interpreted.

requirementstring

owner_consilium | subject_consent — the one requirement, read off the source.

payload_hashstring

Hex SHA-256 over the canonical terms, re-verified at execution.

initiator_emailstring
consilium_idstring

Set exactly when the requirement is the owner consilium.

executed_withdrawal_idstring

Set on EXECUTED for an external order only: an internal one settled as a ledger transfer and records no id of its own.

failure_reasonstring

Changes

No operation changes recorded.