Receive a NACHA file as the RDFI
/rails/ach/inboundHeaders
Idempotency-KeystringOptionalSend on every write that creates or changes money or state; a replay with the same key returns the original result with 200.
Returns
200 OK
fileobjectRequired8 child attributes
directionstringRequiredeffective_datestring · dateRequiredA business date, YYYY-MM-DD
entry_countintegerRequiredidstringRequiredrail_refstringRequiredstatusstringRequiredtotal_credit_amountintegerRequiredtotal_debit_amountintegerRequiredreceiptsarray of objectsRequired25 child attributes
account_idstringRequiredExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
account_numberstringRequiredamountintegerRequiredcompany_idstringOptionaleffective_datestring · date or nullOptionalA business date, YYYY-MM-DD
file_idstringRequiredExample achf_2tVh8nqLxq4GbDe0K1F6S9zRcWm
hold_reasonstringOptionaliatobject or nullOptionalIATDetails are the international addenda of an IAT entry. On an entry the bank originates the originator and originating DFI are filled from the customer and the bank when blank; the counterparty routing number is the U.S. Gateway Operator's and the foreign bank is the receiving DFI.
16 child attributes
correspondentsarray of objectsOptional4 child attributes
branch_countrystringRequiredidstringRequiredid_qualifierstringRequired01 national clearing system, 02 BIC, 03 IBAN
namestringRequireddestination_countrystringRequireddestination_currencystringRequiredforeign_amountintegerOptionalforeign_exchange_indicatorstringOptionalFF (default), FV, VF
foreign_exchange_referencestringOptionalforeign_tracestringOptionalofac_indicatorstringOptionalThe Gateway Operator's: 0 no match, 1 a potential match
originating_currencystringOptionalUSD by default
originating_dfiobjectRequiredIATDFI is a bank on an international entry.
4 child attributes
branch_countrystringRequiredidstringRequiredid_qualifierstringRequired01 national clearing system, 02 BIC, 03 IBAN
namestringRequiredoriginatorobjectRequiredIATParty is the originator or the receiver of an international entry.
7 child attributes
citystringRequiredcountrystringRequiredISO 3166-1 alpha-2
idstringOptionalnamestringRequiredpostal_codestringOptionalregionstringOptionalstreetstringRequiredreceiverobjectRequiredIATParty is the originator or the receiver of an international entry.
7 child attributes
citystringRequiredcountrystringRequiredISO 3166-1 alpha-2
idstringOptionalnamestringRequiredpostal_codestringOptionalregionstringOptionalstreetstringRequiredreceiving_dfiobjectRequiredIATDFI is a bank on an international entry.
4 child attributes
branch_countrystringRequiredidstringRequiredid_qualifierstringRequired01 national clearing system, 02 BIC, 03 IBAN
namestringRequiredremittancearray of stringsOptionalsecondary_ofac_indicatorstringOptionaltransaction_type_codestringRequiredANN, BUS, DEP, LOA, MIS, MOR, PEN, REM, RLS, SAL, TAX, TEL, WEB
idstringRequiredExample achr_2tVh8nqLxq4GbDe0K1F6S9zRcWm
individual_idstringOptionaljournal_idstringRequiredExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
ledger_account_idstringOptionalExample lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm
namestringOptionalodfistringOptionaloriginator_namestringOptionaloutcomestringRequiredPosted, returned, accepted (a prenotification), held (an international entry under review), blocked
return_codestringRequiredreturn_reasonstringRequiredreversal_journal_idstringOptionalExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
reviewed_atstring · date-time or nullOptionalreviewed_bystringOptionalscreening_idsarray of stringsOptionalsec_codestringOptionaltrace_numberstringRequiredtransaction_codestringRequiredreplayedbooleanRequiredreturn_fileobject or nullOptional8 child attributes
directionstringRequiredeffective_datestring · dateRequiredA business date, YYYY-MM-DD
entry_countintegerRequiredidstringRequiredrail_refstringRequiredstatusstringRequiredtotal_credit_amountintegerRequiredtotal_debit_amountintegerRequiredErrors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503