Generate Binance Pay HPP Deposit Link

post

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

📘
You can verify your payer's identity before creating creating a Binance Pay invoice

Body Params

Data fields for an Individual Payer associated with PPDL (Gibraltar), including data required for Travel Rule compliance for Binance Pay.

channel

string

required

externalId

string

required

returnUrl

uri

notifyUrl

uri

currency

string

enum

required

Allowed:

sourceAmount

string

targetCurrency

string

targetAmount

string

cashierCurrency

string

enum

cashierAmount

string

locale

string

enum

logoImage

uri

productImage

uri

primaryColor

string

secondaryColor

string

binanceId

string

firstName

string

required

length ≤ 100

lastName

string

required

length ≤ 100

dateOfBirth

string

required

postcode

string

length ≤ 16

townName

string

length ≤ 35

identificationType

string

enum

required

Allowed:

placeOfBirth

string

length ≤ 70

countryOfResidence

string

streetName

string

length ≤ 70

buildingNumber

string

length ≤ 16

documentNumber

string

length ≤ 35

documentType

string

enum

documentCountryOfIssue

string

customerId

string

length ≤ 50

personType

string

Defaults to naturalPerson

format

string

Headers

string

enum

Defaults to application/json

Allowed:

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/html

application/json

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.