Corgi BankDocumentation
OpenAPI

Issue the exact customer-authorized redemption instruction

POST/deposit-placements/{id}/redemption/dispatch

Only payments:placements:bridge service whose exact subject is in the retained program receives the durable redemption instruction. Dispatch state commits before returning; retry returns the same command. This API is the actual provider integration boundary, not a certification claim.

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.

Returns

200 OK

agency_titlestringRequired
annual_rate_bpsintegerRequired
capacitystringRequired
currency_codestringRequired
external_account_referencestringOptional
fdic_certificatestringRequired
idstringRequired
interest_basisstringRequired
issued_atstring · date-timeRequired
maturity_datestring · date or nullOptional

A business date, YYYY-MM-DD

operationstringRequired
owner_idstringRequired
placement_idstringRequired
principal_amountintegerRequired
productstringRequired
program_idstringRequired
program_sha256stringRequired
receiver_referencestringRequired
routing_numberstringRequired
settlement_datestring · dateRequired

A business date, YYYY-MM-DD

sha256stringRequired
standing_authorization_sha256stringOptional

Errors

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

400401403404409412413422424429500503

to move to open esc to close