Create Crypto Beneficiary
For each reciever, you need to create a beneficiary on the platform. We will return a beneficiaryId, which can be used to make transfers.
We will run an AML and Sanctions check on them once added into the platform.
Endpoint : POST https://api.zamplabs.com/api/v1/transfer/crypto/beneficiary
For Beneficiary Account Type Individual
Request Body
| Key | Value | Description | Optional | Condition |
|---|---|---|---|---|
| beneficiary_name | String | Full Name of the beneficiary in String format | N | NA |
| routing_code_type_1 | String | In case of crypto, it will be always "NETWORK" | N | NA |
| routing_code_value_1 | ETHEREUM, SOLANA, POL, BNB, BTC, TRX | The network on which the crypto currency is to be sent | N | NA |
| beneficiary_account_number | AlphaNumeric | Wallet Address of the beneficiary | N | NA |
| beneficiary_email | String | beneficiary email address | Y | NA |
| beneficiary_account_type | Individual | Type of the beneficiary | N | NA |
| beneficiary_wallet_custody_provider | ACROSS_PROTOCOL_BRIDGE, BINANCE, BINGX, BITFINEX, BITFLYER, BITFOREX, BITGET, BITMEX, BITSTAMP, BITTHUMB, BITTRUE, BITTREX, BITSO, BUENBIT, BYBIT, CIRCLE, COINBASE, COINBASE_PRO, COINEX, COINONE, CRYPTO.COM, FORTRESSTRUST, GATE.IO, GEMINI, HUOBI, INDODAX, KRAKEN, KUCOIN, LEDN, LEMON.ME, LIBERTEX, LUNO, MEXC, NEXO, NOONES, OKEX, OKX, PAYEER, POLONIEX, ROMA, SOCKET.TECH, STAKE.COM, UPBIT, VALR, OTHERS | Custody provider of beneficiary wallet Address | N | NA |
| beneficiary_wallet_custody_provider_name | String | Wallet custody provider name | N | beneficiary_wallet_custody_provider = OTHERS |
| beneficiary_address | String | Address line of the beneficiary | N | beneficiary_wallet_custody_provider = OTHERS |
| beneficiary_city | String | City which the beneficiary resides in | N | beneficiary_wallet_custody_provider = OTHERS |
| beneficiary_state | String | State which the beneficiary resides in | N | beneficiary_wallet_custody_provider = OTHERS |
| beneficiary_postcode | String | Post code of the address which the beneficiary resides in | N | beneficiary_wallet_custody_provider = OTHERS |
| beneficiary_country_code | ISO 3166 standard currency Code. (US) | Country which the beneficiary resides in | N | beneficiary_wallet_custody_provider = OTHERS |
| beneficiary_date_of_birth | String(yyyy-mm-dd) | beneficiary date of birth | N | beneficiary_wallet_custody_provider = OTHERS |
| beneficiary_document_type | NATIONAL_ID_CARD, PASSPORT, DRIVING_LICENSE | Beneficiary document type | N | beneficiary_wallet_custody_provider = OTHERS |
| beneficiary_document_id | AlphaNumeric | Beneficiary Document Number/Id | N | beneficiary_wallet_custody_provider = OTHERS |
Request JSON Representation
{
"beneficiary_name":"Test Beneficiary CRYPTO",
"routing_code_type_1":"NETWORK",
"routing_code_value_1": "ETHEREUM",
"beneficiary_account_number": "0xC648520b1bDDcEADA201cdfd95c582e5fE698F37",
"beneficiary_email":"[email protected]",
"beneficiary_account_type":"Individual",
"beneficiary_wallet_custody_provider":"BINANCE"
}
Request JSON Representation If beneficiary_wallet_custody_provider=OTHERS
{
"beneficiary_name":"Test Beneficiary CRYPTO",
"routing_code_type_1":"NETWORK",
"routing_code_value_1": "ETHEREUM",
"beneficiary_account_number": "0xC648520b1bDDcEADA201cdfd95c582e5fE698F37",
"beneficiary_email":"[email protected]",
"beneficiary_account_type":"Individual",
"beneficiary_wallet_custody_provider":"OTHERS",
"beneficiary_wallet_custody_provider_name":"MetaMask",
"beneficiary_address":"test",
"beneficiary_city":"test",
"beneficiary_state":"ohio",
"beneficiary_postcode":"43058",
"beneficiary_country_code":"US",
"beneficiary_date_of_birth":"1990-01-01",
"beneficiary_document_type":"NATIONAL_ID_CARD",
"beneficiary_document_id":"XX12121212"
}
For Beneficiary Account Type Corporate
Request Body
| Key | Value | Description | Optional | Condition |
|---|---|---|---|---|
| beneficiary_name | String | Full Name of the beneficiary in String format | N | NA |
| routing_code_type_1 | String | In case of crypto, it will be always "NETWORK" | N | NA |
| routing_code_value_1 | ETHEREUM, SOLANA, POL, BNB, BTC, TRX | The network on which the crypto currency is to be sent | N | NA |
| beneficiary_account_number | AlphaNumeric | Wallet Address of the beneficiary | N | NA |
| beneficiary_email | String | beneficiary email address | Y | NA |
| beneficiary_account_type | Corporate | Type of the beneficiary | N | NA |
| beneficiary_wallet_custody_provider | ACROSS_PROTOCOL_BRIDGE, BINANCE, BINGX, BITFINEX, BITFLYER, BITFOREX, BITGET, BITMEX, BITSTAMP, BITTHUMB, BITTRUE, BITTREX, BITSO, BUENBIT, BYBIT, CIRCLE, COINBASE, COINBASE_PRO, COINEX, COINONE, CRYPTO.COM, FORTRESSTRUST, GATE.IO, GEMINI, HUOBI, INDODAX, KRAKEN, KUCOIN, LEDN, LEMON.ME, LIBERTEX, LUNO, MEXC, NEXO, NOONES, OKEX, OKX, PAYEER, POLONIEX, ROMA, SOCKET.TECH, STAKE.COM, UPBIT, VALR, OTHERS | Custody provider of beneficiary wallet Address | N | NA |
| beneficiary_wallet_custody_provider_name | String | Wallet custody provider name | N | beneficiary_wallet_custody_provider = OTHERS |
| beneficiary_address | String | Address line of the beneficiary | N | beneficiary_wallet_custody_provider = OTHERS |
| beneficiary_city | String | City which the beneficiary resides in | N | beneficiary_wallet_custody_provider = OTHERS |
| beneficiary_state | String | State which the beneficiary resides in | N | beneficiary_wallet_custody_provider = OTHERS |
| beneficiary_postcode | String | Post code of the address which the beneficiary resides in | N | beneficiary_wallet_custody_provider = OTHERS |
| beneficiary_country_code | ISO 3166 standard currency Code. (US) | Country which the beneficiary resides in | N | beneficiary_wallet_custody_provider = OTHERS |
| beneficiary_date_of_incorporation | String(yyyy-mm-dd) | beneficiary date of incorporation | N | beneficiary_wallet_custody_provider = OTHERS |
| beneficiary_document_type | BUSINESS_IDENTIFICATION_NUMBER | Business Identification Number (Business EIN, Registration Number, Tax ID) | N | beneficiary_wallet_custody_provider = OTHERS |
| beneficiary_document_id | AlphaNumeric | Beneficiary Document Number/Id | N | beneficiary_wallet_custody_provider = OTHERS |
Request JSON Representation
{
"beneficiary_name":"Test Beneficiary CRYPTO",
"routing_code_type_1":"NETWORK",
"routing_code_value_1": "ETHEREUM",
"beneficiary_account_number": "0xC648520b1bDDcEADA201cdfd95c582e5fE698F37",
"beneficiary_email":"[email protected]",
"beneficiary_account_type":"Corporate",
"beneficiary_wallet_custody_provider":"CIRCLE"
}
Request JSON Representation If beneficiary_wallet_custody_provider=OTHERS
{
"beneficiary_name":"Test Beneficiary CRYPTO",
"routing_code_type_1":"NETWORK",
"routing_code_value_1": "ETHEREUM",
"beneficiary_account_number": "0xC648520b1bDDcEADA201cdfd95c582e5fE698F37",
"beneficiary_email":"[email protected]",
"beneficiary_account_type":"Corporate",
"beneficiary_wallet_custody_provider":"OTHERS",
"beneficiary_wallet_custody_provider_name":"MetaMask",
"beneficiary_address":"test",
"beneficiary_city":"test",
"beneficiary_state":"ohio",
"beneficiary_postcode":"43058",
"beneficiary_country_code":"US",
"beneficiary_date_of_incorporation":"1990-01-01",
"beneficiary_document_type":"BUSINESS_IDENTIFICATION_NUMBER",
"beneficiary_document_id":"XX12121212"
}
Response Body
| Key | Value | Description |
|---|---|---|
| beneficiary_id | merchant_jXHm4aJH4vUmgcT6bmYGwD_11_30 | This is the UUID with which merchant can uniquely identify a beneficiary on Zamp systems |
Response JSON Representation
{
"data": {
"beneficiary_id": "merchant_jXHm4aJH4vUmgcT6bmYGwD_11_30"
}
}
Errors
| HTTP Code | Error Response | Description |
|---|---|---|
| 400 | {"code":"INVALID_WALLET_ADDRESS","message":"Wallet address is invalid"} | The wallet address sent in the request is invalid. |
| 400 | {"code":"RISK_ANALYSIS_FAILED","message":"Wallet id was found risky"} | The risk analysis for the wallet address failed (AML check). |