Create a payable recipient
/payable-recipientsFresh verified staff with payments:operations:write authority is required. Retain exact legal entity, obligation kind, jurisdiction/payee context, reviewed domestic beneficiary, receiving bank, authority evidence, validity dates and cash-evidence key. Source context does not invent tax enrollment, deposit periods or recipient authority. Customer authority is refused. Requests are strict single JSON objects bounded to 8 MiB; complete responses are bounded to 16 MiB and never silently truncated.
Headers
Idempotency-KeystringRequiredSend on every write that creates or changes money or state; a replay with the same key returns the original result with 200.
Body parameters
agencyobject 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.
9 child attributes
form_numberstringRequiredidentifier_last4stringRequiredirs_office_contactstringRequirednotice_datestring · dateRequiredA business date, YYYY-MM-DD
periodsarray of objectsRequiredreply_toobjectRequiredAddress is a mailing address.
served_datestring · dateRequiredA business date, YYYY-MM-DD
taxpayer_namestringRequiredtotal_due_minorintegerRequirednotice_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.
16 child attributes
citystringRequiredclaims_contactobject or nullOptionalNAUPAContact is a HOLDER-CONTACT group.
contactobjectRequiredNAUPAContact is a HOLDER-CONTACT group.
countystringRequiredfaxstringOptionalincorporated_datestring · dateRequiredA business date, YYYY-MM-DD
incorporated_statestringOptionalnaicsstringRequirednamestringRequiredreport_numberintegerRequiredreport_typestringRequiredreport_yearintegerRequiredsicstringOptionalstatestringRequiredtax_idstringRequiredtax_id_extstringRequiredportal_holder_idstringRequiredstatestringRequiredauthority_evidence_referencestringRequiredauthority_evidence_sha256stringRequireddestinationobjectRequiredDestination 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_numberstringRequiredenvironmentstringRequiredjurisdictionstringRequiredkey_idstringRequiredkindstringRequiredlegal_entitystringRequiredloan_idstringOptionalExample loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm
master_cash_external_account_referencestringRequiredpayee_referencestringRequiredprotocolstringRequiredproviderstringRequiredpublic_keystringRequiredreceiving_bank_namestringRequiredvalid_fromstring · dateRequiredA business date, YYYY-MM-DD
valid_throughstring · dateRequiredA business date, YYYY-MM-DD
Returns
200 OK
Errors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503