The Agency Remittance object
AgencyRemittance is the agency view of a payable remittance.
Attributes
acknowledgmentsarray of objectsRequired5 child attributes
documentobjectRequiredAcknowledgment is one signed agency outcome for a submission.
14 child attributes
agencystringRequiredagency_referencestringOptionalamount_minorintegerRequiredcontent_sha256stringRequiredenvironmentstringRequiredevent_idstringRequiredfieldsobjectOptionalkey_idstringRequiredkindstringRequiredoccurred_atstring · date-timeRequiredreasonsarray of stringsOptionalsignaturestringRequiredsubmission_referencestringRequiredversionstringRequiredidstringRequiredrecorded_atstring · date-timeRequiredrecorded_bystringRequiredsubmission_idstringRequiredagencystringRequiredledger_view_sha256stringOptionalprotocolstringRequiredreconciliationobject or nullOptionalAgencyReconciliation ties one remittance's payable sources, its issued instruction and transmitted message, the native ledger's cash receipts and the agency's acknowledgments. It is matched only when every source allocation is settled in cash, the message carries exactly that amount, the agency confirmed exactly that amount and nothing was returned or refused.
19 child attributes
acknowledgmentsarray of stringsRequiredactorstringRequiredagency_referencesarray of stringsRequiredcash_readybooleanRequiredconfirmed_minorintegerRequiredcontent_sha256stringRequiredcreated_atstring · date-timeRequireddifferencesarray of stringsRequiredidstringRequiredinstruction_minorintegerRequiredmessage_minorintegerRequiredprotocolstringRequiredreceipt_event_idsarray of stringsRequiredremittance_idstringRequiredreturned_minorintegerRequiredsettled_minorintegerRequiredsourcesarray of objectsRequired5 child attributes
allocated_minorintegerRequiredobligation_idstringRequiredreturned_minorintegerRequiredsettled_minorintegerRequiredsource_sha256stringRequiredstatusstringRequiredversionintegerRequiredremittanceobjectRequired11 child attributes
actorstringRequiredcontent_sha256stringRequiredcreated_atstring · date-timeRequireddecisionobject or nullOptional5 child attributes
actorstringRequiredatstring · date-timeRequiredcontent_sha256stringRequireddecisionstringRequiredreasonstringRequiredidstringRequiredinstructionobject or nullOptionalInstruction is immutable before dispatch. Its retained source controls must independently establish provider/key trust, payee authority, actual master account ownership, source reservations and human approval. Validate is not a substitute for those service checks or for a bank connectivity adapter.
20 child attributes
allocationsarray of objectsRequired3 child attributes
amount_minorintegerRequiredobligation_idstringRequiredsource_sha256stringRequiredamount_minorintegerRequiredcurrencystringRequireddestinationobjectRequiredDestination is the exact reviewed beneficiary and domestic receiving account. A valid routing checksum does not establish actual bank or account ownership.
3 child attributes
account_numberstringRequiredlegal_namestringRequiredrouting_numberstringRequiredenvironmentstringRequiredidstringRequiredissued_atstring · date-timeRequiredkey_idstringRequiredlegal_entitystringRequiredmaster_cash_external_account_referencestringRequiredmaster_cash_ledger_account_idstringRequiredExample lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm
network_referencestringRequiredoutbound_message_sha256stringRequiredpayee_control_idstringRequiredpayee_sha256stringRequiredprotocolstringOptionalEmpty for a beneficiary wire
providerstringRequiredrailstringRequiredsettlement_datestring · dateRequiredA business date, YYYY-MM-DD
versionstringRequiredobligationsarray of objectsRequired22 child attributes
account_idstringOptionalExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
amount_minorintegerRequiredcontent_sha256stringRequiredcreated_atstring · date-timeRequiredcurrencystringRequiredcustomer_idstringRequiredExample cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm
evidence_referencestringRequiredhold_idstringRequiredExample hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm
idstringRequiredissuerstringRequiredjurisdictionstringOptionalkindstringRequiredlegal_entitystringRequiredloan_idstringOptionalExample loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm
payee_referencestringOptionalsourceobjectRequired6 child attributes
closure_componentstringOptionalclosure_ledger_account_idstringOptionalExample lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm
journal_idstringRequiredExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
journal_keystringRequiredjournal_sha256stringRequiredledger_account_idstringRequiredExample lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm
source_datestring · dateRequiredA business date, YYYY-MM-DD
source_date_basisstringOptionalsource_idstringRequiredsource_sha256stringRequiredtax_customer_idstringOptionalExample cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm
tax_periodstringOptionaloutbound_messagestringOptionalrecipientobjectRequired24 child attributes
actorstringRequiredagencyobject or nullOptionalAgency holds the reviewed terms of an agency protocol; omitted for a beneficiary wire so the digests of recipients reviewed before agency protocols existed are unchanged.
4 child attributes
child_supportobject or nullOptionalChildSupportTerms bind one served child support order to its state disbursement unit.
levyobject or nullOptionalLevyTerms bind one served Form 668-A notice.
tax_depositobject or nullOptionalTaxDepositTerms bind the bank's EFTPS ACH credit enrollment for one return and tax year.
unclaimed_propertyobject or nullOptionalUnclaimedPropertyTerms bind the bank's holder enrollment with one state administrator.
authority_evidence_referencestringRequiredauthority_evidence_sha256stringRequiredcontent_sha256stringRequiredcreated_atstring · date-timeRequireddecisionobject or nullOptional5 child attributes
actorstringRequiredatstring · date-timeRequiredcontent_sha256stringRequireddecisionstringRequiredreasonstringRequireddestinationobjectRequiredDestination is the exact reviewed beneficiary and domestic receiving account. A valid routing checksum does not establish actual bank or account ownership.
3 child attributes
account_numberstringRequiredlegal_namestringRequiredrouting_numberstringRequiredenvironmentstringRequiredidstringRequiredjurisdictionstringRequiredkey_idstringRequiredkindstringRequiredlegal_entitystringRequiredloan_idstringOptionalExample loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm
master_cash_external_account_referencestringRequiredpayee_referencestringRequiredprotocolstringRequiredproviderstringRequiredpublic_keystringRequiredreceiving_bank_namestringRequiredrevocationobject or nullOptional3 child attributes
actorstringRequiredatstring · date-timeRequiredreasonstringRequiredvalid_fromstring · dateRequiredA business date, YYYY-MM-DD
valid_throughstring · dateRequiredA business date, YYYY-MM-DD
requestobjectRequired5 child attributes
agency_report_idstringOptionalAgencyReportID names the accepted unclaimed property holder report an unclaimed property remittance pays; omitted otherwise.
Example strp_2tVh8nqLxq4GbDe0K1F6S9zRcWm
allocationsarray of objectsRequired2 child attributes
amount_minorintegerRequiredobligation_idstringRequiredrecipient_idstringRequiredreferencestringRequiredsettlement_datestring · dateRequiredA business date, YYYY-MM-DD
reservationobject or nullOptional11 child attributes
actorstringRequiredcontent_sha256stringRequiredcreated_atstring · date-timeRequiredinstructionobjectRequiredInstruction is immutable before dispatch. Its retained source controls must independently establish provider/key trust, payee authority, actual master account ownership, source reservations and human approval. Validate is not a substitute for those service checks or for a bank connectivity adapter.
20 child attributes
allocationsarray of objectsRequiredamount_minorintegerRequiredcurrencystringRequireddestinationobjectRequiredDestination is the exact reviewed beneficiary and domestic receiving account. A valid routing checksum does not establish actual bank or account ownership.
environmentstringRequiredidstringRequiredissued_atstring · date-timeRequiredkey_idstringRequiredlegal_entitystringRequiredmaster_cash_external_account_referencestringRequiredmaster_cash_ledger_account_idstringRequiredExample lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm
network_referencestringRequiredoutbound_message_sha256stringRequiredpayee_control_idstringRequiredpayee_sha256stringRequiredprotocolstringOptionalEmpty for a beneficiary wire
providerstringRequiredrailstringRequiredsettlement_datestring · dateRequiredA business date, YYYY-MM-DD
versionstringRequiredmaster_hold_idstringRequiredExample hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm
outbound_messagestringRequiredproposed_bystringRequiredrecipientobjectRequired24 child attributes
actorstringRequiredagencyobject or nullOptionalAgency holds the reviewed terms of an agency protocol; omitted for a beneficiary wire so the digests of recipients reviewed before agency protocols existed are unchanged.
authority_evidence_referencestringRequiredauthority_evidence_sha256stringRequiredcontent_sha256stringRequiredcreated_atstring · date-timeRequireddecisionobject or nullOptionaldestinationobjectRequiredDestination is the exact reviewed beneficiary and domestic receiving account. A valid routing checksum does not establish actual bank or account ownership.
environmentstringRequiredidstringRequiredjurisdictionstringRequiredkey_idstringRequiredkindstringRequiredlegal_entitystringRequiredloan_idstringOptionalExample loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm
master_cash_external_account_referencestringRequiredpayee_referencestringRequiredprotocolstringRequiredproviderstringRequiredpublic_keystringRequiredreceiving_bank_namestringRequiredrevocationobject or nullOptionalvalid_fromstring · dateRequiredA business date, YYYY-MM-DD
valid_throughstring · dateRequiredA business date, YYYY-MM-DD
review_sha256stringRequiredreviewed_atstring · date-timeRequiredreviewed_bystringRequiredsubmissionsarray of objectsRequired11 child attributes
actorstringRequiredadapterstringRequiredagencystringRequiredattributesobjectRequiredcontent_sha256stringRequiredcreated_atstring · date-timeRequiredidstringRequiredkindstringRequiredreceiptobject or nullOptionalSubmissionReceipt is the carrier's answer that it holds the submission. It is not an agency decision.
6 child attributes
agencystringRequiredcontent_sha256stringRequiredenvironmentstringRequiredkindstringRequiredreceived_atstring · date-timeRequiredreferencestringRequiredsubject_idstringRequiredsubject_kindstringRequiredtransmitted_sha256stringOptional