Corgi BankDocumentation
OpenAPI

Simulate the network clearing an authorization

POST/simulate/cards/clearing

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

amountintegerRequired
authorization_idstringRequired

Example auth_2tVh8nqLxq4GbDe0K1F6S9zRcWm

Returns

200 OK

amountintegerRequired
authorized_positivebooleanRequired
card_idstringRequired

Example card_2tVh8nqLxq4GbDe0K1F6S9zRcWm

cleared_amountintegerRequired
draw_idstringOptional
expires_atstringOptional
idstringRequired

Example auth_2tVh8nqLxq4GbDe0K1F6S9zRcWm

journal_idstringRequired

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

kindstringOptional

Purchase, refund, force_post

merchant_idstringOptional
networkstringOptional
original_network_refstringOptional
overdraft_decision_idstringOptional
reasonstringOptional
requested_amountintegerOptional

A partial approval: what the merchant asked for

response_codestringOptional
statusstringRequired

Errors

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

400401403404409412413422424429500503

to move to open esc to close