Skip to main content
GET
Get sponsored transfer

Authorizations

X-API-Key
string
header
required

Headers

API-Version
enum<string>
default:v1

API version (defaults to the latest supported version if omitted).

Available options:
v1

Path Parameters

id
string<uuid>
required

Sponsored-transfer ID

Response

Success

asset
string
chain
string
confirmations
integer
created_at
string
expires_at
string

RFC 3339 quote expiry; present while status is quoted. Sign and submit before this time.

failure_code
string

Machine-readable failure reason on a failed transfer, e.g. insufficient_token_balance, transfer_reverts, reverted.

failure_reason
string

Human-readable failure detail.

fee
object

Bitnob sponsorship fee, charged in the transferred token.

from
string
id
string

Transfer id; use it in the submit and get endpoints.

network
string
object
string

Object type discriminator; always "sponsored_transfer".

Example:

"sponsored_transfer"

partner_fee
object

Your markup breakdown; present only if you attached partner_fee on the quote.

recipient_amount
string

What the recipient receives (decimal).

Example:

"10.50"

router_version
integer

The resolved EVM router contract version the transfer was quoted against (absent for non-EVM).

sign
object

What the end-user must sign; present only while status is quoted.

status
string

Lifecycle status: quoted, validating, submitted, assembled (EVM only), tron_activating and tron_approving (Tron first-time onboarding), pending, completed, failed, expired, cancelled.

Example:

"quoted"

to
string
total_debit
string

What leaves the sender (decimal). In gross mode this equals amount; otherwise it equals recipient_amount + fee + partner_fee.

Example:

"10.72"

treat_as_gross_amount
boolean

Whether the request amount was treated as the sender's total debit.

tx_hash
string

On-chain transaction hash, set once broadcast.