List Pull Accounts
The pull accounts ACH pulls may debit, newest first.
New in v3: v2 has no equivalent.
A workspace-scoped key lists the whole workspace's pull accounts, or one account's with account_id; an account-scoped key lists its own account's.
Authorization:
Every request is signed with your API key: a short-lived JWT, signed with your private key, sent in one header on /v3/* and /api/v2/* alike.
Headers:
Authorization: APIKey {SIGNED_JWT}
How to build and sign the JWT: Authentication.
Endpoint
/v3/banking/pull-accounts
Query parameters
| Parameter | Type | Description |
|---|---|---|
account_id | string (cst_…) | Only this account's pull accounts. An account-scoped key lists its own and may omit it. A workspace-scoped key that omits it lists the whole workspace's. |
status | string | Only active or only disabled ones. |
include | string | customer adds the customer object to each row: whose account it is. Every pull account still lists; one whose account was deleted carries the id with an empty name and email. |
page | integer | Page number, from 1. Default 1. |
limit | integer | Rows per page. Default 25, at most 100: a larger value is capped at 100 (see Lists). |
Response Sample
{
"data": [
{
"id": "bpa_01k8x4p6sx9t5v7x1z3b5d7f9h",
"account_id": "cst_01h455vb4pex5vsknk084sn02q",
"name": "Chase checking",
"holder_name": "Samantha Montenegro",
"holder_type": "individual",
"routing_number": "021000021",
"account_number_last4": "6789",
"account_type": "checking",
"currency": "USD",
"status": "active",
"authorization": { "version": "2026-10-20.v2", "accepted_at": "2026-10-19T15:00:00Z" },
"created_at": "2026-10-19T15:00:00Z",
"updated_at": "2026-10-19T15:00:00Z"
}
],
"page": 1,
"limit": 25,
"total_items": 1,
"total_pages": 1
}
Response Schema
| Field | Type | Description |
|---|---|---|
data | array | The pull accounts on this page, each with the fields of a Create a Pull Account response. |
data[].customer | object | Whose account it is: id (cst_…), name, email. Only with include=customer. |
page, limit, total_items, total_pages | integer | Pagination, as described in the API v3 overview. |
Errors
| Status | message | When |
|---|---|---|
400 | failed to parse request | page or limit is not an integer, status is not active or disabled, include is not customer, or account_id is not a cst_… id. |
401 | unauthorized | Missing or invalid signature. |
403 | forbidden | An account-scoped key named another account in account_id. |
Support and Resources
If you need assistance or have any questions, our support team is here to help. You can contact our support team at support@blockwyre.com.
Stay Updated
Stay up-to-date with the latest news, updates, and features from BlockWyre by following us on social media:
- Instagram: BlockWyre Instagram
- Twitter: BlockWyre Twitter
- Facebook: BlockWyre Facebook
- LinkedIn: BlockWyre LinkedIn
We are excited to have you on board and look forward to seeing how you leverage BlockWyre's powerful tools to enhance your financial operations. Happy integrating!