Query Collection Instruments

GET

/api/v1/merchants/{merchantId}/collection-instruments

Get list of available collection instruments (bank accounts and crypto addresses) for a merchant

Request

Authorization

API Key

Add parameter in header

x-signature

Example:

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

Path Params

Query Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/api/v1/merchants/2512201641474120003995/collection-instruments?type=CRYPTO_ADDRESS&bankAccountType=undefined&currency=undefined&network=undefined&assetCode=undefined' \
--header 'x-app-id: mock_app_id' \
--header 'x-timestamp: 2053435344' \
--header 'x-nonce: 205343534445345' \
--header 'x-request-id: 53453464543' \
--header 'x-lang: en' \
--header 'x-signature: <api-key>'

Responses

🟢200OK

application/json

Collection instruments retrieved successfully

Bodyapplication/json

Example

{
    "success": true,
    "requestId": "string",
    "timestamp": "2019-08-24T14:15:22.123Z",
    "data": {
        "instruments": [
            {
                "merchantId": "string",
                "type": "BANK_ACCOUNT",
                "bankAccountType": "MASTER",
                "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"
                },
                "instrumentId": "inst_12345",
                "status": "ACTIVE",
                "limits": {
                    "minAmount": "string",
                    "maxAmount": "string",
                    "dailyLimit": "string"
                }
            }
        ]
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠429Too Many Requests

Modified at 2026-01-29 06:27:27

Page Query Merchant Addresses

Add Payee