Skip to main content
GET
/
api
/
v2
/
payout-destinations
List payout destinations
curl --request GET \
  --url https://demo.api.loopcrypto.xyz/api/v2/payout-destinations \
  --header 'api-key: <api-key>' \
  --header 'entity-id: <api-key>'
{
  "totalResults": 100,
  "payoutDestinations": [
    {
      "payoutDestinationId": "1234567890abcdef",
      "merchantId": "1234567890abcdef",
      "networkId": 1,
      "settlementType": "Crypto",
      "fiatSettlementAccount": {
        "provider": "Fern",
        "kycStatus": "pending",
        "kycLink": "https://www.google.com",
        "bankAccountStatus": "Pending",
        "bankAccountFormLink": "https://www.google.com"
      },
      "walletAddress": "0x1234567890abcdef",
      "isDefault": true,
      "isArchived": true,
      "dateCreated": 1716211200
    }
  ]
}

Authorizations

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

Query Parameters

​
payoutDestinationId
string

Optional filter to retrieve a specific payout destination by its unique identifier. If provided, returns only the destination matching this ID

​
merchantId
string

Optional filter to retrieve all payout destinations associated with a specific merchant. Useful for filtering destinations when managing multiple merchants

​
networkId
string

Optional filter to retrieve payout destinations configured for a specific blockchain network (e.g. Ethereum Mainnet, Polygon, etc). Allows filtering destinations by their network configuration

​
walletAddress
string

Optional filter to find payout destinations matching a specific blockchain wallet address. Can be used to verify if a wallet is already configured as a destination

​
isDefault
boolean

Optional boolean filter that when set to true returns only the destinations marked as default for their respective networks. Default destinations are used as primary payment addresses

​
isArchived
boolean

Optional boolean filter that when set to true returns only the destinations marked as archived. Default is false.

​
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", "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 payout destinations matching the search criteria, regardless of page size or number.

Example:

100

​
payoutDestinations
object[]
required

The list of payout destinations grouped by merchant and network

⌘I