Generate Static Address

This endpoint allows you to generate a static address for a specific currency and network. The static address will be linked to a unique track_id, and if a callback_url is provided, your server will receive notifications for any payments made to the address. This enables you to track and receive transactions to the static address, regardless of the amount or timing.

Please note that static addresses with no transactions for six months will be revoked.

POST https://api.oxapay.com/v1/payment/static-address

Authentication

You must include the Merchant API Key in the request header to authenticate your access to the API.

Name	Type	Description
merchant_api_key*	string	Your merchant API Key for authentication and authorization.

Request Body

Name	Type	Description
network*	string	The blockchain network on which the static address should be created.
to_currency	string	The currency symbol of the cryptocurrency you want to convert to.
auto_withdrawal	decimal	1 indicates that the received currency will be sent to the address specified in your Address List on the Settings page and 0 indicates that the amount will be credited to your OxaPay balance.
callback_url	string	The URL where payment information will be sent. Use this to receive notifications about payments made to the static address.
email	string	Provide the payer's email address for reporting purposes.
order_id	string	Specify a unique order ID for reference in your system.
description	string	Provide order details or any additional information that will be shown in different reports.

200: OK

{
    "data": {
        "track_id": "string, // Unique identifier for each payment session in the OxaPay payment gateway. It can be used to query the payment status and generate reports.
        "network": string, // The blockchain network where the cryptocurrency payment is expected to be received (e.g., "Bitcoin Network").
        "address": string, // The generated cryptocurrency address where the payer should send the payment.
        "qr_code": string, // URL to a QR code image containing the cryptocurrency address and payment amount for easier transactions.
        "date": integer // Timestamp (UNIX epoch) indicating when the static payment address was created.
    }
    "message": string,  // A message containing additional information about the result of the request.
    "error": {
        "type": string, 
        "key": string, 
        "message": string 
    } || {}, // An object that provides details about any errors that occurred.
    "status": integer, // The status of the request response. Typically provided as a numeric code (e.g., 200 for success or other codes for errors).
    "version": string // The version of the API being used.
}

Please note that a successful request will return status 200. In case of any issues or validation problems, refer to the corresponding error for further details.

API Request Sample Codes

cURL

curl -X POST https://api.oxapay.com/v1/payment/static-address \
  -H "merchant_api_key: YOUR_MERCHANT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "network": "TRON",
    "to_currency": "USDT",
    "auto_withdrawal": false,
    "callback_url": "https://example.com/callback",
    "email": "[e-mail]",
    "order_id": "ORD-12345",
    "description": "Order #12345"
  }'

PHP

<?php

$url = 'https://api.oxapay.com/v1/payment/static-address';

$data = [
    "network" => "TRON",
    "to_currency" => "USDT",
    "auto_withdrawal" => false,
    "callback_url" => "https://example.com/callback",
    "email" => "[e-mail]",
    "order_id" => "ORD-12345",
    "description" => "Order #12345"
];

$headers = [
    'Content-Type: application/json',
    'merchant_api_key: YOUR_MERCHANT_API_KEY'
];

$options = array(
    'http' => array(
        'header'  => implode("\r\n", $headers),
        'method'  => 'POST',
        'content' => json_encode($data),
    ),
);

$context  = stream_context_create($options);
$response = file_get_contents($url, false, $context);
if ($response === FALSE) {
    die('Error occurred');
}
$result = json_decode($response, true);
var_dump($result);
?>

Node.js

const axios = require('axios');

const url = 'https://api.oxapay.com/v1/payment/static-address';

const data = {
    network: "TRON",
    to_currency: "USDT",
    auto_withdrawal: false,
    callback_url: "https://example.com/callback",
    email: "[e-mail]",
    order_id: "ORD-12345",
    description: "Order #12345"
};

const headers = {
  'merchant_api_key': `YOUR_MERCHANT_API_KEY`,
  'Content-Type': 'application/json',
};

axios.post(url, data, { headers })
  .then((response) => {
    console.log(response.data);
  })
  .catch((error) => {
    console.error(error);
  });

Python

import requests
import json

url = 'https://api.oxapay.com/v1/payment/static-address'

data = {
    "network": "TRON",
    "to_currency": "USDT",
    "auto_withdrawal": False,
    "callback_url": "https://example.com/callback",
    "email": "[e-mail]",
    "order_id": "ORD-12345",
    "description": "Order #12345"
}

headers = {
    'merchant_api_key': 'YOUR_MERCHANT_API_KEY',
    'Content-Type': 'application/json'
}

response = requests.post(url, data=json.dumps(data), headers=headers)
result = response.json()
print(result)

Please make sure to replace YOUR_MERCHANT_API_KEY in the code snippets with your actual merchant API Key.

These example code snippets demonstrate how to request the "Generate Static Address" endpoint using different programming languages. You can customize the data parameters according to your specific requirements.

API Response Example

{
    "data": {
        "track_id": "182796736",
        "network": "Tron Network",
        "address": "TX7U8wnnafXeXED3ChjeuiZFznL3BU1gX3",
        "qr_code": "https://api.qrserver.com/v1/create-qr-code/?data=tron:TX7U8wnnafXeXED3ChjeuiZFznL3BU1gX3&size=150x150",
        "date": 1734511347
    },
    "message": "Operation completed successfully!",
    "error": {},
    "status": 200,
    "version": "1.0.0"
}

The response example above is provided to help you understand the format and structure of the response. If you have any further questions or need assistance, please feel free to contact to your account manager.