Skip to main content
GET
/
api
/
v2
/
payment-types
List payment types
curl --request GET \
  --url https://demo.api.loopcrypto.xyz/api/v2/payment-types \
  --header 'api-key: <api-key>' \
  --header 'entity-id: <api-key>'
{
  "totalResults": 100,
  "paymentTypes": [
    {
      "merchantId": "550e8400-e29b-41d4-a716-446655440000",
      "tokenId": "d9e1f2a3-b4c5-6d7e-8f9g-0h1i2j3k4l5m",
      "isDefault": true,
      "networkId": 1,
      "symbol": "USDC",
      "address": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
      "decimals": 6,
      "dateCreated": 1716211200
    }
  ]
}

Authorizations

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

Query Parameters

​
networkId
number

Optional filter to retrieve payment types for a specific blockchain network. Useful for filtering payment types when managing multiple networks

​
tokenId
string

Optional filter to retrieve payment types for a specific token ID. Useful for filtering payment types when managing multiple tokens

​
tokenSymbol
string

Optional filter to retrieve payment types for a specific token symbol (e.g. USDC, DAI). Useful for filtering payment types when managing multiple tokens

​
tokenAddress
string

Optional filter to retrieve payment types for a specific token address. Useful for verifying payment type configurations for a specific token contract

​
merchantId
string

Optional filter to retrieve payment types configured for a specific merchant. Useful for filtering payment types when managing multiple merchants

​
isDefault
boolean

Optional filter to retrieve payment types configured as default. Useful for verifying which tokens will be used as defaults for checkout sessions

​
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 "merchantId", "tokenId", "tokenSymbol", "networkId", and "dateCreated". 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 payment types matching the search criteria, regardless of page size or number.

Example:

100

​
paymentTypes
object[]
required

The list of payment types grouped by merchant and network

⌘I