Static Wallets 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.

POST https://api.oxapay.com/merchants/list/staticaddress

Request Body

Name	Type	Description
merchant*	String	Your merchant API key for authentication and authorization.
trackId	integer	Filter payments by a specific invoice ID.
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.
network	string	Filter payments by the expected blockchain network for the specified crypto currency.
address	string	Filter payments by the expected address. It’s better to filter static addresses.
email	string	Filter payments by the email.
orderId	string	Filter payments by a unique order ID for reference.

200: OK

{
  "result": integer, // The result code indicates the success or failure of the request.
  "message": string, // A message providing additional information about the result.
  "data": [
    {
      "trackId": string, // The unique identifier of each payment session of the OxaPay payment gateway, which can be used to query the payment status and report requests (if the request is successful).
      "address": string, // The static address.
      "network": string, // The blockchain network associated with the cryptocurrency.
      "callbackUrl": string, // The URL where payment information will be sent. Use this to receive notifications about the payment status.
      "email": string, // The specified email
      "orderId": string, // The specified orderId
      "description": string, // Additional information or description related to the static address.
      "date": string // The timestamp of the static address generation in Unix time format.
    }
  ],
  "meta": {
    "size": integer, // The number of static addresses returned in the current page.
    "page": integer, // The current page number of the result set.
    "pages": 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.
  }
}

Please note that a successful request will return a result code 100. In case of any issues or validation problems, refer to the corresponding result codes for further details.

Example codes

cURL

curl -X POST https://api.oxapay.com/merchants/list/staticaddress \
  -d '{
    "merchant": "YOUR_MERCHANT_API_KEY",
    "size": 20,
    "page": 1
  }'

PHP

<?php

$url = 'https://api.oxapay.com/merchants/list/staticaddress';

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

$options = array(
    'http' => array(
        'header' => 'Content-Type: application/json',
        'method'  => 'POST',
        'content' => json_encode($data),
    ),
);

$context  = stream_context_create($options);
$response = file_get_contents($url, false, $context);
$result = json_decode($response);
var_dump($result);
?>

Node.js

const axios = require('axios');
const url = 'https://api.oxapay.com/merchants/list/staticaddress';
const data = JSON.stringify({
    merchant: 'YOUR_MERCHANT_API_KEY',
    size: 20,
    page: 1
});

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

Python

import requests
import json

url = 'https://api.oxapay.com/merchants/list/staticaddress'
data = {
  'merchant': 'YOUR_MERCHANT_API_KEY',
  'size': 20,
  'page': 1
}
response = requests.post(url, data=json.dumps(data))
result = response.json()
print(result)

Now you have the example code snippets in cURL, PHP, Node.js, and Python for making a request to the Static Wallets List endpoint.