v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB

ACH

Get Incoming ACH Transaction By ID

🚧 Beta This is a Beta endpoint for use by early adopters. Do not use this endpoint with real customers. Feedback from the community is welcome. Any breaking changes to this endpoint will be pre-announced.

get/ach/incoming/{id}

Path parameters

idstring uuid required

Example:7d943c51-e4ff-4e57-9558-08cab6b963c7

The unique resource identifier

Response

Incoming ACH transaction

account_idstring uuid

The unique identifier for a receiving account. If the entry is in suspense (status = "IN_SUSPENSE"), this represents the intended customer account, i.e. the account that 'account_no' from the ACH entry refers to (if it exists in the Synctera system). If the entry has been posted (status = "POSTED"), it is the account the transaction was actually posted to. In that case it does not necessarily correspond to the account number in 'account_no'.

account_nostring required

Receiving account number. This is the account number from the ACH entry, actual account the transaction gets posted to after processing may be different (e.g. suspense account).

amountinteger required

Transfer amount in cents ($100 would be 10000)

company_entry_descriptionstring required

Company Entry Description field in ACH batch header. Originator inserts this field's value to provide the Receiver with a description of the entry's purpose. NACHA Operating Rules dictate that Payroll or E-Commerce Purchase ACH transactions require setting this field to PAYROLL or PURCHASE respectively.

company_namestring required

Company Name field in ACH batch header.

customer_idstring uuid

The unique identifier of the account holder (customer or business).

dc_sign'credit' | 'debit' required

The type of transaction (debit or credit). An incoming debit pulls money out of the receiving account, a credit is a transfer in.

decline_reasonstring

Free-form text describing the reason why this entry did not post to the intended account when first processed.

effective_datestring date required

Effective date of the transaction

external_idstring uuid

Transaction ID in the ledger. The transaction may not exist yet in case the entry is a future-dated ACH.

file_namestring required

The name of the ACH file this entry came in, if available.

idstring uuid required

identification_numberstring required

Value in this field varies depending on the SEC code. Can contain check serial number, identification number or a name of the originator.

individual_namestring required

The name of the receiver, as entered by the originator. Usually the name on the bank account.

is_future_datedboolean required

Was the effective date in the future when the entry was received?

originating_routing_numberstring required

The routing number of the DFI that originated the entry, with check digit included (9 digits in total).

outgoing_ach_idstring uuid

ID of the linked outgoing ACH entry. This is filled only for incoming ACH entries that are returns and links to the original outgoing entry that is now being returned.

reference_infostring[]

Contents of all attached records with addenda 05 (payment related information). Some SEC codes allow multiple instances of addenda 05.

sec_codestring required

SEC (Standard Entry Class) code of the ACH entry

settlement_datestring date required

Settlement date of the transaction

Processing status of the incoming entry

tenantstring required

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

trace_nostring required

Trace number of the ACH entry

Example response

{
  "account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
  "account_no": "122455799",
  "amount": 10000,
  "company_entry_description": "PAYROLL",
  "company_name": "Asdf Finance",
  "customer_id": "46fac778-90c0-4d55-9a21-a587e564e7b5",
  "decline_reason": "Suspected fraud",
  "effective_date": "2022-03-25",
  "iat_info": {
    "originator_address": {
      "city_state_province": "San Francisco*CA",
      "country_postal_code": "US*10036"
    },
    "receiver_address": {
      "city_state_province": "San Francisco*CA",
      "country_postal_code": "US*10036"
    }
  },
  "id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
  "notification_of_change": {
    "change_code": "C01",
    "corrected_data": "122455799",
    "original_dfi_no": "364275034",
    "original_trace": "123456780000069"
  },
  "originating_routing_number": "364275034",
  "outgoing_ach_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
  "return_data": {
    "code": "R01",
    "dishonored_return_code": "69",
    "dishonored_return_settlement_date": "256",
    "dishonored_return_trace": "123456780000069",
    "field_errors": "05",
    "original_dfi_no": "364275034",
    "original_trace": "123456780000069",
    "return_code": "13",
    "return_settlement_date": "256",
    "return_trace": "123456780000069"
  },
  "sec_code": "WEB",
  "settlement_date": "2022-03-25",
  "tenant": "abcdef_ghijkl",
  "trace_no": "123456780000069"
}