Skip to main content
GET
/
api
/
v2
/
merchants
List merchants
curl --request GET \
  --url https://demo.api.loopcrypto.xyz/api/v2/merchants \
  --header 'api-key: <api-key>' \
  --header 'entity-id: <api-key>'
{
  "totalResults": 100,
  "merchants": [
    {
      "merchantId": "1234567890abcdef",
      "merchantName": "Loop Inc.",
      "merchantRefId": "1234567890",
      "payoutDestinations": [
        {
          "networkId": 1,
          "walletAddress": "0x1234567890abcdef",
          "isDefault": true,
          "payoutDestinationId": "1234567890abcdef",
          "settlementType": "Crypto"
        }
      ],
      "fiatSettlementAccount": {
        "provider": "Fern",
        "kycStatus": "pending",
        "kycLink": "https://www.google.com",
        "bankAccountStatus": "Pending",
        "bankAccountFormLink": "https://www.google.com"
      },
      "paymentTypes": [
        {
          "symbol": "USDC",
          "networkId": 1,
          "tokenId": "d9e1f2a3-b4c5-6d7e-8f9g-0h1i2j3k4l5m",
          "address": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
          "decimals": 6,
          "isDefault": true
        }
      ]
    }
  ]
}

Authorizations

api-key
string
header
required
entity-id
string
header
required

Query Parameters

merchantId
string

Optional filter to retrieve merchants with a specific ID. Useful for filtering merchants when managing multiple merchants

merchantName
string

Optional filter to retrieve merchants with a specific name. Useful for filtering merchants when managing multiple merchants

merchantRefId
string

Optional filter to retrieve merchants with a specific reference ID. Useful for filtering merchants when managing multiple merchants

page
number

Optional pagination parameter to specify the page number of the results to return. Default is 1 which is the first page.

limit
number

Optional pagination parameter to specify the number of results per page. Default is 25, maximum is 100.

sortBy
string

Optional sorting parameter to specify the field to sort the results by. Valid options are "dateCreated", "merchantId", "merchantName", and "merchantRefId". Default is "dateCreated".

sortDir
string

Optional sorting parameter to specify the direction to sort the results by. Valid options are "asc" and "desc". Default is "desc".

Response

Ok

totalResults
number
required

The total count of merchants matching the search criteria, regardless of page size or number.

Example:

100

merchants
object[]
required

The list of merchants

I