Bolt has moved to boltapp.com. Stores still using bolt.com hosts must update now: see the migration guide.

Skip to content

List transfers

View As MarkdownMCP
GET
/v3/transfers

List your transfers, most recently created first. Ordering is stable across pages.

Filtering by reference is the fastest way to resolve whether a create you did not get a response for actually landed.

Authorization

X-API-Key X-Publishable-Key
X-API-Key<token>

Your Bolt API key, from Developer > API in the Bolt Merchant Dashboard. Server-side only. Sandbox keys work only against api-sandbox.boltapp.com. Using a sandbox key against production, or the reverse, returns 401.

In: header

X-Publishable-Key<token>

The publicly shareable identifier for your merchant division. Your authenticated account is always one side of a transfer, and seller IDs are resolved against it.

In: header

Query Parameters

reference?string

Exact match on the reference you supplied when creating the transfer.

seller_id?string

Only return transfers involving this seller.

direction?string

Only return transfers moving in this direction.

Value in

  • "payout"
  • "collection"
status?string

Only return transfers in these statuses. Comma-separated.

transfer_group?string

Only return transfers with exactly this transfer group.

created_at_min?string

Only return transfers created at or after this time, inclusive.

Formatdate-time
created_at_max?string

Only return transfers created at or before this time, inclusive.

Formatdate-time
page?integer

The page to retrieve, starting at 1.

Range1 <= value
Default1
page_size?integer

The number of results to return per page.

Range1 <= value <= 200
Default50

Response Body

application/json

application/json

curl -X GET "https://example.com/v3/transfers?reference=payout-2026-10-14-seller4471&seller_id=seller_4471&direction=payout&status=pending%2Cin_transit&transfer_group=PAYOUT_2026_10_W2&created_at_min=2026-10-01T00%3A00%3A00Z&created_at_max=2026-10-31T23%3A59%3A59Z"
{  "transfers": [    {      "id": "trf_9f8e7d6c5b",      "created_at": "2026-10-14T17:32:28Z",      "updated_at": "2026-10-15T02:14:09Z",      "status": "pending",      "direction": "payout",      "seller_id": "seller_4471",      "reference": "payout-2026-10-14-seller4471",      "amount": {        "currency": "USD",        "units": 4000      },      "amount_reversed": {        "currency": "USD",        "units": 4000      },      "reversed": false,      "description": "October payout, orders 95 to 112",      "transfer_group": "PAYOUT_2026_10_W2",      "payout_reference": "po_20261015_0031",      "failure_reason": "rejected_by_bank",      "reversals": [        {          "id": "trr_4a3b2c1d0e",          "created_at": "2026-10-20T11:02:44Z",          "transfer_id": "trf_9f8e7d6c5b",          "status": "pending",          "amount": {            "currency": "USD",            "units": 4000          },          "reference": "reversal-return-8831",          "description": "Partial return, 1 of 3 items",          "payout_reference": "po_20261021_0044",          "metadata": {            "invoice": "INV-2026-0114"          }        }      ],      "metadata": {        "invoice": "INV-2026-0114"      }    }  ],  "pagination": {    "page": 1,    "page_size": 50,    "total_count": 132  }}