API Reference

Lists all payout destinations configured for the entity associated with the API key. The request must include a valid API key with appropriate permissions. Returns a list of payout destinations that can be filtered by various parameters. This endpoint is useful for managing multiple payout destinations and verifying their configurations across different networks

Log in to see full request history
Query Params
string

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

string

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

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

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

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

double

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

double

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

string

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

string

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

Responses

Language
Credentials
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json