Skip to main content
GET
/
v1
/
ach
List all ACHes
curl --request GET \
  --url https://api.sandbox.lead.bank/v1/ach \
  --header 'Authorization: Bearer <token>'
{
  "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": {
        "company_name": "Acme Inc.",
        "company_id": "1234",
        "company_discretionary_data": "Acme Inc.",
        "effective_date": "2022-06-27",
        "settlement_date": "2022-06-27",
        "individual_id": "<string>",
        "receiver_name": "<string>",
        "descriptive_date": "220627",
        "additional_information": "<string>",
        "trace_number": "123456789012345"
      },
      "counterparty": {
        "name": "Lara Smikle",
        "account_number": "1032345678",
        "routing_number": "021000021",
        "account_type": "checking"
      },
      "returns": [
        {
          "type": "return",
          "status": "submitted",
          "return_code": "R02",
          "return_reason": "<string>",
          "trace_number": "123456789012345",
          "additional_information": "<string>"
        }
      ],
      "reversal": {
        "reversal_reason": "duplicate",
        "linked_ach_id": "<string>"
      },
      "rejection": {
        "reason": "account_number_status",
        "details": "Account number account_123 is inactive."
      },
      "correction": {
        "account_number": "1032345678",
        "routing_number": "021000021",
        "account_type": "checking"
      },
      "metadata": {}
    }
  ],
  "has_more": true
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
account_id
string

Return ACHes associated with this account_id.

Pattern: ^account_\w+$
​
account_number
string

Return ACHes associated with this account_number.

Maximum string length: 17
​
account_number_id
string

Return ACHes associated with this account_number_id.

Pattern: ^account_number_\w+$
​
counterparty_account_number
string

Return ACHes associated with this counterparty's account_number.

Maximum string length: 17
​
direction
enum<string>

Return ACHes with this direction. Who is initiating the transaction.

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

Available options:
outgoing,
incoming
Example:

"outgoing"

​
status
enum<string>

Return ACHes with this status. The current status of the ACH object.

Available options:
scheduled,
processing,
submitted,
posted,
canceled,
under_review,
approved,
rejected,
pending_return,
returned
Example:

"submitted"

​
transaction_type
enum<string>

Return ACHes with this transaction_type. ACH transaction type.

Available options:
credit,
debit
Example:

"credit"

​
created_at
object

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

​
limit
integer
default:10

Maximum number of objects to be returned.

Required range: 1 <= x <= 100
​
starting_after
string

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

Pattern: ^ach_\w+$
​
ending_before
string

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

Pattern: ^ach_\w+$

Response

A list of ACHes

​
objects
object[]
required
​
has_more
boolean
required

Indicates whether more results are available.