Static Address List

Use this endpoint to retrieve a list of static addresses associated with a specific business. The list can be filtered by various criteria, such as trackId, address, network, email and orderId. Pagination is also available to fetch the results in smaller sets.

GET 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 Params

Name	Type	Description
track_id	integer	Filter addresses by a specific ID.
network	string	Filter addresses by the expected blockchain network for the specified crypto currency.
currency	string	Filter addresses by the expected currency.
address	string	Filter static addresses by the expected address. It’s better to filter static addresses.
have_tx	boolean	Filter the addresses that had transactions.
order_id	string	Filter addresses by a unique order ID for reference.
email	string	Filter addresses by the email.
page	integer	The page number of the results you want to retrieve. Possible values: from 1 to the total number of pages - default 1.
size	integer	Number of records to display per page. Possible values: from 1 to 200. Default: 1.

200: OK

{
  "data": {
    "list":
      {
        "track_id": string, // Unique identifier for each payment session in the OxaPay payment gateway. It is used to track the payment status and generate reports.
        "address": string, // The static cryptocurrency address where the payment is expected to be sent.
        "network": string, // The blockchain network associated with the cryptocurrency (e.g., "Bitcoin Network").
        "callback_url": string, // The URL to which payment status updates will be sent. This allows you to receive notifications about the payment progress.
        "email": string, // The email address of the payer.
        "order_id": string, // A unique identifier for the order associated with this payment.
        "description": string, // Additional details or description related to the static address or transaction.
        "date": integer // Timestamp (UNIX epoch) indicating when the static address was generated.
      }[],
    "meta": {
      "page": integer, // The current page number of the result set.
      "last_page": integer, // The total number of pages available based on the number of records and page size.
      "total": integer // The total number of static addresses available for the specified criteria.
    },
  },
  "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 GET "https://api.oxapay.com/v1/payment/static-address?size=20&page=1" \
    -H "merchant_api_key: YOUR_MERCHANT_API_KEY" \
    -H "Content-Type: application/json"

PHP

<?php

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

$data = array(
    'size' => 20,
    'page' => 1
);

$query = http_build_query($data);
$url = $url . '?' . $query;

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

$options = array(
    'http' => array(
        'header'  => implode("\r\n", $headers),
        'method'  => 'GET'
    ),
);

$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 params = {
    size: 20,
    page: 1
};

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

axios.get(url, { params, 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'

params = {
  'size': 20,
  'page': 1
}

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

response = requests.get(url, params=params , 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 "Static Address List" endpoint using different programming languages. You can customize the data parameters according to your specific requirements.

API Response Example

{
    "data": {
        "list": [
            {
                "track_id": "133830568",
                "address": "0x71E204659d18cf1477eecFBaC9a20d2cebE184b4",
                "network": "Ethereum Network",
                "callback_url": "https://example.com/callback",
                "email": "[e-mail]",
                "order_id": "ORD-12345",
                "description": "Order #12345",
                "date": 1728032999
            },
            {
                "track_id": "123435847",
                "address": "TWYrqEVUpRer7sLLqshkF6HJnioL2VTJH3",
                "network": "Tron Network",
                "callback_url": "https://example.com/callback",
                "email": "[e-mail]",
                "order_id": "ORD-12345",
                "description": "Order #12345",
                "date": 1728140762
            }
         ],
        "meta": {
            "page": 1,
            "last_page": 2,
            "total": 4
        }
    },
    "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.