Create Deposit Invoice with Travel Rule

post

https://api.getorbital.io/crypto/deposit/invoice

This endpoint allows creating a deposit invoice with Travel Rule compliance.

Body Params

externalId

string

required

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

currency

string

The cryptocurrency to be transferred by the payer.

Accepted: USDT, USDC, ETH, BTC, LTC, BCH.

mainCurrency

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.

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.

notifyUrl

string

Merchant webhook URL to receive payment notifications.

firstName

string

required

length ≤ 100

Payer's first name.

lastName

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.

dateOfBirth

string

required

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

string

Payer's email address.

streetName

string

required

length ≤ 70

Street name of the payer's address.

buildingNumber

string

required

length ≤ 16

Building number of the payer's address.

townName

string

length ≤ 35

Town of the payer's address.

postcode

string

length ≤ 16

Postal code of the payer's address.

countryOfResidence

string

required

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

identificationType

string

enum

required

The type of identification used for the payer.

Allowed:

placeOfBirth

string

length ≤ 70

Payer's place of birth.

Required if identificationType is placeOfBirth.

documentNumber

string

length ≤ 35

Identification document number.

Required if identificationType is nationalRegistration.

documentType

string

enum

Identification document.

Required if identificationType is nationalRegistration.

documentCountryOfIssue

string

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

Required if identificationType is nationalRegistration.

customerId

string

length ≤ 50

The internal ID for the payer.

Required if identificationType is nationalRegistration

personType

string

Defaults to naturalPerson

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

Responses

200Successful invoice creation with Travel Rule compliance.

400Validation error - missing or invalid request parameters.

401Unauthorized – API key is missing or invalid.

500Internal server error. This can be caused by duplicate externalId, missing account permissions , or unexpected server-side issues.