Query Payees

GET

/api/v1/merchants/{merchantId}/payees

Get list of payees for a merchant

Request

Authorization

API Key

Add parameter in header

x-signature

Example:

x-signature: ********************

Path Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/api/v1/merchants//payees' \
--header 'x-app-id;' \
--header 'x-timestamp;' \
--header 'x-nonce;' \
--header 'x-request-id;' \
--header 'x-lang;' \
--header 'x-signature: <api-key>'

Responses

🟢200OK

application/json

Payees retrieved successfully

Bodyapplication/json

Example

{
    "success": true,
    "requestId": "string",
    "timestamp": "2019-08-24T14:15:22.123Z",
    "data": [
        {
            "payeeId": "string",
            "merchantId": "string",
            "type": "BANK_ACCOUNT",
            "label": "string",
            "details": {
                "countryCode": "string",
                "currency": "USDT",
                "accountName": "string",
                "accountNo": "string",
                "iban": "string",
                "beneficiaryAddress": "string",
                "beneficiaryBankName": "string",
                "beneficiaryBankCode": "string",
                "beneficiaryBankAddress": "string",
                "intermediaryBankName": "string",
                "intermediaryBankCode": "string",
                "intermediaryBankAddress": "string",
                "routingNumber": "string",
                "sortCode": "string",
                "supportedCurrencies": [
                    "USDT"
                ],
                "referenceCode": "string"
            },
            "status": "ACTIVE",
            "createdAt": "2019-08-24T14:15:22.123Z"
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠429Too Many Requests

Modified at 2026-01-28 01:40:44

Delete Payee

Get quote for depositing fiat