List historical card settlement reconciliations
/cards/settlements/reconciliationsQuery parameters
limitintegerOptionalPage size
Default 10. Maximum 100.
starting_afterstringOptionalThe id of the last item seen; returns the page after it
ending_beforestringOptionalThe id of the first item seen; returns the page before it
Returns
200 OK
dataarray of objectsRequired10 child attributes
applicationobject or nullOptional3 child attributes
actorstringRequiredcontent_sha256stringRequiredcreated_atstring · date-timeRequiredcasharray of objectsRequired4 child attributes
business_datestring · dateRequiredA business date, YYYY-MM-DD
journalobject or nullOptional18 child attributes
adjusts_periodstringOptionalA sealed period this journal corrects, YYYY-MM
approved_bystringOptionalbackdatedbooleanOptionalEffective_date is before posting_date (read only)
committed_atstring · date-timeOptionaleffective_datestring · dateRequiredA business date, YYYY-MM-DD
entriesarray of objectsRequiredfx_legsarray of objectsOptionalFXLegs 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.
idstringOptionalkindstringRequiredposted_bystringOptionalposting_datestring · dateOptionalA business date, YYYY-MM-DD
protected_command_idstringOptionalreasonstringOptionalRequired on a backdated journal
release_hold_idstringOptionalExample hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm
require_availablebooleanOptionalreversal_ofstringOptionalsource_refstringRequiredsource_servicestringRequiredkeystringRequiredlegacy_rowobject or nullOptional3 child attributes
amountintegerRequiredcountintegerRequiredjournal_idstringRequiredExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
conflictsarray of stringsRequiredcontent_sha256stringRequiredcreated_atstring · date-timeRequiredidstringRequiredproposed_bystringRequiredrequestobjectRequired7 child attributes
cash_groupsarray of objectsRequired3 child attributes
authorization_idsarray of stringsRequiredbusiness_datestring · dateRequiredA business date, YYYY-MM-DD
journal_idstringRequiredExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
evidence_refstringRequiredevidence_sha256stringRequirednetworkstringRequiredreasonstringRequiredsourcesarray of objectsRequired2 child attributes
authorization_idstringRequiredExample auth_2tVh8nqLxq4GbDe0K1F6S9zRcWm
clearing_journal_idstringRequiredExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
unsettled_authorization_idsarray of stringsRequiredreviewobject or nullOptional5 child attributes
actorstringRequiredcontent_sha256stringRequiredcreated_atstring · date-timeRequireddecisionstringRequiredreasonstringRequiredsourcesarray of objectsRequired5 child attributes
authorizationobjectRequiredAuthorization is the decision and its lifecycle.
29 child attributes
amountintegerRequiredauthorized_positivebooleanRequiredbusiness_datestring · dateRequiredA business date, YYYY-MM-DD
card_idstringRequiredExample card_2tVh8nqLxq4GbDe0K1F6S9zRcWm
channelstringRequiredcleared_amountintegerRequiredcountrystringRequiredcreated_atstring · date-timeRequiredcurrency_codestringRequireddecisionstringRequireddraw_idstringOptionalA credit card clearing's draw on the facility
expires_atstring · date-time or nullOptionalAn authorised purchase not cleared by then expires
hold_idstringOptionalExample hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm
idstringRequiredjournal_idstringOptionalExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
kindstringOptionalPurchase, refund, force_post
mccstringRequiredmerchant_idstringOptionalmerchant_locationstringOptionalmerchant_namestringRequirednetworkstringOptionalnetwork_refstringRequiredoriginal_network_refstringOptionalA refund: the purchase it credits
overdraft_decision_idstringOptionalreasonstringRequiredrequested_amountintegerOptionalPartial approval: what the merchant asked for
response_codestringRequiredstatusstringRequiredupdated_atstring · date-timeRequiredfacility_idstringOptionaljournalobjectRequired18 child attributes
adjusts_periodstringOptionalA sealed period this journal corrects, YYYY-MM
approved_bystringOptionalbackdatedbooleanOptionalEffective_date is before posting_date (read only)
committed_atstring · date-timeOptionaleffective_datestring · dateRequiredA business date, YYYY-MM-DD
entriesarray of objectsRequiredfx_legsarray of objectsOptionalFXLegs 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.
idstringOptionalkindstringRequiredposted_bystringOptionalposting_datestring · dateOptionalA business date, YYYY-MM-DD
protected_command_idstringOptionalreasonstringOptionalRequired on a backdated journal
release_hold_idstringOptionalExample hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm
require_availablebooleanOptionalreversal_ofstringOptionalsource_refstringRequiredsource_servicestringRequiredkindstringRequiredledger_account_idstringRequiredExample lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm
has_morebooleanRequiredWhether another page follows
Errors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503