Corgi BankDocumentation
OpenAPI

Read retained network finance sources and posting evidence

GET/cards/settlements/network-finance/{id}

Verified staff cards authority; fresh step-up for writes and independent operations:approve review. Immutable USD processor statement lines bind actual clearing receipts, unique network references and capped reversals. Interchange posts 1310/4120; scheme fees post 5500/2310. Separately reviewed external cash evidence reconciles signed actual cash and optional completed principal settlement; only the adjustment delta moves master cash. Exact journal recovery survives lost acknowledgment. External network transport, invoice authenticity verification and settlement account statement sourcing remain integration responsibilities.

Path parameters

idstringRequired

Returns

200 OK

content_sha256stringRequired
created_atstring · date-timeRequired
idstringRequired
interchange_minorintegerRequired
kindstringRequired
networkstringRequired
postingobject or nullOptional
7 child attributes
actorstringRequired
committed_journalobject or nullOptional
18 child attributes
adjusts_periodstringOptional

A sealed period this journal corrects, YYYY-MM

approved_bystringOptional
backdatedbooleanOptional

Effective_date is before posting_date (read only)

committed_atstring · date-timeOptional
effective_datestring · dateRequired

A business date, YYYY-MM-DD

entriesarray of objectsRequired
4 child attributes
amountintegerRequired

Minor units of the currency (cents for USD)

currency_codestringRequired

ISO 4217 code

directionstringRequired
ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

fx_legsarray of objectsOptional

FXLegs is read only: the legs of a cross-currency journal the ledger's own conversion and close commands posted. A caller's posting never carries them.

7 child attributes
currency_codestringRequired
equivalent_ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

native_amountintegerRequired
position_ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

rate_sheet_idstringRequired
usd_equivalent_amountintegerRequired
usd_per_foreign_majorstringRequired
idstringOptional
kindstringRequired
posted_bystringOptional
posting_datestring · dateOptional

A business date, YYYY-MM-DD

protected_command_idstringOptional
reasonstringOptional

Required on a backdated journal

release_hold_idstringOptional

Example hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm

require_availablebooleanOptional
reversal_ofstringOptional
source_refstringRequired
source_servicestringRequired
completedbooleanRequired
created_atstring · date-timeRequired
journalobjectRequired
18 child attributes
adjusts_periodstringOptional

A sealed period this journal corrects, YYYY-MM

approved_bystringOptional
backdatedbooleanOptional

Effective_date is before posting_date (read only)

committed_atstring · date-timeOptional
effective_datestring · dateRequired

A business date, YYYY-MM-DD

entriesarray of objectsRequired
4 child attributes
amountintegerRequired

Minor units of the currency (cents for USD)

currency_codestringRequired

ISO 4217 code

directionstringRequired
ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

fx_legsarray of objectsOptional

FXLegs is read only: the legs of a cross-currency journal the ledger's own conversion and close commands posted. A caller's posting never carries them.

7 child attributes
currency_codestringRequired
equivalent_ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

native_amountintegerRequired
position_ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

rate_sheet_idstringRequired
usd_equivalent_amountintegerRequired
usd_per_foreign_majorstringRequired
idstringOptional
kindstringRequired
posted_bystringOptional
posting_datestring · dateOptional

A business date, YYYY-MM-DD

protected_command_idstringOptional
reasonstringOptional

Required on a backdated journal

release_hold_idstringOptional

Example hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm

require_availablebooleanOptional
reversal_ofstringOptional
source_refstringRequired
source_servicestringRequired
journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

journal_keystringRequired
principal_settlement_minorintegerRequired
proposed_bystringRequired
requestobjectRequired
2 child attributes
cashobject or nullOptional
6 child attributes
evidenceobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
external_cash_minorinteger or nullOptional

Signed cash movement: receipt positive, payment negative. Includes any linked principal settlement which has already been posted by cards.

external_referencestringRequired
settlement_batch_keystringOptional
statement_idstringRequired
value_datestring · dateRequired

A business date, YYYY-MM-DD

statementobject or nullOptional
5 child attributes
evidenceobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
external_referencestringRequired
linesarray of objectsRequired
5 child attributes
amount_minorintegerRequired
authorization_idstringRequired

Example auth_2tVh8nqLxq4GbDe0K1F6S9zRcWm

kindstringRequired

Interchange or scheme_fee; reversal requires ReversesReference.

referencestringRequired
reverses_referencestringOptional
networkstringRequired
statement_datestring · dateRequired

A business date, YYYY-MM-DD

reviewobject or nullOptional
5 child attributes
actorstringRequired
content_sha256stringRequired
created_atstring · date-timeRequired
decisionstringRequired
reasonstringRequired
scheme_fee_minorintegerRequired
sourcesarray of objectsRequired
4 child attributes
journalobjectRequired
18 child attributes
adjusts_periodstringOptional

A sealed period this journal corrects, YYYY-MM

approved_bystringOptional
backdatedbooleanOptional

Effective_date is before posting_date (read only)

committed_atstring · date-timeOptional
effective_datestring · dateRequired

A business date, YYYY-MM-DD

entriesarray of objectsRequired
4 child attributes
amountintegerRequired

Minor units of the currency (cents for USD)

currency_codestringRequired

ISO 4217 code

directionstringRequired
ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

fx_legsarray of objectsOptional

FXLegs is read only: the legs of a cross-currency journal the ledger's own conversion and close commands posted. A caller's posting never carries them.

7 child attributes
currency_codestringRequired
equivalent_ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

native_amountintegerRequired
position_ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

rate_sheet_idstringRequired
usd_equivalent_amountintegerRequired
usd_per_foreign_majorstringRequired
idstringOptional
kindstringRequired
posted_bystringOptional
posting_datestring · dateOptional

A business date, YYYY-MM-DD

protected_command_idstringOptional
reasonstringOptional

Required on a backdated journal

release_hold_idstringOptional

Example hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm

require_availablebooleanOptional
reversal_ofstringOptional
source_refstringRequired
source_servicestringRequired
journal_keystringRequired
record_sha256stringOptional
referencestringRequired

Errors

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

400401403404409412413422424429500503

to move to open esc to close