v1

latestOpenAPI 3.0.02026-07-2323080.8 KB
Invoice

post/payment/invoice

Headers

merchant_api_keystring required

Your Merchant API Key for authentication and authorization.

Content-Typestring required

Request body

amountnumber 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.

currencystring

Specify the currency symbol if you want the invoice amount calculated with a specific currency. You can also generate invoices in fiat currencies.

lifetimeinteger

Set the expiration time for the payment link in minutes.

fee_paid_by_payernumber

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_coveragenumber

Specify the acceptable inaccuracy in payment. Determines the maximum acceptable difference between the requested and paid amount.

to_currencystring

The currency symbol of the cryptocurrency you want to convert to. You can only convert paid crypto currencies to USDT.

auto_withdrawalboolean

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.

mixed_paymentboolean

Specify whether the payer can cover the remaining amount with another currency if they pay less than the invoice amount. 1 allows the user to pay the remainder with a different coin, while 0 doesn't allow it.

callback_urlstring

The URL where payment information will be sent. Use this to receive notifications about the payment status.

return_urlstring

The URL where the payer will be redirected after a successful payment.

emailstring

Provide the payer's email address for reporting purposes.

order_idstring

Specify a unique order ID for reference in your system.

thanks_messagestring

A thanks message that brief note displayed to the payer after a successful payment.

descriptionstring

Provide order details or any additional information that will be shown in different reports.

sandboxboolean

The sandbox field is a boolean that specifies whether the API request should operate in sandbox mode (test environment). Set it to true for testing and false for live transactions.

Response

Successful operation

messagestring

A message containing additional information about the result of the request.

statusinteger

The status of the request response. Typically provided as a numeric code (e.g., 200 for success or other codes for errors).

versionstring

The version of the API being used.

All 23 operations