Querying for ACH accounts

GET 
/api/v3/ach

Available query parameter values for filtering:

• ach_id
• customer_id
• external_key
• token

Request

Query Parameters

where string

customer_id:EQUALS:1000

order string

ach_id:ASC

limit string

2

offset string

8

Responses

200

Object was fetched successfully

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response object

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": {}
}

Example 1

{
  "code": 200,
  "status": "OK",
  "message": "",
  "details": {},
  "response": [
    {
      "ach_id": 6,
      "external_key": null,
      "type": "chec",
      "token": "zm960n26k14h",
      "type_name": "Checking",
      "customer_id": 36,
      "name": "Camille Bettencourt",
      "mask_bank": "Isabella Bank",
      "mask_number": "x6667",
      "mask_routing": "x3004"
    },
    {
      "ach_id": 7,
      "external_key": null,
      "type": "chec",
      "token": "31q03f11yw98",
      "type_name": "Checking",
      "customer_id": 36,
      "name": "Camille Bettencourt",
      "mask_bank": "Td Bank, Na",
      "mask_number": "x6670",
      "mask_routing": "x3093"
    }
  ]
}

400

Bad request

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 400,
  "status": "Error",
  "message": "Missing or invalid parameter.",
  "details": {},
  "response": false
}

401

Authentication error

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 401,
  "status": "Error",
  "message": "Invalid or incorrect authorization [Missing (basic) authorization header.]",
  "details": {},
  "response": false
}

Loading...