Skip to main content
GET
/
api
/
v2
/
merchants
Fetch Merchants
curl --request GET \
  --url https://api.chargeblast.com/api/v2/merchants \
  --header 'X-API-Key: <x-api-key>'
{
  "page": 1,
  "total": 1,
  "merchants": [
    {
      "name": "sandbox-merchant-1",
      "id": "cb_xxxxxxxxxxxxx"
    }
  ]
}
Returns all merchants for your Chargeblast account. The response is paginated using the page and per query parameters. Each merchant in the response includes a name and id. The name is set during onboarding and, for multi-merchant accounts, corresponds to the individual merchant name (typically the DBA or billing descriptor). The merchant id returned here is the same value as the merchantId in the webhook alert payload—use it to associate incoming alerts with the correct merchant.

Headers

​
X-API-Key
string
required

Your API key. Sent in the X-API-Key header.

Query Parameters

​
page
integer<int64> | null

The starting page of the request. Default value of 1.

​
per
integer<int64> | null

How many merchants to return per page. Default value of 10.

Response

200 - application/json

OK

​
page
integer<int64>
required

The current page number.

​
total
integer<int64>
required

The total number of merchants.

​
merchants
object[]
required

The list of merchants for the current page.