Corgi BankDocumentation
OpenAPI

Cover or return an item

POST/accounts/{id}/overdraft-decisions

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

amountintegerRequired
authorized_positivebooleanOptional
company_idstringOptional

ACH: the originator's company identification; checks: the constant "check"

descriptionstringOptional
individual_idstringOptional

ACH: the entry's individual identification; checks: the serial

item_kindstringRequired

Ach_debit, check, card, atm, book_transfer, scheduled_transfer, deposit_return

referencestringRequired
representedbooleanOptional

Ignored by the service: re-presentment is established from company_id, individual_id and amount

Returns

200 OK

account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

amountintegerRequired
business_datestring · dateRequired

A business date, YYYY-MM-DD

company_idstringOptional
consent_idstringOptional
covered_amountintegerRequired
created_atstring · date-timeRequired
customer_idstringOptional

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

decisionstringRequired

Not_needed, line_advance, sweep, paid_into_overdraft or returned

deferred_fee_amountintegerRequired
descriptionstringOptional
fee_amountintegerRequired
fee_journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

idstringRequired
individual_idstringOptional
item_kindstringRequired

Ach_debit, check, card, book_transfer, other

reasonstringOptional
referencestringRequired
representedbooleanRequired

The same item was presented within the last 30 days: no second fee

shortfall_amountintegerRequired
source_idstringOptional

The draw, sweep journal or advance that covered it

Errors

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

400401403404409412413422424429500503

to move to open esc to close