Accepted Currencies

The endpoint retrieves the list of cryptocurrencies available for payment processing through OxaPay. These currencies are configured by you on the "Merchant Service" page of your account, specifying the cryptocurrencies your business accepts for payments.

GET https://api.oxapay.com/v1/payment/accepted-currencies

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.

200: OK

{
    "data": {
        "list": string[] // An array containing the cryptocurrency symbols that are accepted for payments.
    },
    "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/accepted-currencies \
  -H "merchant_api_key: YOUR_MERCHANT_API_KEY" \
  -H "Content-Type: application/json" \

PHP

<?php

$url = 'https://api.oxapay.com/v1/payment/accepted-currencies';

$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/accepted-currencies';

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

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

Python

import requests
import json

url = 'https://api.oxapay.com/v1/payment/accepted-currencies'

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

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

API Response Example

{
    "data": {
        "list": [
            "BTC",
            "ETH",
            "USDT",
            "USDC",
            "BNB",
            "DOGE",
        ]
    },
    "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.