Create Transfer

Create Transfer

Steps

  1. Merchant's backend sends request to Calculate Transfer API to get estimated fee information

  2. Merchant's backend sends request to Create Transfer API in order to execute transaction.

  3. Merchant gets callback of payment status changes and need to handle it accordingly.

Host URL

Calculate Transfer

Request :

Endpoint : /v1/merchant-transfers/calculate

HTTP Method : POST

Header :

Authorization: Basic ENCODED_KEY

ENCODED_KEY value is result of Base64Encode("apiKey"+":"+"secretKey")

Request JSON Body :

{
   "address": "TAUsbjxkQYJLi5MxS9NqnNXd7ZYnTqUbwj",
   "currencyCode": "TRX",
   "amount": 1000
}

Fee Calculation:

Transfer Fee = 0.3 * Transfer Amount

Example :

Transfer Amount : 5 ETH

Received Amount : 5 ETH

Reduced Balance : 1.3 * 5 ETH = 6.5 ETH

Note : Merchant is able to custom transfer fee by contact Our Support

Request JSON Body Details :

ParameterRequiredTypeDescription

address

required

string

Destination address that we will send for transfer

currencyCode

required

string

Cryptocurrency code you want to transfer

amount

required

double

The amount of currency you want to transfer

Response :

Sample Success Response :

HTTP Status Code : 200

{
  "data": {
    "currencyCode": "TRX",
    "fee": 16.7,
    "receivedAmount": 10,
    "totalAmount": 26.7
  },
  "meta": {
    "message": "Successfully calculate transfer",
    "statusCode": 200
  }
}

Response JSON Body Details :

PropertyDescriptions

currencyCode

cryptocurrency code

fee

transaction fee

receivedAmount

the amount you will get

totalAmount

the amount that reduces your balance

Create Transfer

Request :

Endpoint : /v1/merchant-transfers/create

HTTP Method : POST

Header :

Authorization: Basic ENCODED_KEY

ENCODED_KEY value is result of Base64Encode("apiKey"+":"+"secretKey")

Request JSON Body :

{
    "externalId": "ECOMM_00123456",
    "address": "TAUsbjxkQYJLi5MxS9NqnNXd7ZYnTqUbwj",
    "currencyCode": "USDT"
    "amount": 1000,
}

Request JSON Body Details :

ParameterRequiredTypeDescription

externalId

required

string

Unique Identifier for your transfer

address

required

string

Destination address that we will send for withdrawal

currencyCode

required

string

Cryptocurrency code you want to transfer

amount

required

double

The amount of currency you want to transfer

Last updated