Payment History

Use this endpoint to retrieve a list of payments belonging to a specific business. You can apply filters to the list based on various criteria, such as time range, payment status, amount, payment method, and more. Additionally, you can paginate the results using the `page` and `size` parameters.

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

Request Body

Name	Type	Description
merchant*	string	Your merchant API key for authentication and authorization.
orderBy	string	Display the list in ascending or descending order. Possible values: 'asc', 'desc'. Default: 'desc'.
sortBy	string	Sort the received list by a parameter. Possible values: 'create_date', 'pay_date', 'amount'. Default: 'create_date'.
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: 10.
orderId	string	Filter payments by a unique order ID for reference.
status	string	Filter payments by status (e.g., "Paid", "Confirming").
feePaidByPayer	decimal	Filter payments based on whether the payer covers the invoice commission (1) or the merchant covers it (0).
type	string	Filter payments by type (e.g. "invoice", "white_label", "static_address").
network	string	Filter payments by the expected blockchain network for the specified crypto currency.
payCurrency	string	Filter payments by a specific crypto currency symbol in which the pay amount is specified.
currency	string	Filter payments by a specific currency symbol.
toAmount	float	Filter payments with amounts less than or equal to the specified value.
fromAmount	float	Filter payments with amounts greater than or equal to the specified value.
toDate	string	The end of the date window to query for invoices in unix format
fromDate	string	The start of the date window to query for invoices in unix format
address	string	Filter payments by the expected address. It’s better to filter static addresses.
txID	string	Filter the payment with your transaction hash

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": array, // An array containing the list of payment information if the request is successful.
  "meta": object // including size, page, pages, total.
}

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 \
  -d '{
    "merchant": "YOUR_MERCHANT_API_KEY",
    "fromDate": 1690848000,
    "toDate": 1691625600,
    "size": 20,
    "page": 1
  }'

PHP

<?php

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

$data = array(
    'merchant' => 'YOUR_MERCHANT_API_KEY',
    'fromDate' => 1690848000,
    'toDate' => 1691625600,
    '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';
const data = JSON.stringify({
    merchant: 'YOUR_MERCHANT_API_KEY',
    fromDate: 1690848000,
    toDate: 1691625600,
    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'
data = {
    'merchant': 'YOUR_MERCHANT_API_KEY',
    'fromDate': 1690848000,
    'toDate': 1691625600,
    '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 Payment History endpoint. Feel free to use these examples to integrate the OxaPay API into your application or website and retrieve payment information based on your specified criteria.