List ACH Pulls
ACH pulls, newest first.
New in v3: v2 has no equivalent.
A workspace-scoped key lists the whole workspace's pulls, 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/ach-pulls
Query parameters
| Parameter | Type | Description |
|---|---|---|
account_id | string (cst_…) | Only this account's pulls. An account-scoped key lists its own and may omit it. A workspace-scoped key that omits it lists the whole workspace's. |
pull_account_id | string (bpa_…) | Only the pulls from this pull account. |
status | string | Only pulls in this status (see How ACH Pulls Work). |
created_at_gte | string (date-time) | Only pulls requested at or after this instant. |
created_at_lt | string (date-time) | Only pulls requested before this instant. |
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 Schema
| Field | Type | Description |
|---|---|---|
data | array | The pulls on this page, each with the fields of a Request an ACH Pull response. |
page, limit, total_items, total_pages | integer | Pagination, as described in the API v3 overview. |
Errors
| Status | message | When |
|---|---|---|
400 | failed to parse request | A parameter has the wrong form. |
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!