Corgi BankDocumentation
OpenAPI

Ask the receiver of a payment the bank sent to return it (camt.056)

POST/transfers/realtime/{id}/return-requests

Path parameters

idstringRequired

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

operatorstringRequired
reasonstringOptional
reason_codestringRequired

Returns

200 OK

created_atstring · date-timeRequired
decided_bystringRequired
directionstringRequired
idstringRequired
msg_idstringRequired
payment_idstringRequired

Example lpay_2tVh8nqLxq4GbDe0K1F6S9zRcWm

railstringRequired
reasonstringRequired
reason_codestringRequired
requested_bystringRequired
response_msg_idstringRequired
response_reasonstringRequired
response_reason_codestringRequired
return_payment_idstringRequired

Example lpay_2tVh8nqLxq4GbDe0K1F6S9zRcWm

statusstringRequired

Requested, acknowledged, accepted, pending, rejected, returned (outbound); received, honoured, refused (inbound); failed

Errors

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

400401403404409412413422424429500503

to move to open esc to close