Accepts only the cancel `rescind-transaction` built for this escrow, with the sender's signature added. On confirmation the transaction is `rescinded`, as `/rescind` leaves one, with the cancel's signature in `metadata.rescindTransactionHash`. If a submit fails after the cancel landed, submitting the same signed cancel again records it.
Responses
200
paymentRailobject
Which network moves the money. Not the same as `rail` (the gas-payment path of an on-chain escrow).
PaymentRail
enum"stablecoin" · "tokenized_deposit" · "fed_now" · "rtp" · "wire" · "ach"Which network moves the money. Not the same as `rail` (the gas-payment path of an on-chain escrow).
phaseenum"PRE_ESCROW" · "POST_ESCROW" · "PRE_RELEASE" · "POST_RELEASE"Lifecycle phase: Verify (PRE_ESCROW), Fund (POST_ESCROW), Confirm (PRE_RELEASE), Settle (POST_RELEASE).
holdReasonobject
Why the transaction is held; null when it is not.
HoldReason
enum"insufficient_customer_funds" · "watchlist_match" · "screening_unavailable" · "dependency_unavailable" · "beneficiary_account_verification_failed" · "master_account_shortfall" · "rtp_position_shortfall" · "reconciliation_mismatch" · "deposit_to_frozen_address" · "deposit_to_unrecoverable_address" · "no_receive_template"Why the transaction is held; null when it is not.
nextActionobject
What clears the hold.
NextAction
enum"ops_review" · "request_liquidity" · "await_funds" · "await_settlement"What clears the hold.
endToEndIdobject
ISO 20022 EndToEndId.
objectISO 20022 EndToEndId.
stablecoinobject
Present on single-transaction reads when paymentRail is stablecoin.
TransactionStablecoin
idstringrequired
transactionIdstringrequired
createdAtstring (date-time)required
updatedAtstring (date-time)required
networkstringrequired
fromAddressstringrequired
toAddressstringrequired
escrowAddressobject
escrowIdobject
transactionHashobject
releaseTxHashobject
burnUsdAmountobject
circleTransferIdobject
gasRailobject
Rail
enum"rail-a" · "rail-b" · "rail-c"
tokenizedDepositobject
Present on single-transaction reads when paymentRail is tokenized_deposit.
TransactionTokenizedDeposit
idstringrequired
transactionIdstringrequired
createdAtstring (date-time)required
updatedAtstring (date-time)required
networkstringrequired
tokenAddressobject
issuerInstitutionobject
fromAddressstringrequired
toAddressstringrequired
transactionHashobject
fedNowobject
Present on single-transaction reads when paymentRail is fed_now.
TransactionFedNow
idstringrequired
transactionIdstringrequired
createdAtstring (date-time)required
updatedAtstring (date-time)required
originatorAccountNumberobject
originatorRoutingNumberobject
beneficiaryNameobject
beneficiaryAccountNumberobject
beneficiaryRoutingNumberobject
glAccountIdobject
glTransferReferenceobject
liquidityAvailableobject
liquidityBufferobject
liquidityShortfallobject
liquidityRequestReferenceobject
messageIdobject
acknowledgementStatusenum"pending" · "acknowledged" · "rejected" · "settled"
settlementTimestampobject
masterAccountRefobject
rtpobject
Present on single-transaction reads when paymentRail is rtp.
TransactionRtp
idstringrequired
transactionIdstringrequired
createdAtstring (date-time)required
updatedAtstring (date-time)required
originatorAccountNumberobject
originatorRoutingNumberobject
beneficiaryNameobject
beneficiaryAccountNumberobject
beneficiaryRoutingNumberobject
glAccountIdobject
glTransferReferenceobject
liquidityAvailableobject
liquidityBufferobject
liquidityShortfallobject
liquidityRequestReferenceobject
messageIdobject
acknowledgementStatusenum"pending" · "acknowledged" · "rejected" · "settled"
settlementTimestampobject
positionAccountRefobject
releaseTxHashobject
burnUsdAmountobject
circleTransferIdobject
rescindobject
Public-safe summary of the TimeDelay rescind config. Lets clients gate the Cancel/Rescind affordance without a second round-trip. Null when the transaction has no TimeDelay control (RAW orchestration, templates without a hold period). Absent from response on the list endpoint and on legacy api revisions.
TransactionRescindInfo
allowedbooleanrequiredWhether the sender is allowed to rescind/cancel the transaction during the hold window. Defaults to true when not explicitly set on the underlying control config.
deadlineobjectrequired
ISO 8601 timestamp after which rescind is no longer allowed. Null when the rescind window matches the full hold period.
objectISO 8601 timestamp after which rescind is no longer allowed. Null when the rescind window matches the full hold period.
requiresReasonbooleanrequiredWhether the rescind endpoint requires a non-empty `reason` field in the request body.
notifyRecipientbooleanrequiredWhether the recipient is notified (e.g. via SMS) when a rescind succeeds.
{
"paymentRail": {},
"phase": "PRE_ESCROW",
"holdReason": {},
"nextAction": {},
"endToEndId": {},
"stablecoin": {
"id": "string",
"transactionId": "string",
"createdAt": "2026-01-15T12:00:00.000Z",
"updatedAt": "2026-01-15T12:00:00.000Z",
"network": "string",
"fromAddress": "string",
"toAddress": "string",
"escrowAddress": {},
"escrowId": {},
"transactionHash": {},
"releaseTxHash": {},
"burnUsdAmount": {},
"circleTransferId": {},
"gasRail": {}
},
"tokenizedDeposit": {
"id": "string",
"transactionId": "string",
"createdAt": "2026-01-15T12:00:00.000Z",
"updatedAt": "2026-01-15T12:00:00.000Z",
"network": "string",
"tokenAddress": {},
"issuerInstitution": {},
"fromAddress": "string",
"toAddress": "string",
"transactionHash": {}
},
"fedNow": {
"id": "string",
"transactionId": "string",
"createdAt": "2026-01-15T12:00:00.000Z",
"updatedAt": "2026-01-15T12:00:00.000Z",
"originatorAccountNumber": {},
"originatorRoutingNumber": {},
"beneficiaryName": {},
"beneficiaryAccountNumber": {},
"beneficiaryRoutingNumber": {},
"glAccountId": {},
"glTransferReference": {},
"liquidityAvailable": {},
"liquidityBuffer": {},
"liquidityShortfall": {},
"liquidityRequestReference": {},
"messageId": {},
"acknowledgementStatus": "pending",
"settlementTimestamp": {},
"masterAccountRef": {}
},
"rtp": {
"id": "string",
"transactionId": "string",
"createdAt": "2026-01-15T12:00:00.000Z",
"updatedAt": "2026-01-15T12:00:00.000Z",
"originatorAccountNumber": {},
"originatorRoutingNumber": {},
"beneficiaryName": {},
"beneficiaryAccountNumber": {},
"beneficiaryRoutingNumber": {},
"glAccountId": {},
"glTransferReference": {},
"liquidityAvailable": {},
"liquidityBuffer": {},
"liquidityShortfall": {},
"liquidityRequestReference": {},
"messageId": {},
"acknowledgementStatus": "pending",
"settlementTimestamp": {},
"positionAccountRef": {}
},
"releaseTxHash": {},
"burnUsdAmount": {},
"circleTransferId": {},
"rescind": {
"allowed": true,
"deadline": "2026-06-15T12:00:00.000Z",
"requiresReason": false,
"notifyRecipient": true
}
}
400`INVALID_SIGNED_TRANSACTION` (build a new one), or the rescind is not allowed (see `rescind-transaction`)
successbooleanrequiredAlways `false` on an error response.
dataenumrequired
Always `null` on an error response. Present so success and error bodies share a shape.
enumnullAlways `null` on an error response. Present so success and error bodies share a shape.
metaErrorResponseMetaDtorequired
timestampstringrequiredISO 8601 timestamp of the response.
requestIdstringrequiredRequest id for this response. Echoes the `X-Request-ID` or `X-Correlation-ID` you sent, whatever its format; when you send neither, the server generates a UUID v4. Quote it when reporting a problem — it is how the request is found in our logs.
pathstringrequiredRequest path that produced the error.
methodstringrequiredHTTP method of the request that produced the error.
errorApiErrorDtorequired
codestringrequiredMachine-readable error code. Branch on this rather than on `message`, which is free text and may change.
Deliberately an open string, NOT a closed enum. Two families of code reach this field:
- the status-derived codes in `ErrorCode` (VALIDATION_ERROR, NOT_FOUND, RATE_LIMIT_EXCEEDED, and so on), which `AllExceptionsFilter` assigns from the HTTP status;
- domain-specific codes a service sets on the exception it throws, such as `ESCROW_ALREADY_CREATED`, `PRE_ESCROW_PENDING` or `RELEASE_WINDOW_NOT_ELAPSED`.
The second family is the larger one, so publishing `ErrorCode` as an enum would make a strict client reject most real error responses. Treat an unrecognised code as its HTTP status.
messagestringrequiredHuman-readable description of what went wrong.
statusCodenumberrequiredHTTP status code, repeated here so the body is self-contained.
detailsone of
Structured context for the error, such as per-field validation messages. Shape varies by `code`; treat it as opaque unless you recognise the code.
object
array of object
string
suggestionstringActionable guidance for fixing the request, intended to be shown to a person. Advice, not data.
{
"success": false,
"data": null,
"meta": {
"timestamp": "2026-11-06T12:34:56.789Z",
"requestId": "550e8400-e29b-41d4-a716-446655440000",
"path": "/api/v1/transactions",
"method": "POST"
},
"error": {
"code": "VALIDATION_ERROR",
"message": "Request validation failed",
"statusCode": 400,
"details": {
"amount": "must be a positive number"
},
"suggestion": "Use one of: base, ethereum"
}
}
403The wallet is not the sender, or the token lacks `reverse:transactions`
successbooleanrequiredAlways `false` on an error response.
dataenumrequired
Always `null` on an error response. Present so success and error bodies share a shape.
enumnullAlways `null` on an error response. Present so success and error bodies share a shape.
metaErrorResponseMetaDtorequired
timestampstringrequiredISO 8601 timestamp of the response.
requestIdstringrequiredRequest id for this response. Echoes the `X-Request-ID` or `X-Correlation-ID` you sent, whatever its format; when you send neither, the server generates a UUID v4. Quote it when reporting a problem — it is how the request is found in our logs.
pathstringrequiredRequest path that produced the error.
methodstringrequiredHTTP method of the request that produced the error.
errorApiErrorDtorequired
codestringrequiredMachine-readable error code. Branch on this rather than on `message`, which is free text and may change.
Deliberately an open string, NOT a closed enum. Two families of code reach this field:
- the status-derived codes in `ErrorCode` (VALIDATION_ERROR, NOT_FOUND, RATE_LIMIT_EXCEEDED, and so on), which `AllExceptionsFilter` assigns from the HTTP status;
- domain-specific codes a service sets on the exception it throws, such as `ESCROW_ALREADY_CREATED`, `PRE_ESCROW_PENDING` or `RELEASE_WINDOW_NOT_ELAPSED`.
The second family is the larger one, so publishing `ErrorCode` as an enum would make a strict client reject most real error responses. Treat an unrecognised code as its HTTP status.
messagestringrequiredHuman-readable description of what went wrong.
statusCodenumberrequiredHTTP status code, repeated here so the body is self-contained.
detailsone of
Structured context for the error, such as per-field validation messages. Shape varies by `code`; treat it as opaque unless you recognise the code.
object
array of object
string
suggestionstringActionable guidance for fixing the request, intended to be shown to a person. Advice, not data.
{
"success": false,
"data": null,
"meta": {
"timestamp": "2026-11-06T12:34:56.789Z",
"requestId": "550e8400-e29b-41d4-a716-446655440000",
"path": "/api/v1/transactions",
"method": "POST"
},
"error": {
"code": "VALIDATION_ERROR",
"message": "Request validation failed",
"statusCode": 400,
"details": {
"amount": "must be a positive number"
},
"suggestion": "Use one of: base, ethereum"
}
}
404Transaction not found
successbooleanrequiredAlways `false` on an error response.
dataenumrequired
Always `null` on an error response. Present so success and error bodies share a shape.
enumnullAlways `null` on an error response. Present so success and error bodies share a shape.
metaErrorResponseMetaDtorequired
timestampstringrequiredISO 8601 timestamp of the response.
requestIdstringrequiredRequest id for this response. Echoes the `X-Request-ID` or `X-Correlation-ID` you sent, whatever its format; when you send neither, the server generates a UUID v4. Quote it when reporting a problem — it is how the request is found in our logs.
pathstringrequiredRequest path that produced the error.
methodstringrequiredHTTP method of the request that produced the error.
errorApiErrorDtorequired
codestringrequiredMachine-readable error code. Branch on this rather than on `message`, which is free text and may change.
Deliberately an open string, NOT a closed enum. Two families of code reach this field:
- the status-derived codes in `ErrorCode` (VALIDATION_ERROR, NOT_FOUND, RATE_LIMIT_EXCEEDED, and so on), which `AllExceptionsFilter` assigns from the HTTP status;
- domain-specific codes a service sets on the exception it throws, such as `ESCROW_ALREADY_CREATED`, `PRE_ESCROW_PENDING` or `RELEASE_WINDOW_NOT_ELAPSED`.
The second family is the larger one, so publishing `ErrorCode` as an enum would make a strict client reject most real error responses. Treat an unrecognised code as its HTTP status.
messagestringrequiredHuman-readable description of what went wrong.
statusCodenumberrequiredHTTP status code, repeated here so the body is self-contained.
detailsone of
Structured context for the error, such as per-field validation messages. Shape varies by `code`; treat it as opaque unless you recognise the code.
object
array of object
string
suggestionstringActionable guidance for fixing the request, intended to be shown to a person. Advice, not data.
{
"success": false,
"data": null,
"meta": {
"timestamp": "2026-11-06T12:34:56.789Z",
"requestId": "550e8400-e29b-41d4-a716-446655440000",
"path": "/api/v1/transactions",
"method": "POST"
},
"error": {
"code": "VALIDATION_ERROR",
"message": "Request validation failed",
"statusCode": 400,
"details": {
"amount": "must be a positive number"
},
"suggestion": "Use one of: base, ethereum"
}
}
409`BLOCKHASH_EXPIRED` (build a new one), `CANCEL_WINDOW_CLOSED`, `ESCROW_NOT_FOUND`, or `RESCIND_SUBMISSION_IN_PROGRESS`
successbooleanrequiredAlways `false` on an error response.
dataenumrequired
Always `null` on an error response. Present so success and error bodies share a shape.
enumnullAlways `null` on an error response. Present so success and error bodies share a shape.
metaErrorResponseMetaDtorequired
timestampstringrequiredISO 8601 timestamp of the response.
requestIdstringrequiredRequest id for this response. Echoes the `X-Request-ID` or `X-Correlation-ID` you sent, whatever its format; when you send neither, the server generates a UUID v4. Quote it when reporting a problem — it is how the request is found in our logs.
pathstringrequiredRequest path that produced the error.
methodstringrequiredHTTP method of the request that produced the error.
errorApiErrorDtorequired
codestringrequiredMachine-readable error code. Branch on this rather than on `message`, which is free text and may change.
Deliberately an open string, NOT a closed enum. Two families of code reach this field:
- the status-derived codes in `ErrorCode` (VALIDATION_ERROR, NOT_FOUND, RATE_LIMIT_EXCEEDED, and so on), which `AllExceptionsFilter` assigns from the HTTP status;
- domain-specific codes a service sets on the exception it throws, such as `ESCROW_ALREADY_CREATED`, `PRE_ESCROW_PENDING` or `RELEASE_WINDOW_NOT_ELAPSED`.
The second family is the larger one, so publishing `ErrorCode` as an enum would make a strict client reject most real error responses. Treat an unrecognised code as its HTTP status.
messagestringrequiredHuman-readable description of what went wrong.
statusCodenumberrequiredHTTP status code, repeated here so the body is self-contained.
detailsone of
Structured context for the error, such as per-field validation messages. Shape varies by `code`; treat it as opaque unless you recognise the code.
object
array of object
string
suggestionstringActionable guidance for fixing the request, intended to be shown to a person. Advice, not data.
{
"success": false,
"data": null,
"meta": {
"timestamp": "2026-11-06T12:34:56.789Z",
"requestId": "550e8400-e29b-41d4-a716-446655440000",
"path": "/api/v1/transactions",
"method": "POST"
},
"error": {
"code": "VALIDATION_ERROR",
"message": "Request validation failed",
"statusCode": 400,
"details": {
"amount": "must be a positive number"
},
"suggestion": "Use one of: base, ethereum"
}
}
422`TRANSACTION_FAILED` (Solana rejected it) or `SENDER_TOKEN_ACCOUNT_MISSING`
successbooleanrequiredAlways `false` on an error response.
dataenumrequired
Always `null` on an error response. Present so success and error bodies share a shape.
enumnullAlways `null` on an error response. Present so success and error bodies share a shape.
metaErrorResponseMetaDtorequired
timestampstringrequiredISO 8601 timestamp of the response.
requestIdstringrequiredRequest id for this response. Echoes the `X-Request-ID` or `X-Correlation-ID` you sent, whatever its format; when you send neither, the server generates a UUID v4. Quote it when reporting a problem — it is how the request is found in our logs.
pathstringrequiredRequest path that produced the error.
methodstringrequiredHTTP method of the request that produced the error.
errorApiErrorDtorequired
codestringrequiredMachine-readable error code. Branch on this rather than on `message`, which is free text and may change.
Deliberately an open string, NOT a closed enum. Two families of code reach this field:
- the status-derived codes in `ErrorCode` (VALIDATION_ERROR, NOT_FOUND, RATE_LIMIT_EXCEEDED, and so on), which `AllExceptionsFilter` assigns from the HTTP status;
- domain-specific codes a service sets on the exception it throws, such as `ESCROW_ALREADY_CREATED`, `PRE_ESCROW_PENDING` or `RELEASE_WINDOW_NOT_ELAPSED`.
The second family is the larger one, so publishing `ErrorCode` as an enum would make a strict client reject most real error responses. Treat an unrecognised code as its HTTP status.
messagestringrequiredHuman-readable description of what went wrong.
statusCodenumberrequiredHTTP status code, repeated here so the body is self-contained.
detailsone of
Structured context for the error, such as per-field validation messages. Shape varies by `code`; treat it as opaque unless you recognise the code.
object
array of object
string
suggestionstringActionable guidance for fixing the request, intended to be shown to a person. Advice, not data.
{
"success": false,
"data": null,
"meta": {
"timestamp": "2026-11-06T12:34:56.789Z",
"requestId": "550e8400-e29b-41d4-a716-446655440000",
"path": "/api/v1/transactions",
"method": "POST"
},
"error": {
"code": "VALIDATION_ERROR",
"message": "Request validation failed",
"statusCode": 400,
"details": {
"amount": "must be a positive number"
},
"suggestion": "Use one of: base, ethereum"
}
}