Skip to main content
GET
/
ach
/
incoming
/
{id}
Get Incoming ACH Transaction By ID
curl --request GET \
  --url https://api.synctera.com/v2/ach/incoming/{id}
{
  "account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
  "account_no": "122455799",
  "amount": 10000,
  "company_entry_description": "PAYROLL",
  "company_name": "Asdf Finance",
  "dc_sign": "debit",
  "decline_reason": "Suspected fraud",
  "effective_date": "2022-03-25",
  "external_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "iat_info": {
    "foreign_payment_amount": 123,
    "foreign_trace_number": "<string>",
    "name": "<string>",
    "odfi_branch_country_code": "<string>",
    "odfi_id_number_qualifier": "<string>",
    "odfi_identification": "<string>",
    "odfi_name": "<string>",
    "originator_address": {
      "city_state_province": "San Francisco*CA",
      "country_postal_code": "US*10036",
      "street": "<string>"
    },
    "originator_name": "<string>",
    "rdfi_branch_country_code": "<string>",
    "rdfi_id_number_qualifier": "<string>",
    "rdfi_identification": "<string>",
    "rdfi_name": "<string>",
    "receiver_address": {
      "city_state_province": "San Francisco*CA",
      "country_postal_code": "US*10036",
      "street": "<string>"
    },
    "receiver_id_number": "<string>",
    "transaction_type_code": "<string>"
  },
  "id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
  "identification_number": "<string>",
  "is_future_dated": true,
  "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",
  "reference_info": [
    "<string>"
  ],
  "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",
  "status": "INIT",
  "tenant": "abcdef_ghijkl",
  "trace_no": "123456780000069"
}

Path Parameters

​
id
string<uuid>
required

The unique resource identifier

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

Response

Incoming ACH transaction

Represents an incoming ACH entry.

​
account_no
string
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).

Example:

"122455799"

​
amount
integer
required

Transfer amount in cents ($100 would be 10000)

Example:

10000

​
company_entry_description
string
required

Company Entry Description field in ACH batch header.

Example:

"PAYROLL"

​
company_name
string
required

Company Name field in ACH batch header.

Example:

"Asdf Finance"

​
dc_sign
enum<string>
required

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

Available options:
debit,
credit
​
effective_date
string<date>
required

Effective date of the transaction

Example:

"2022-03-25"

​
id
string<uuid>
required
Example:

"b01db9c7-78f2-4a99-8aca-1231d32f9b96"

​
identification_number
string
required

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

​
is_future_dated
boolean
required

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

​
originating_routing_number
string
required

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

Example:

"364275034"

​
sec_code
string
required

SEC (Standard Entry Class) code of the ACH entry

Example:

"WEB"

​
settlement_date
string<date>
required

Settlement date of the transaction

Example:

"2022-03-25"

​
status
enum<string>
required

Processing status of the incoming entry

Available options:
INIT,
POSTED,
RETURNED,
IN_SUSPENSE,
ERROR,
IGNORED
​
tenant
string
required

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

Example:

"abcdef_ghijkl"

​
trace_no
string
required

Trace number of the ACH entry

Example:

"123456780000069"

​
account_id
string<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'.

Example:

"b01db9c7-78f2-4a99-8aca-1231d32f9b96"

​
decline_reason
string

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

Example:

"Suspected fraud"

​
external_id
string<uuid>

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

​
iat_info
object

Aggregates contents of the IAT addenda records (10-16)

​
notification_of_change
object

Filled if the entry is a notification of change.

​
outgoing_ach_id
string<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.

Example:

"b01db9c7-78f2-4a99-8aca-1231d32f9b96"

​
reference_info
string[]

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

​
return_data
object

Filled if the entry is a return.