Read historical card settlement evidence

GET/cards/settlements/reconciliations/{id}

Path parameters

idstringRequired

Returns

200 OK

applicationobject or nullOptional

3 child attributes

actorstringRequired

content_sha256stringRequired

created_atstring · date-timeRequired

casharray of objectsRequired

4 child attributes

business_datestring · dateRequired

A business date, YYYY-MM-DD

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

keystringRequired

legacy_rowobject or nullOptional

3 child attributes

amountintegerRequired

countintegerRequired

journal_idstringRequired

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

conflictsarray of stringsRequired

content_sha256stringRequired

created_atstring · date-timeRequired

idstringRequired

proposed_bystringRequired

requestobjectRequired

7 child attributes

cash_groupsarray of objectsRequired

3 child attributes

authorization_idsarray of stringsRequired

business_datestring · dateRequired

A business date, YYYY-MM-DD

journal_idstringRequired

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

evidence_refstringRequired

evidence_sha256stringRequired

networkstringRequired

reasonstringRequired

sourcesarray of objectsRequired

2 child attributes

authorization_idstringRequired

Example auth_2tVh8nqLxq4GbDe0K1F6S9zRcWm

clearing_journal_idstringRequired

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

unsettled_authorization_idsarray of stringsRequired

reviewobject or nullOptional

5 child attributes

actorstringRequired

content_sha256stringRequired

created_atstring · date-timeRequired

decisionstringRequired

reasonstringRequired

sourcesarray of objectsRequired

5 child attributes

authorizationobjectRequired

Authorization is the decision and its lifecycle.

29 child attributes

amountintegerRequired

authorized_positivebooleanRequired

business_datestring · dateRequired

A business date, YYYY-MM-DD

card_idstringRequired

Example card_2tVh8nqLxq4GbDe0K1F6S9zRcWm

channelstringRequired

cleared_amountintegerRequired

countrystringRequired

created_atstring · date-timeRequired

currency_codestringRequired

decisionstringRequired

draw_idstringOptional

A credit card clearing's draw on the facility

expires_atstring · date-time or nullOptional

An authorised purchase not cleared by then expires

hold_idstringOptional

Example hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm

idstringRequired

journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

kindstringOptional

Purchase, refund, force_post

mccstringRequired

merchant_idstringOptional

merchant_locationstringOptional

merchant_namestringRequired

networkstringOptional

network_refstringRequired

original_network_refstringOptional

A refund: the purchase it credits

overdraft_decision_idstringOptional

reasonstringRequired

requested_amountintegerOptional

Partial approval: what the merchant asked for

response_codestringRequired

statusstringRequired

updated_atstring · date-timeRequired

facility_idstringOptional

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

kindstringRequired

ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

Errors

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

400401403404409412413422424429500503