Skip to main content
POST
Cancel an unfunded escrow

Authorizations

X-API-Key
string
header
required

Your Rach B2B API key. Use rach_sk_live_* for production (on-chain) or rach_sk_test_* for sandbox (no-chain simulation).

Path Parameters

id
string
required

Escrow id

Body

application/json

Reason

on_behalf_of
string

OnBehalfOf is BUYER or SELLER when the partner is acting for one of its users. It is recorded as evidence of what the partner asserted; the authority for the action remains the partner's own and is recorded separately. Omit it when the partner is acting in its own right.

Example:

"BUYER"

reason
string

Reason is required to raise a dispute and optional elsewhere. It becomes part of the escrow's permanent history.

Example:

"buyer confirmed delivery"

Response

Accepted

amount
string

Amount is in base units, unlike the create request's whole-token amount. For the implemented TRON USDT adapter, "250000000" means 250 USDT.

Example:

"250000000"

auto_release_at
string

AutoReleaseAt is when a funded escrow releases to the seller with no further action. Absent means it never does and someone must decide.

chain_id
integer
created_at
string
dispute_reason
string
disputed_at
string
escrow_address
string

EscrowAddress is where the buyer sends the money. It belongs to this deal alone and is never reused.

funded_at
string
funding_expires_at
string

FundingExpiresAt is when an unpaid escrow closes.

id
string
network
string
payout_pending
boolean

PayoutPending is true while a payout has been authorised and dispatched but not yet confirmed. Surfaced rather than hidden because during this window the honest answer to "has the seller been paid" is "not yet".

payout_tx_hash
string

PayoutTxHash is the on-chain transaction that moved the money out. It is the partner's evidence that a release or refund really happened.

rail
string
reference
string
refunded_at
string
released_at
string
resolution_note
string

Recorded admin reasoning once a disputed payout settles.

state
enum<string>
Available options:
CREATED,
FUNDED,
DISPUTED,
RELEASED,
REFUNDED,
EXPIRED,
CANCELLED
token
string
updated_at
string