Corgi BankDocumentation
OpenAPI

Simulate the requester cancelling a request the bank's customer received (camt.055)

POST/simulate/transfers/realtime/request-cancellation

Headers

Idempotency-KeystringOptional

Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.

Body parameters

reason_codestringRequired
request_idstringRequired

Example req_2tVh8nqLxq4GbDe0K1F6S9zRcWm

Returns

200 OK

account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

amountintegerRequired
cancellation_reason_codestringRequired
cancellation_statusstringRequired

Requested, cancelled, refused, failed

counterpartyobjectRequired
4 child attributes
account_numberstringRequired
account_typestringRequired
namestringRequired
routing_numberstringRequired
created_atstring · date-timeRequired
directionstringRequired
document_numberstringRequired
expires_atstring · date-time or nullOptional
idstringRequired
msg_idstringRequired
payment_idstringRequired

Example lpay_2tVh8nqLxq4GbDe0K1F6S9zRcWm

railstringRequired
reasonstringRequired
reason_codestringRequired
remittancestringRequired
requested_execution_datestring · dateRequired

A business date, YYYY-MM-DD

statusstringRequired

Sent, acknowledged, received, presented, accepted, paid, rejected, expired, cancelled, failed

uetrstringRequired
updated_atstring · date-timeRequired

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503

to move to open esc to close