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
- 400
- 401
Object was fetched successfully
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
Array [
]
code integer
status string
message stringnullable
details objectnullable
response
object[]
ach_id integer
ACH ID #
customer_id integer
Customer ID #
external_key string
Unique external key value
type string
Bank account type (one of: chec, busi, savi)
type_name string
Bank account type (pretty name)
token string
ACH account token
mask_number string
Last 4 digits of the bank account number
mask_routing string
Bank account routing number
name string
Name on bank account
mask_bank string
Bank name
url_verifylink string
ACH verification link
write_datetime string
Date/time the bank account was stored
mod_datetime string
Date/time the bank account was modified
{
"code": 0,
"status": "string",
"message": "string",
"details": {},
"response": [
{
"ach_id": 0,
"customer_id": 0,
"external_key": "string",
"type": "string",
"type_name": "string",
"token": "string",
"mask_number": "string",
"mask_routing": "string",
"name": "string",
"mask_bank": "string",
"url_verifylink": "string",
"write_datetime": "string",
"mod_datetime": "string"
}
]
}
{
"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"
}
]
}
Bad request
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
code integer
status string
message stringnullable
details objectnullable
response boolean
{
"code": 0,
"status": "string",
"message": "string",
"details": {},
"response": true
}
{
"code": 400,
"status": "Error",
"message": "Missing or invalid parameter.",
"details": {},
"response": false
}
Authentication error
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
code integer
status string
message stringnullable
details objectnullable
response boolean
{
"code": 0,
"status": "string",
"message": "string",
"details": {},
"response": true
}
{
"code": 401,
"status": "Error",
"message": "Invalid or incorrect authorization [Missing (basic) authorization header.]",
"details": {},
"response": false
}
Loading...