Create Static Address

Create Static Collection Address

curl --request POST \
  --url https://openplatform.gateapi.io/payment/open/institution/v1/pay/fixedaddress/save \
  --header 'Content-Type: application/json' \
  --header 'X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>' \
  --header 'X-GatePay-Nonce: <x-gatepay-nonce>' \
  --header 'X-GatePay-On-Behalf-Of: <x-gatepay-on-behalf-of>' \
  --header 'X-GatePay-Signature: <x-gatepay-signature>' \
  --header 'X-GatePay-Timestamp: <x-gatepay-timestamp>' \
  --data '
{
  "channelId": "smart_shop",
  "chain": "ETH",
  "currencies": "USDS,USDT",
  "callbackUrl": "https://www.abc.com/callback"
}
'

import requests

url = "https://openplatform.gateapi.io/payment/open/institution/v1/pay/fixedaddress/save"

payload = {
    "channelId": "smart_shop",
    "chain": "ETH",
    "currencies": "USDS,USDT",
    "callbackUrl": "https://www.abc.com/callback"
}
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>",
    "X-GatePay-On-Behalf-Of": "<x-gatepay-on-behalf-of>",
    "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>',
    'X-GatePay-On-Behalf-Of': '<x-gatepay-on-behalf-of>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    channelId: 'smart_shop',
    chain: 'ETH',
    currencies: 'USDS,USDT',
    callbackUrl: 'https://www.abc.com/callback'
  })
};

fetch('https://openplatform.gateapi.io/payment/open/institution/v1/pay/fixedaddress/save', 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/institution/v1/pay/fixedaddress/save",
  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([
    'channelId' => 'smart_shop',
    'chain' => 'ETH',
    'currencies' => 'USDS,USDT',
    'callbackUrl' => 'https://www.abc.com/callback'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>",
    "X-GatePay-Nonce: <x-gatepay-nonce>",
    "X-GatePay-On-Behalf-Of: <x-gatepay-on-behalf-of>",
    "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/institution/v1/pay/fixedaddress/save")
  .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("X-GatePay-On-Behalf-Of", "<x-gatepay-on-behalf-of>")
  .header("Content-Type", "application/json")
  .body("{\n  \"channelId\": \"smart_shop\",\n  \"chain\": \"ETH\",\n  \"currencies\": \"USDS,USDT\",\n  \"callbackUrl\": \"https://www.abc.com/callback\"\n}")
  .asString();

package main

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

func main() {

	url := "https://openplatform.gateapi.io/payment/open/institution/v1/pay/fixedaddress/save"

	payload := strings.NewReader("{\n  \"channelId\": \"smart_shop\",\n  \"chain\": \"ETH\",\n  \"currencies\": \"USDS,USDT\",\n  \"callbackUrl\": \"https://www.abc.com/callback\"\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("X-GatePay-On-Behalf-Of", "<x-gatepay-on-behalf-of>")
	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/institution/v1/pay/fixedaddress/save")

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["X-GatePay-On-Behalf-Of"] = '<x-gatepay-on-behalf-of>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"channelId\": \"smart_shop\",\n  \"chain\": \"ETH\",\n  \"currencies\": \"USDS,USDT\",\n  \"callbackUrl\": \"https://www.abc.com/callback\"\n}"

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

{
  "status": "SUCCESS",
  "code": "000000",
  "errorMessage": "",
  "data": {
    "channelId": "smart_shop",
    "chain": "ETH",
    "address": "0x2EBa11a702F1d53c6e2F08278819e26E6e4a63ae",
    "currencies": [
      "USDS",
      "USDT"
    ],
    "callbackUrl": "https://www.abc.com/callback",
    "is_permanent": -1,
    "expire": false
  }
}

POST

payment

open

institution

pay

fixedaddress

save

Create Static Collection Address

curl --request POST \
  --url https://openplatform.gateapi.io/payment/open/institution/v1/pay/fixedaddress/save \
  --header 'Content-Type: application/json' \
  --header 'X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>' \
  --header 'X-GatePay-Nonce: <x-gatepay-nonce>' \
  --header 'X-GatePay-On-Behalf-Of: <x-gatepay-on-behalf-of>' \
  --header 'X-GatePay-Signature: <x-gatepay-signature>' \
  --header 'X-GatePay-Timestamp: <x-gatepay-timestamp>' \
  --data '
{
  "channelId": "smart_shop",
  "chain": "ETH",
  "currencies": "USDS,USDT",
  "callbackUrl": "https://www.abc.com/callback"
}
'

import requests

url = "https://openplatform.gateapi.io/payment/open/institution/v1/pay/fixedaddress/save"

payload = {
    "channelId": "smart_shop",
    "chain": "ETH",
    "currencies": "USDS,USDT",
    "callbackUrl": "https://www.abc.com/callback"
}
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>",
    "X-GatePay-On-Behalf-Of": "<x-gatepay-on-behalf-of>",
    "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>',
    'X-GatePay-On-Behalf-Of': '<x-gatepay-on-behalf-of>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    channelId: 'smart_shop',
    chain: 'ETH',
    currencies: 'USDS,USDT',
    callbackUrl: 'https://www.abc.com/callback'
  })
};

fetch('https://openplatform.gateapi.io/payment/open/institution/v1/pay/fixedaddress/save', 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/institution/v1/pay/fixedaddress/save",
  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([
    'channelId' => 'smart_shop',
    'chain' => 'ETH',
    'currencies' => 'USDS,USDT',
    'callbackUrl' => 'https://www.abc.com/callback'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>",
    "X-GatePay-Nonce: <x-gatepay-nonce>",
    "X-GatePay-On-Behalf-Of: <x-gatepay-on-behalf-of>",
    "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/institution/v1/pay/fixedaddress/save")
  .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("X-GatePay-On-Behalf-Of", "<x-gatepay-on-behalf-of>")
  .header("Content-Type", "application/json")
  .body("{\n  \"channelId\": \"smart_shop\",\n  \"chain\": \"ETH\",\n  \"currencies\": \"USDS,USDT\",\n  \"callbackUrl\": \"https://www.abc.com/callback\"\n}")
  .asString();

package main

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

func main() {

	url := "https://openplatform.gateapi.io/payment/open/institution/v1/pay/fixedaddress/save"

	payload := strings.NewReader("{\n  \"channelId\": \"smart_shop\",\n  \"chain\": \"ETH\",\n  \"currencies\": \"USDS,USDT\",\n  \"callbackUrl\": \"https://www.abc.com/callback\"\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("X-GatePay-On-Behalf-Of", "<x-gatepay-on-behalf-of>")
	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/institution/v1/pay/fixedaddress/save")

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["X-GatePay-On-Behalf-Of"] = '<x-gatepay-on-behalf-of>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"channelId\": \"smart_shop\",\n  \"chain\": \"ETH\",\n  \"currencies\": \"USDS,USDT\",\n  \"callbackUrl\": \"https://www.abc.com/callback\"\n}"

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

{
  "status": "SUCCESS",
  "code": "000000",
  "errorMessage": "",
  "data": {
    "channelId": "smart_shop",
    "chain": "ETH",
    "address": "0x2EBa11a702F1d53c6e2F08278819e26E6e4a63ae",
    "currencies": [
      "USDS",
      "USDT"
    ],
    "callbackUrl": "https://www.abc.com/callback",
    "is_permanent": -1,
    "expire": false
  }
}

Overview

This page documents the POST /payment/open/institution/v1/pay/fixedaddress/save endpoint. The full schema, parameters, and examples are rendered from the linked OpenAPI definition above. Generates a static collection address based on the specified currency and network.

Notes

If a static collection address already exists for channelId + chain, the currencies and callbackUrl in the request update the existing bound information.
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.

Headers

X-GatePay-Certificate-ClientId

string

required

The clientId assigned when the merchant registers an application in the Gate merchant console.

Example:

"4186d0c6-6a35-55a9-8dc6-5312769dbff8"

X-GatePay-Signature

string

required

Request signature. GatePay uses this signature to verify whether the request is valid.

X-GatePay-Timestamp

string

required

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

Example:

"1672905655498"

X-GatePay-Nonce

string

required

Random string. Must comply with HTTP header rules; recommended length is within 32 characters, composed of digits and letters.

Example:

"9578"

X-GatePay-On-Behalf-Of

string

required

Required delegated-subject header. Provide the initiating account ID for this request. For institution merchant APIs, this is typically the target sub-account ID; for institution charge and transfer APIs, it can be either an institution account ID or a sub-account ID.

Body

application/json

channelId

string

required

Merchant channel ID, supports only letters, numbers, underscores, and hyphens, with a maximum length of 50 bytes

chain

string

required

Network name

currencies

string

required

Currencies to be earned at this static address, separated by commas (e.g., USDT,BTC)

callbackUrl

string

required

Callback URL for this channel, with a maximum length of 128 bytes

Response

200 - application/json

Successful response

status

enum<string>

Response result, SUCCESS or FAIL

Available options:

SUCCESS,

FAIL

Example:

"SUCCESS"

code

string

Response error code

errorMessage

string

Error description

data

object

Show child attributes

⌘I

Common

Balance

Institution

Payment

OTC

Convert

Payout

Gift Card

Subscription

Reconciliation

Notifications

Overview

Notes

Headers

Body

Response

​Overview

​Notes

Headers

Body

Response

Overview

Notes