---
title: "POST /payment/white-label"
method: POST
path: "/payment/white-label"
tags: ["White-label"]
---

# POST /payment/white-label

`POST /payment/white-label`

## Headers

- `merchant_api_key` string, required
- `Content-Type` string, required

## Request body

- object
  - `pay_currency` string, required — 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.
  - `amount` number, required — 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.
  - `currency` string — Specify the currency symbol if you want the invoice amount calculated with a specific currency. You can also generate invoices in fiat currencies.
  - `network` string — The blockchain network on which the payment should be created. If not specified, the default network will be used.
  - `lifetime` integer — Set the expiration time for the payment link in minutes.
  - `fee_paid_by_payer` number — 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.
  - `under_paid_coverage` number — Specify the acceptable inaccuracy in payment. Determines the maximum acceptable difference between the requested and paid amount.
  - `to_currency` string — The currency symbol of the cryptocurrency you want to convert to. You can only convert paid crypto currencies to USDT.
  - `auto_withdrawal` boolean — 1 indicates that the received currency will be sent to the address specified in your Address List on the Settings page and 0 indicates that the amount will be credited to your OxaPay balance.
  - `callback_url` string, uri — The URL where payment information will be sent. Use this to receive notifications about the payment status.
  - `email` string, email — Provide the payer's email address for reporting purposes.
  - `order_id` 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.

## Response `200`

Successful operation

- object
  - `data` object
    - `track_id` string — Unique identifier for the payment.
    - `amount` number — The amount of currency for the invoice.
    - `currency` string — The currency in which the amount is specified (e.g., 'usd').
    - `pay_amount` number — The amount to be paid in the payment currency (e.g., BTC value).
    - `pay_currency` string — The currency in which the payment is made (e.g., 'btc').
    - `network` string — The blockchain network being used (e.g., 'Bitcoin Network').
    - `address` string — The wallet address where the payment will be sent.
    - `memo` string — Additional memo, tag, or destination note required for some blockchain networks. Empty if not required.
    - `callback_url` string, uri — The URL to which payment status updates will be sent.
    - `description` string — A description for the invoice.
    - `email` string, email — The email address of the payer.
    - `fee_paid_by_payer` number — Indicates if the payer is responsible for paying the network fees (1 = yes, 0 = no).
    - `lifetime` integer — The lifetime of the invoice in minutes before it expires.
    - `order_id` string — A unique identifier for the order associated with this invoice.
    - `under_paid_coverage` number — The percentage of underpayment that will still be considered valid.
    - `rate` number — The exchange rate between the base currency and the payment currency.
    - `qr_code` string, uri — URL to a QR code representing the payment address and amount.
    - `expired_at` integer — Timestamp (UNIX epoch) when the invoice will expire.
    - `date` integer — Timestamp (UNIX epoch) of when the invoice was created.
  - `message` string — A message containing additional information about the result of the request.
  - `error` object, nullable — An object that provides details about any errors that occurred.
    - `type` string — Type of the error
    - `key` string — Key related to the error
    - `message` string — Error message
  - `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.

## Other responses

- `400` — Bad request

---

[API](https://skmtc.dev/oxapay/apis/payments.md) · [All operations](https://skmtc.dev/oxapay/apis/payments/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/oxapay/payments/revisions/19b6abc20c8d/schema)