Skip to main content
POST
Create a direct payment invoice

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string
required
Maximum string length: 128

Body

application/json
amount
string
required

Deposit nominal in whole USD, minimum 10 USD or the issuer minimum; 10, 11, 12 and so on. The issuer deducts 1% of this nominal. The total customer fee remains 1.5% of credit, rounded upward to cents, and includes that deduction. Nominal 100.00 credits 99.00; fee 1.49; total debit 100.49 USDT before separate TRX network fees.

Pattern: ^\d+(\.\d{1,2})?$
Example:

"50.00"

walletId
string<uuid>

Required for API keys: an active Plane wallet in this workspace and Live environment. Console requests default to the signed-in user wallet.

Response

Success

id
string
environment
string
status
enum<string>
Available options:
creating,
pending,
completed,
expired,
failed,
manual_review
depositAmount
string
Pattern: ^\d+(\.\d{1,2})?$
Example:

"100.00"

fee
string

Total customer fee on creditAmount, including the issuer deduction; rounded upward to cents.

Pattern: ^\d+(\.\d{1,2})?$
Example:

"1.49"

creditAmount
string

Actual amount credited after the issuer deduction.

Pattern: ^\d+(\.\d{1,2})?$
Example:

"99.00"

totalDebit
string

creditAmount plus fee. TRX network fees are separate.

Pattern: ^\d+(\.\d{1,2})?$
Example:

"100.49"

address
string | null
walletId
string | null
pricingVersion
string
Example:

"nominal_150"

payAmount
string | null

Exact USDT transfer amount; up to 6 decimals. Never round this value.

Example:

"100.024"

asset
string
network
string
expiresAt
string<date-time> | null
createdAt
string<date-time>