v1

latestOpenAPI 3.0.12026-07-26106359429.8 KB

ACH

List all ACHes

List all ACH objects.

get/v1/ach

Query parameters

account_idstring

Return ACHes associated with this account_id.

account_numberstring

Return ACHes associated with this account_number.

account_number_idstring

Return ACHes associated with this account_number_id.

counterparty_account_numberstring

Return ACHes associated with this counterparty's account_number.

direction'outgoing' | 'incoming'

Who is initiating the transaction.

outgoing: You are sending a transaction to a counterparty. incoming: You are receiving a transaction from a counterparty.

Example:outgoing

Return ACHes with this direction.

The current status of the ACH object.

Example:submitted

Return ACHes with this status.

transaction_type'credit' | 'debit'

ACH transaction type.

Example:credit

Return ACHes with this transaction_type.

afterstring date-time

Return objects where the created_at timestamp is after the entered timestamp.

on_or_afterstring date-time

Return objects where the created_at timestamp is the same as or after the entered timestamp.

beforestring date-time

Return objects where the created_at timestamp is before the entered timestamp.

on_or_beforestring date-time

Return objects where the created_at timestamp is the same as or before the entered timestamp.

A set of filters on the list using the object’s field created_at.

limitinteger

Maximum number of objects to be returned.

starting_afterstring

A cursor for use in pagination; this is an ID that defines your place in the list.

ending_beforestring

A cursor for use in pagination; this is an ID that defines your place in the list.

Response

A list of ACHes

has_moreboolean required

Indicates whether more results are available.

Example response

{
  "objects": [
    {
      "id": "ach_xyz001",
      "created_at": "2022-06-27T11:22:33Z",
      "updated_at": "2022-06-27T11:22:33Z",
      "status": "submitted",
      "amount": 5000,
      "account_id": "account_xyz123",
      "account_number_id": "account_number_xyz123",
      "direction": "outgoing",
      "delivery_type": "same_business_day",
      "transaction_type": "credit",
      "sec_code": "WEB",
      "currency_code": "USD",
      "statement_descriptor": "P2P Credit",
      "record_details": {
        "transaction_code": "checking_credit",
        "company_name": "Acme Inc.",
        "company_id": "1234",
        "company_discretionary_data": "Acme Inc.",
        "effective_date": "2022-06-27",
        "settlement_date": "2022-06-27",
        "descriptive_date": "220627",
        "trace_number": "123456789012345"
      },
      "counterparty": {
        "name": "Lara Smikle",
        "account_number": "1032345678",
        "routing_number": "021000021",
        "account_type": "checking"
      },
      "returns": [
        {
          "type": "return",
          "status": "submitted",
          "return_code": "R02",
          "trace_number": "123456789012345"
        }
      ],
      "rejection": {
        "reason": "account_number_status",
        "details": "Account number account_123 is inactive."
      },
      "correction": {
        "account_number": "1032345678",
        "routing_number": "021000021"
      },
      "iat_details": {
        "transaction_type_code": "business",
        "destination_country": "CA",
        "originator_currency_code": "USD",
        "destination_currency_code": "CAD",
        "foreign_trace_number": "FRN-2024-98765-INTL",
        "originator": {
          "name": "Acme Inc.",
          "street_address": "123 Main Street",
          "city_state_province": "New York*NY\\",
          "country_postal_code": "US*10001\\"
        },
        "originating_financial_institution": {
          "name": "First National Bank",
          "identifier_type": "swift_bic",
          "identifier_code": "FNBUS33XXX",
          "branch_country": "US"
        },
        "receiver": {
          "name": "Lara Smikle",
          "reference_number": "RCV-2024-001",
          "street_address": "456 Maple Avenue",
          "city_state_province": "Toronto*ON\\",
          "country_postal_code": "CA*M5H 2N2\\"
        },
        "receiving_financial_institution": {
          "name": "First National Bank",
          "identifier_type": "swift_bic",
          "identifier_code": "FNBUS33XXX",
          "branch_country": "US"
        },
        "foreign_correspondent_banks": [
          {
            "name": "First National Bank",
            "identifier_type": "swift_bic",
            "identifier_code": "FNBUS33XXX",
            "branch_country": "US"
          }
        ]
      }
    }
  ]
}