Creating White-Label Payment

This endpoint allows you to create white-labeled payments, providing a seamless payment experience while utilizing the OxaPay payment gateway behind the scenes. Rather than generating an Invoice, this method provides detailed payment information, including the payment address, currency, amount, expiration time, and more.

To enhance flexibility and user convenience, you can utilize URI formats, such as the Bitcoin Improvement Proposal (BIP-0021). This format allows you to generate a payment link with the crypto address embedded within it. By using the generated URI link, the payer can initiate the payment directly from their preferred wallet application.

Furthermore, you have the option to generate QR codes that contain the URI link. QR codes are easily scannable by wallet applications, allowing the payer to effortlessly open their wallet app and proceed with the payment by simply scanning the QR code. The simplest way to create a QR code is to use Google Chart Service.

Using URI formats and QR codes simplifies the payment process for the payer, as they can quickly open their wallet application with the specified address and amount pre-filled. This user-friendly approach enhances the convenience and efficiency of the payment experience.

POST https://api.oxapay.com/merchants/request/whitelabel

Request Body

Name	Type	Description
merchant*	string	Your merchant API key for authentication and authorization.
email	string	Provide the payer's email address for reporting purposes.
orderId	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.
callbackUrl	string	The URL where payment information will be sent. Use this to receive notifications about the payment status.
underPaidCover	decimal	Specify the acceptable inaccuracy in payment. Determines the maximum acceptable difference between the requested and paid amount (0-60.00). Default: Merchant setting.
feePaidByPayer	decimal	Specify whether the payer will cover the invoice commission. 1 indicates that the payer will pay the fee, while 0 indicates that the merchant will pay the fee. Default: Merchant setting.
lifeTime	integer	Set the expiration time for the payment link in minutes (15-2880). Default: 60.
network	string	The blockchain network on which the payment should be created. If not specified, the default network will be used.
payCurrency*	string	Specify the currency symbol if you want the invoice to be paid in a specific currency. Defines the currency in which you wish to receive your settlements.
currency	string	Specify the currency symbol if you want the invoice amount calculated with a specific currency. You can also create invoices in fiat currencies.
amount*	long	The amount for the payment. If the currency field is not filled, the amount should be specified in dollars. If the currency field is filled, the amount should correspond to the specified currency.

200: OK

{
  "result": integer, // Request result. More information about this number can be found in the Result Code table.
  "message": string, // The message containing the result of the request.
  "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).
  "amount": long, // The requested payment amount.
  "currency": string, // The requested payment currency.
  "payAmount": long, // The actual payment amount.
  "payCurrency": string, // The actual payment currency.
  "network": string, // The blockchain network on which the cryptocurrency is expected to be received.
  "address": string, // The generated cryptocurrency address for the payment.
  "callbackUrl": string, // The specified callback to receive payment notifications
  "description": string, // The specified description
  "email": string, // The specified email
  "feePaidByPayer": decimal, // The specified feePaidByPayer
  "lifeTime": integer, // The specified lifeTime
  "orderId": string, // The specified orderId
  "underPaidCover": decimal, // The specified underPaidCover
  "rate": decimal, // The exchange rate of the specified cryptocurrency.
  "expiredAt": string, // The expiration time of payment to the address.
  "createdAt": string, // The created invoice time
  "QRCode": string // the QRCode image link for coin and amount
}

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/request/whitelabel \
  -d '{
    "merchant": "YOUR_MERCHANT_API_KEY",
    "amount": 100,
    "currency": "USD",
    "payCurrency": "TRX",
    "lifeTime": 90,
    "feePaidByPayer": 1,
    "underPaidCover": 10,
    "callbackUrl": "https://example.com/callback",
    "description": "Order #12345",
    "orderId": "12345",
    "email": "[e-mail]"
  }'

PHP

<?php

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

$data = array(
    'merchant' => 'YOUR_MERCHANT_API_KEY',
    'amount' => 100,
    'currency' => 'USD',
    'payCurrency' => 'TRX',
    'lifeTime' => 90,
    'feePaidByPayer' => 1,
    'underPaidCover' => 10,
    'callbackUrl' => 'https://example.com/callback',
    'description' => 'Order #12345',
    'orderId' => '12345',
    'email' => '[e-mail]'
);

$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/request/whitelabel';
const data = JSON.stringify({
    merchant: 'YOUR_MERCHANT_API_KEY',
    amount: 100,
    currency: 'USD',
    payCurrency: "TRX",
    lifeTime: 90,
    feePaidByPayer: 1,
    underPaidCover: 10,
    callbackUrl: 'https://example.com/callback',
    description: 'Order #12345',
    orderId: 'ORD-12345',
    email: '[e-mail]'
});

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/request/whitelabel'
data = {
    'merchant': 'YOUR_MERCHANT_API_KEY',
    'amount': 100,
    'currency': 'USD',
    'payCurrency': 'TRX',
    'lifeTime': 90,
    'feePaidByPayer': 1,
    'underPaidCover': 10,
    'callbackUrl': 'https://example.com/callback',
    'description': 'Order #12345',
    'orderId': '12345',
    'email': '[e-mail]'
}

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