Return to Orbital Homepage
API Documentation
Login to the Client Portal

Generate Deposit Link (HPP)

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

Use this endpoint to generate an Orbital-hosted Payment Page (HPP) link that you can share with your payer to complete a cryptocurrency deposit. The page handles wallet selection, deposit instructions, and QR code generation, you don’t need to build your own payment flow

Body Params

Data fields for an Individual Payer associated with Pay Perform OÜ (Estonia), including data required for Travel Rule compliance.

string
required

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

string
required

Merchant webhook URL to receive payment notifications.

string
required

URL to redirect payer after completing the deposit.

string
enum

The cryptocurrency to be transferred by the payer.

Allowed:
string
enum

Filters and displays only stablecoins (e.g., USDT, USDC). If omitted, all supported cryptocurrencies are shown.

Note: Do not use with the currency or mainCurrency field.

Allowed:
string

The blockchain network required for stablecoin deposits (USDT or USDC).

For e.g, if USDT is specified in the currency field and TON here, it signifies USDT on TON USDT-TON.

Allowed networks for USDT: TRX, ETH, MATIC, TON, BNB.

Allowed networks for USDC: SOL, ETH, MATIC, TRX, BNB.

string

The amount of cryptocurrency being sent.

string
enum

The fiat currency in which the merchant will be credited.

  • 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.
Allowed:
string

Amount in targetCurrency that the merchant will receive after conversion.

string
enum

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

string

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

string

Merchant's logo image in PNG or SVG format.

string

Product image in JPG format to display on the deposit screen.

string

Primary button color in HEX, RGB, or RGBA format.

string

Secondary button color in HEX, RGB, or RGBA format.

string

Optional refund wallet address provided by the payer.

string
enum

Default language for the user interface.

string
required
length ≤ 100

Payer's first name.

string
required
length ≤ 100

Payer's last name.

Note: For customers in countries where last names are not available, pass LNU (Last Name Unavailable) in this field.

string
required

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

string

Payer's email address.

string
required
length ≤ 70

Street name of the payer's address.

string
required
length ≤ 16

Building number of the payer's address.

string
length ≤ 35

Town of the payer's address.

string
length ≤ 16

Postal code of the payer's address.

string
required

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

string
enum
required

The type of identification used for the payer.

Allowed:
string
length ≤ 70

Payer's place of birth.

Required if identificationType is placeOfBirth.

string
length ≤ 35

Identification document number.

Required if identificationType is nationalRegistration.

string
enum

Identification document.

Required if identificationType is nationalRegistration.

string

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

Required if identificationType is nationalRegistration.

string
length ≤ 50

The internal ID for the payer.

string

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

string
Defaults to naturalPerson

Indicates the type of payer. Can be naturalPerson or legalPerson.

Responses

Updated 9 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 9 months ago