The Payable Remittance object
Reviewed source allocations, cash reservation, exact outbound instruction and signed actual payable settlement evidence.
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.
11 child attributes
application_idstringRequiredcase_idstringRequiredExample case_2tVh8nqLxq4GbDe0K1F6S9zRcWm
disbursement_unitstringRequiredfipsstringOptionalmedical_supportstringRequiredncp_identifier_idstringRequiredncp_identifier_last4stringRequiredncp_namestringOptionalorder_evidence_referencestringRequiredorder_evidence_sha256stringRequiredstatestringRequiredlevyobject or nullOptionalLevyTerms bind one served Form 668-A notice.
4 child attributes
noticeobjectRequiredLevyNotice is what the bank copies from the served notice. The taxpayer's identifying number is held sealed by the caller; only its last four digits are part of this record.
notice_evidence_referencestringRequirednotice_evidence_sha256stringRequiredtaxpayer_identifier_idstringRequiredtax_depositobject or nullOptionalTaxDepositTerms bind the bank's EFTPS ACH credit enrollment for one return and tax year.
9 child attributes
deposit_schedulestringOptionalenrollment_evidence_referencestringRequiredenrollment_evidence_sha256stringRequiredformstringRequiredschedule_evidence_referencestringOptionalschedule_evidence_sha256stringOptionaltax_yearintegerRequiredtaxpayer_einstringRequiredtaxpayer_namestringRequiredunclaimed_propertyobject or nullOptionalUnclaimedPropertyTerms bind the bank's holder enrollment with one state administrator.
5 child attributes
enrollment_evidence_referencestringRequiredenrollment_evidence_sha256stringRequiredholderobjectRequiredNAUPAHolder is the HOLDER record.
portal_holder_idstringRequiredstatestringRequiredauthority_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 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
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.
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
review_sha256stringRequiredreviewed_atstring · date-timeRequiredreviewed_bystringRequired