The account reconciliation file for a period (YYYY-MM): checks paid, returned or held, issues outstanding and voided, stop payments in force, with totals; format=csv for the customer's accounts payable
/positive-pay/accounts/{id}/reconciliation/{period}Path parameters
idstringRequiredperiodstringRequiredQuery parameters
formatstringOptionalReturns
200 OK
account_idstringRequiredExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
exceptionsarray of objectsRequired23 child attributes
account_idstringOptionalExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
amountintegerRequiredcash_letter_idstringRequiredcreated_atstring · date-timeRequireddecide_bystring · date-time or nullOptionaldecided_atstring · date-time or nullOptionaldecided_bystringOptionaldecisionstringOptionalexception_reasonstringOptionalNo_issue, amount_mismatch, payee_mismatch, duplicate_issue, void_issue, sanctions_screening or sanctions_screening_unavailable
has_imagesbooleanRequiredidstringRequiredjournal_idstringOptionalExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
microbjectRequiredMICR is a check's magnetic line.
4 child attributes
aux_on_usstringOptionalcheck_numberstringOptionalon_usstringRequiredAccount number, "/" and serial as printed
payor_routing_numberstringRequiredofficial_check_idstringOptionalpayeestringOptionalpending_actorstringOptionalpending_decisionstringOptionalpresented_onstring · dateRequiredA business date, YYYY-MM-DD
return_cash_letter_idstringOptionalreturn_reasonstringOptionalreturn_reason_textstringOptionalsequence_numberstringRequiredstatusstringRequiredPaid, returned, exception
fromstring · dateRequiredA business date, YYYY-MM-DD
generated_onstring · dateRequiredA business date, YYYY-MM-DD
outstandingarray of objectsRequired9 child attributes
account_idstringRequiredExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
amountintegerRequiredcheck_numberstringRequiredcreated_atstring · date-timeRequiredidstringRequiredinclearing_item_idstringOptionalissued_onstring · dateOptionalA business date, YYYY-MM-DD
payeestringOptionalstatusstringRequiredOutstanding, paid, voided, stale
paidarray of objectsRequired23 child attributes
account_idstringOptionalExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
amountintegerRequiredcash_letter_idstringRequiredcreated_atstring · date-timeRequireddecide_bystring · date-time or nullOptionaldecided_atstring · date-time or nullOptionaldecided_bystringOptionaldecisionstringOptionalexception_reasonstringOptionalNo_issue, amount_mismatch, payee_mismatch, duplicate_issue, void_issue, sanctions_screening or sanctions_screening_unavailable
has_imagesbooleanRequiredidstringRequiredjournal_idstringOptionalExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
microbjectRequiredMICR is a check's magnetic line.
4 child attributes
aux_on_usstringOptionalcheck_numberstringOptionalon_usstringRequiredAccount number, "/" and serial as printed
payor_routing_numberstringRequiredofficial_check_idstringOptionalpayeestringOptionalpending_actorstringOptionalpending_decisionstringOptionalpresented_onstring · dateRequiredA business date, YYYY-MM-DD
return_cash_letter_idstringOptionalreturn_reasonstringOptionalreturn_reason_textstringOptionalsequence_numberstringRequiredstatusstringRequiredPaid, returned, exception
periodstringRequiredreturnedarray of objectsRequired23 child attributes
account_idstringOptionalExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
amountintegerRequiredcash_letter_idstringRequiredcreated_atstring · date-timeRequireddecide_bystring · date-time or nullOptionaldecided_atstring · date-time or nullOptionaldecided_bystringOptionaldecisionstringOptionalexception_reasonstringOptionalNo_issue, amount_mismatch, payee_mismatch, duplicate_issue, void_issue, sanctions_screening or sanctions_screening_unavailable
has_imagesbooleanRequiredidstringRequiredjournal_idstringOptionalExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
microbjectRequiredMICR is a check's magnetic line.
4 child attributes
aux_on_usstringOptionalcheck_numberstringOptionalon_usstringRequiredAccount number, "/" and serial as printed
payor_routing_numberstringRequiredofficial_check_idstringOptionalpayeestringOptionalpending_actorstringOptionalpending_decisionstringOptionalpresented_onstring · dateRequiredA business date, YYYY-MM-DD
return_cash_letter_idstringOptionalreturn_reasonstringOptionalreturn_reason_textstringOptionalsequence_numberstringRequiredstatusstringRequiredPaid, returned, exception
stop_paymentsarray of objectsRequired19 child attributes
account_idstringRequiredExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
achobject or nullOptional7 child attributes
company_idstringOptionalcompany_namestringOptionalindividual_idstringOptionalreceived_onstring · dateRequiredA business date, YYYY-MM-DD
revokedbooleanRequiredscheduled_onstring · dateRequiredA business date, YYYY-MM-DD
timelybooleanRequiredamountintegerOptionalcheck_number_highstringRequiredcheck_number_lowstringRequiredcreated_atstring · date-timeRequiredcustomer_idstringOptionalExample cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm
expires_atstring · date-timeRequiredfee_journal_idstringOptionalExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
idstringRequiredkindstringOptionalmatchesintegerRequiredpayeestringOptionalreasonstringOptionalreleased_atstring · date-time or nullOptionalreleased_bystringOptionalThe verified operator who lifted the order
requested_bystringOptionalstatusstringRequiredActive, released, expired
writtenbooleanRequiredtostring · dateRequiredA business date, YYYY-MM-DD
totalsobjectRequiredReconciliationTotals tie the file.
6 child attributes
outstanding_amountintegerRequiredoutstanding_countintegerRequiredpaid_amountintegerRequiredpaid_countintegerRequiredreturned_amountintegerRequiredreturned_countintegerRequiredvoidedarray of objectsRequired9 child attributes
account_idstringRequiredExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
amountintegerRequiredcheck_numberstringRequiredcreated_atstring · date-timeRequiredidstringRequiredinclearing_item_idstringOptionalissued_onstring · dateOptionalA business date, YYYY-MM-DD
payeestringOptionalstatusstringRequiredOutstanding, paid, voided, stale
Errors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503