Create Deposit Order

Create OTC Recharge Order

curl --request POST \
  --url https://openplatform.gateapi.io/payment/open/otc/api/recharge \
  --header 'Content-Type: application/json' \
  --header 'X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>' \
  --header 'X-GatePay-Nonce: <x-gatepay-nonce>' \
  --header 'X-GatePay-Signature: <x-gatepay-signature>' \
  --header 'X-GatePay-Timestamp: <x-gatepay-timestamp>' \
  --data '
{
  "quoteToken": "qt_01JXYZABCDEF",
  "bankId": "ba_123456789",
  "currency": "USDT",
  "amount": "1088.42",
  "fiatCurrency": "USD",
  "fiatAmount": "1000"
}
'

import requests

url = "https://openplatform.gateapi.io/payment/open/otc/api/recharge"

payload = {
    "quoteToken": "qt_01JXYZABCDEF",
    "bankId": "ba_123456789",
    "currency": "USDT",
    "amount": "1088.42",
    "fiatCurrency": "USD",
    "fiatAmount": "1000"
}
headers = {
    "X-GatePay-Certificate-ClientId": "<x-gatepay-certificate-clientid>",
    "X-GatePay-Signature": "<x-gatepay-signature>",
    "X-GatePay-Timestamp": "<x-gatepay-timestamp>",
    "X-GatePay-Nonce": "<x-gatepay-nonce>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-GatePay-Certificate-ClientId': '<x-gatepay-certificate-clientid>',
    'X-GatePay-Signature': '<x-gatepay-signature>',
    'X-GatePay-Timestamp': '<x-gatepay-timestamp>',
    'X-GatePay-Nonce': '<x-gatepay-nonce>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    quoteToken: 'qt_01JXYZABCDEF',
    bankId: 'ba_123456789',
    currency: 'USDT',
    amount: '1088.42',
    fiatCurrency: 'USD',
    fiatAmount: '1000'
  })
};

fetch('https://openplatform.gateapi.io/payment/open/otc/api/recharge', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://openplatform.gateapi.io/payment/open/otc/api/recharge",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'quoteToken' => 'qt_01JXYZABCDEF',
    'bankId' => 'ba_123456789',
    'currency' => 'USDT',
    'amount' => '1088.42',
    'fiatCurrency' => 'USD',
    'fiatAmount' => '1000'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>",
    "X-GatePay-Nonce: <x-gatepay-nonce>",
    "X-GatePay-Signature: <x-gatepay-signature>",
    "X-GatePay-Timestamp: <x-gatepay-timestamp>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.post("https://openplatform.gateapi.io/payment/open/otc/api/recharge")
  .header("X-GatePay-Certificate-ClientId", "<x-gatepay-certificate-clientid>")
  .header("X-GatePay-Signature", "<x-gatepay-signature>")
  .header("X-GatePay-Timestamp", "<x-gatepay-timestamp>")
  .header("X-GatePay-Nonce", "<x-gatepay-nonce>")
  .header("Content-Type", "application/json")
  .body("{\n  \"quoteToken\": \"qt_01JXYZABCDEF\",\n  \"bankId\": \"ba_123456789\",\n  \"currency\": \"USDT\",\n  \"amount\": \"1088.42\",\n  \"fiatCurrency\": \"USD\",\n  \"fiatAmount\": \"1000\"\n}")
  .asString();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://openplatform.gateapi.io/payment/open/otc/api/recharge"

	payload := strings.NewReader("{\n  \"quoteToken\": \"qt_01JXYZABCDEF\",\n  \"bankId\": \"ba_123456789\",\n  \"currency\": \"USDT\",\n  \"amount\": \"1088.42\",\n  \"fiatCurrency\": \"USD\",\n  \"fiatAmount\": \"1000\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-GatePay-Certificate-ClientId", "<x-gatepay-certificate-clientid>")
	req.Header.Add("X-GatePay-Signature", "<x-gatepay-signature>")
	req.Header.Add("X-GatePay-Timestamp", "<x-gatepay-timestamp>")
	req.Header.Add("X-GatePay-Nonce", "<x-gatepay-nonce>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://openplatform.gateapi.io/payment/open/otc/api/recharge")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-GatePay-Certificate-ClientId"] = '<x-gatepay-certificate-clientid>'
request["X-GatePay-Signature"] = '<x-gatepay-signature>'
request["X-GatePay-Timestamp"] = '<x-gatepay-timestamp>'
request["X-GatePay-Nonce"] = '<x-gatepay-nonce>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"quoteToken\": \"qt_01JXYZABCDEF\",\n  \"bankId\": \"ba_123456789\",\n  \"currency\": \"USDT\",\n  \"amount\": \"1088.42\",\n  \"fiatCurrency\": \"USD\",\n  \"fiatAmount\": \"1000\"\n}"

response = http.request(request)
puts response.read_body

{
  "code": "<string>",
  "status": "<string>",
  "errorMessage": "<string>",
  "data": {
    "orderId": "<string>",
    "otcOrderId": "<string>",
    "currency": "<string>",
    "amount": "<string>",
    "fiatCurrency": "<string>",
    "fiatAmount": "<string>",
    "cfRate": "<string>",
    "bankId": "<string>",
    "bankNumber": "<string>",
    "paid": true,
    "status": "<string>",
    "card_info": {
      "id": 123,
      "uid": 123,
      "entity": "<string>",
      "bank_account_name": "<string>",
      "bank_name": "<string>",
      "bank_country": "<string>",
      "bank_address": "<string>",
      "bank_code": "<string>",
      "branch_code": "<string>",
      "iban": "<string>",
      "swift": "<string>",
      "remittance_line_number": "<string>",
      "agent_bank_name": "<string>",
      "agent_bank_swift": "<string>",
      "transferRemark": "<string>",
      "memo": "<string>",
      "is_default": true,
      "bank_id": "<string>"
    },
    "createTime": 123,
    "promoCode": "<string>",
    "transferRemark": "<string>"
  }
}

POST

payment

open

otc

api

recharge

Create OTC Recharge Order

curl --request POST \
  --url https://openplatform.gateapi.io/payment/open/otc/api/recharge \
  --header 'Content-Type: application/json' \
  --header 'X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>' \
  --header 'X-GatePay-Nonce: <x-gatepay-nonce>' \
  --header 'X-GatePay-Signature: <x-gatepay-signature>' \
  --header 'X-GatePay-Timestamp: <x-gatepay-timestamp>' \
  --data '
{
  "quoteToken": "qt_01JXYZABCDEF",
  "bankId": "ba_123456789",
  "currency": "USDT",
  "amount": "1088.42",
  "fiatCurrency": "USD",
  "fiatAmount": "1000"
}
'

import requests

url = "https://openplatform.gateapi.io/payment/open/otc/api/recharge"

payload = {
    "quoteToken": "qt_01JXYZABCDEF",
    "bankId": "ba_123456789",
    "currency": "USDT",
    "amount": "1088.42",
    "fiatCurrency": "USD",
    "fiatAmount": "1000"
}
headers = {
    "X-GatePay-Certificate-ClientId": "<x-gatepay-certificate-clientid>",
    "X-GatePay-Signature": "<x-gatepay-signature>",
    "X-GatePay-Timestamp": "<x-gatepay-timestamp>",
    "X-GatePay-Nonce": "<x-gatepay-nonce>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-GatePay-Certificate-ClientId': '<x-gatepay-certificate-clientid>',
    'X-GatePay-Signature': '<x-gatepay-signature>',
    'X-GatePay-Timestamp': '<x-gatepay-timestamp>',
    'X-GatePay-Nonce': '<x-gatepay-nonce>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    quoteToken: 'qt_01JXYZABCDEF',
    bankId: 'ba_123456789',
    currency: 'USDT',
    amount: '1088.42',
    fiatCurrency: 'USD',
    fiatAmount: '1000'
  })
};

fetch('https://openplatform.gateapi.io/payment/open/otc/api/recharge', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://openplatform.gateapi.io/payment/open/otc/api/recharge",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'quoteToken' => 'qt_01JXYZABCDEF',
    'bankId' => 'ba_123456789',
    'currency' => 'USDT',
    'amount' => '1088.42',
    'fiatCurrency' => 'USD',
    'fiatAmount' => '1000'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>",
    "X-GatePay-Nonce: <x-gatepay-nonce>",
    "X-GatePay-Signature: <x-gatepay-signature>",
    "X-GatePay-Timestamp: <x-gatepay-timestamp>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.post("https://openplatform.gateapi.io/payment/open/otc/api/recharge")
  .header("X-GatePay-Certificate-ClientId", "<x-gatepay-certificate-clientid>")
  .header("X-GatePay-Signature", "<x-gatepay-signature>")
  .header("X-GatePay-Timestamp", "<x-gatepay-timestamp>")
  .header("X-GatePay-Nonce", "<x-gatepay-nonce>")
  .header("Content-Type", "application/json")
  .body("{\n  \"quoteToken\": \"qt_01JXYZABCDEF\",\n  \"bankId\": \"ba_123456789\",\n  \"currency\": \"USDT\",\n  \"amount\": \"1088.42\",\n  \"fiatCurrency\": \"USD\",\n  \"fiatAmount\": \"1000\"\n}")
  .asString();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://openplatform.gateapi.io/payment/open/otc/api/recharge"

	payload := strings.NewReader("{\n  \"quoteToken\": \"qt_01JXYZABCDEF\",\n  \"bankId\": \"ba_123456789\",\n  \"currency\": \"USDT\",\n  \"amount\": \"1088.42\",\n  \"fiatCurrency\": \"USD\",\n  \"fiatAmount\": \"1000\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-GatePay-Certificate-ClientId", "<x-gatepay-certificate-clientid>")
	req.Header.Add("X-GatePay-Signature", "<x-gatepay-signature>")
	req.Header.Add("X-GatePay-Timestamp", "<x-gatepay-timestamp>")
	req.Header.Add("X-GatePay-Nonce", "<x-gatepay-nonce>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://openplatform.gateapi.io/payment/open/otc/api/recharge")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-GatePay-Certificate-ClientId"] = '<x-gatepay-certificate-clientid>'
request["X-GatePay-Signature"] = '<x-gatepay-signature>'
request["X-GatePay-Timestamp"] = '<x-gatepay-timestamp>'
request["X-GatePay-Nonce"] = '<x-gatepay-nonce>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"quoteToken\": \"qt_01JXYZABCDEF\",\n  \"bankId\": \"ba_123456789\",\n  \"currency\": \"USDT\",\n  \"amount\": \"1088.42\",\n  \"fiatCurrency\": \"USD\",\n  \"fiatAmount\": \"1000\"\n}"

response = http.request(request)
puts response.read_body

{
  "code": "<string>",
  "status": "<string>",
  "errorMessage": "<string>",
  "data": {
    "orderId": "<string>",
    "otcOrderId": "<string>",
    "currency": "<string>",
    "amount": "<string>",
    "fiatCurrency": "<string>",
    "fiatAmount": "<string>",
    "cfRate": "<string>",
    "bankId": "<string>",
    "bankNumber": "<string>",
    "paid": true,
    "status": "<string>",
    "card_info": {
      "id": 123,
      "uid": 123,
      "entity": "<string>",
      "bank_account_name": "<string>",
      "bank_name": "<string>",
      "bank_country": "<string>",
      "bank_address": "<string>",
      "bank_code": "<string>",
      "branch_code": "<string>",
      "iban": "<string>",
      "swift": "<string>",
      "remittance_line_number": "<string>",
      "agent_bank_name": "<string>",
      "agent_bank_swift": "<string>",
      "transferRemark": "<string>",
      "memo": "<string>",
      "is_default": true,
      "bank_id": "<string>"
    },
    "createTime": 123,
    "promoCode": "<string>",
    "transferRemark": "<string>"
  }
}

Overview

This page documents the POST /payment/open/otc/api/recharge endpoint. The full schema, parameters, and examples are rendered from the linked OpenAPI definition above.

Notes

Authentication uses the standard GatePay signed headers.
This page documents the standard merchant endpoint.
For shared signing rules, see /api-reference/version/100/en/common/securityAndSignature.

Usage Guidance

Call this endpoint only after a valid OTC quote has been obtained.
Persist orderId for later reconciliation.
The returned bank information should be treated as settlement instructions and stored together with the order snapshot.
Do not treat order creation itself as payment completion. The actual fiat remittance and confirmation step still need to happen.
Institutional Sub-accounts: To implement OTC deposits for institutional sub-accounts, institutional sub-account KYB certification must be completed first. For details, see: Get Certification URL.

Headers

X-GatePay-Certificate-ClientId

string

required

Merchant application client ID used to identify the calling app.

X-GatePay-Signature

string

required

HMAC signature generated from the request according to GatePay signing rules.

X-GatePay-Timestamp

string

required

Millisecond timestamp; the difference from server time must not exceed 30 seconds.

X-GatePay-Nonce

string

required

Random nonce used together with the timestamp to prevent replay attacks.

X-GatePay-On-Behalf-Of

string

Institutional sub-account UID. Only required when an institution submits a request on behalf of a sub-account; not required for direct merchant requests.

Body

application/json

quoteToken

string

required

Quote token returned by the quote API.

bankId

string

required

Merchant bank ID used for remittance.

currency

string

required

Cryptocurrency to receive. Currently supported: USDT, USDC.

amount

string

required

Cryptocurrency amount to be credited.

fiatCurrency

string

required

Fiat currency to remit. Currently supported: USD.

fiatAmount

string

required

Fiat amount to be paid.

Optional promotion code.

Response

200 - application/json

Success

code

string

Business response code.

status

string

Top-level request status.

errorMessage

string

Error message when the request fails.

data

object

Show child attributes

⌘I

Common

Balance

Institution

Payment

OTC

Convert

Payout

Gift Card

Subscription

Reconciliation

Notifications

Overview

Notes

Usage Guidance

Headers

Body

Response

​Overview

​Notes

​Usage Guidance

Headers

Body

Response

Overview

Notes

Usage Guidance