Skip to main content
GET
/
api
/
v2
/
payment-methods
List payment methods
curl --request GET \
  --url https://demo.api.loopcrypto.xyz/api/v2/payment-methods \
  --header 'Authorization: Bearer <token>'
{
  "totalResults": 100,
  "paymentMethods": [
    {
      "paymentMethodId": "1234567890abcdef",
      "merchantId": "67e55044-10b1-426f-9247-bb680e5fe0c8",
      "paymentMethodName": "My Crypto Wallet",
      "active": true,
      "customer": {
        "customerId": "1234567890abcdef",
        "customerRefId": "1234567890abcdef"
      },
      "networkId": 1,
      "walletAddress": "0x1234567890abcdef",
      "isDefault": true,
      "token": {
        "symbol": "USDC",
        "tokenId": "123e4567-e89b-12d3-a456-426614174000",
        "address": "0x1234567890abcdef",
        "decimals": 6,
        "exchangeRates": [
          {
            "currency": "USD",
            "price": "10000",
            "provider": "CoinMarketCap",
            "timestamp": 1715731200
          }
        ]
      },
      "preAuthorization": {
        "balance": "100",
        "authorization": "49.9"
      },
      "dateCreated": 1716211200
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
merchantId
string

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

​
customerRefId
string

Optional filter to retrieve payment methods for a specific customer. Useful for filtering payment methods when managing multiple customers

​
paymentMethodId
string

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

​
paymentMethodName
string

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

​
active
boolean

Optional filter to retrieve payment methods based on their active status. Useful for filtering payment methods when managing multiple payment methods

​
networkId
number

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

​
walletAddress
string

Optional filter to retrieve payment methods for a specific wallet address. Useful for filtering payment methods when managing multiple wallets

​
tokenAddress
string

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

​
tokenSymbol
string

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

​
isDefault
boolean

Optional filter to retrieve payment methods that are the default payment method for a merchant. Useful for filtering payment methods 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 "paymentMethodId", "paymentMethodName", "networkId", "walletAddress" 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 methods matching the search criteria, regardless of page size or number.

Example:

100

​
paymentMethods
object[]
required

The list of payment methods grouped by merchant and network

⌘I