Sign in

v1

latestOpenAPI 3.0.12026-07-26106359429.8 KB
ACH

Retrieve an ACH

Retrieve an ACH object.

get/v1/ach/{ach_id}

Path parameters

ach_idstring required

ID of the ACH object you want to retrieve.

Response

An ACH object.

idstring

id of the ACH object

created_atstring date-time

The ISO-8601 timestamp at which the ACH object was created.

updated_atstring date-time

The ISO-8601 timestamp at which the ACH object was last updated.

status'scheduled' | 'processing' | 'submitted' | 'posted' | 'canceled' | 'under_review' | 'approved' | 'rejected' | 'pending_return' | 'returned' | 'pending_dishonored_return' | 'return_dishonored' | 'pending_contested_return' | 'return_contested'

The current status of the ACH object.

amountinteger

The amount of the transaction in cents.

account_idstring

The ID of the Account object.

account_number_idstring

The ID of the Lead Bank Account Number object.

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.

delivery_type'same_business_day' | 'next_business_day'

How fast you want the counterparty to receive the ACH.

  • same_business_day: if the ACH request is submitted before the cutoff window with the same business day option, funds will settle on the same day. 
  • next_business_day: standard ACH processing, for funds to settle on the next business day.
transaction_type'credit' | 'debit'

ACH transaction type.

sec_code'PPD' | 'CCD' | 'ARC' | 'BOC' | 'CIE' | 'CTX' | 'IAT' | 'POP' | 'POS' | 'RCK' | 'TEL' | 'WEB' | 'ADV' | 'DNE' | 'ENR' | 'MTE' | 'SHR' | 'TRC' | 'TRX' | 'COR'

Standard Entry Class (SEC) code to use for this ACH object.

Lead currently only supports CCD, PPD, WEB, and TEL for outgoing ACHes.

currency_code'USD'

A three-letter currency code as defined in ISO 4217.

statement_descriptorstring

The description you would like to appear on your customers’ statement. Maximum number of characters is 10.

metadataMetadata

A set of key-value pairs that can be used to store additional information related to this object.

Example response

{
  "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"
      }
    ]
  }
}