Generate Binance Pay HPP Deposit Link

post

https://hpp.getorbital.io/invoice/deposit

Generates a Hosted Payment Page (HPP) for Binance Pay deposits, enabling customers to make payments through a web interface.

Body Params

channel

string

required

Specifies the payment channel to display on the HPP. Set to binancepay to display only the Binance Pay QR code.

externalId

string

required

Unique ID for the transaction generated by the merchant. Each request requires a new externalId; reusing one is not allowed.

returnUrl

uri

The URL to which the payer will be redirected after the deposit is completed or cancelled.

notifyUrl

uri

Notification callback URL where the merchant will receive updates on the deposit status.

currency

string

enum

required

The cryptocurrency the payer uses to pay the invoice.

Accepted values: USDT or USDC.

Allowed:

sourceAmount

string

The amount of cryptocurrency being sent.

targetCurrency

string

The fiat currency in which the merchant will be credited.

Accepted: USD, GBP, EUR.

If targetCurrency is set, a crypto-fiat conversion occurs.
If omitted, no conversion occurs, and the deposit is made in the cryptocurrency specified in the currency field.

targetAmount

string

Amount in targetCurrency that the merchant will receive after conversion.

cashierCurrency

string

enum

The currency in which the payer's balance is displayed on the merchant platform.

cashierAmount

string

Amount in cashierCurrency that is reflected on the payer's balance in the merchant platform.

locale

string

enum

The default language for the Hosted Payment Page (HPP) user interface.

logoImage

uri

The merchant's logo image in PNG or SVG format.

productImage

uri

An image in JPG format representing the product or service to display on the deposit screen.

primaryColor

string

The primary button color for HPP customization, in HEX, RGB, or RGBA format.

secondaryColor

string

The secondary button color for HPP customization, in HEX, RGB, or RGBA format.

binanceId

string

Payer's Binance ID. Required if the Payment Payer Verification feature flag is enabled.

firstName

string

required

length ≤ 100

Payer's first name.

lastName

string

required

length ≤ 100

Payer's last name.

dateOfBirth

string

required

Payer's date of birth (YYYY-MM-DD).

postcode

string

length ≤ 16

Postal code of the payer's address.

townName

string

length ≤ 35

Town of the payer's address.

identificationType

string

enum

required

The four types of identification used for payer verification: personalDocument, placeOfBirth, fullAddress, and customerId.

Allowed:

placeOfBirth

string

length ≤ 70

Payer's place of birth.

Required if identificationType is placeOfBirth.

countryOfResidence

string

The country where the payer's resides (ISO-3166-1 alha-2).

Required if identificationType is fullAddress.

streetName

string

length ≤ 70

Street name of the payer's address.

Required if identificationType is fullAddress.

buildingNumber

string

length ≤ 16

Building number of the payer's address.

Required if identificationType is fullAddress.

documentNumber

string

length ≤ 35

Identification document number.

Required if identificationType is personalDocument.

documentType

string

enum

Identification document.

Required if identificationType is personalDocument.

documentCountryOfIssue

string

The country that issued the identification document (ISO-3166-1 alpha-2 code).

Required if identificationType is personalDocument.

customerId

string

length ≤ 50

The internal ID for the payer.

Required if identificationType is customerId.

personType

string

Defaults to naturalPerson

Indicates the type of payer. Can be naturalPerson or legalPerson. Defaults to naturalPerson if omitted.

format

string

Indicates if the response should be in JSON format and respond with only the URL.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Successful generation of the Hosted Payment Page. Returns HTML to redirect the user to the HPP.

400Validation error - missing or invalid request parameters.

401Unauthorized – Missing or invalid API key.