Skip to main content
GET
Get Onramp Transaction Status

Authorizations

x-api-key
string
header
required

API key for authentication. Must be included in the x-api-key header.

Path Parameters

transaction_id
string<uuid>
required

The unique identifier of the onramp transaction

Response

Onramp transaction status retrieved successfully

id
string<uuid>

The unique identifier of the transaction

Example:

"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

currency
string

Source currency (lowercase)

Example:

"eur"

status
enum<string>

Current status of the onramp transaction. INITIATED: Transaction has been started. FUNDS_RECEIVED: Funds have been received from the source. PAYMENT_SUBMITTED: Payment has been submitted to the destination. PAYMENT_PROCESSED: Payment has been fully processed. REFUND: Transaction has been refunded.

Available options:
INITIATED,
FUNDS_RECEIVED,
PAYMENT_SUBMITTED,
PAYMENT_PROCESSED,
REFUND
Example:

"PAYMENT_PROCESSED"

sender_user_id
string<uuid>

The unique identifier of the user who initiated the transaction

Example:

"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

source_amount
number

Amount in source currency (fiat)

Example:

2

destination_amount
number

Amount in destination currency (crypto)

Example:

2.34

wallet_txn_id
string

Blockchain transaction ID/hash

Example:

"4Hx6qtq21jNA4gZFHo51wTFtHWyj1Lwx6ii5kSQBHDkfQph5WP7XEpZDHqFFdALrtwbndQD74bfqta2oWFby8QTM"

source_info
object
wallet_details
object
funds_received_at
string<date-time>

Timestamp when funds were received

Example:

"YYYY-MM-DDTHH:MM:SS.sssZ"

payment_submitted_at
string<date-time>

Timestamp when payment was submitted

Example:

"YYYY-MM-DDTHH:MM:SS.sssZ"

payment_processed_at
string<date-time>

Timestamp when payment was processed

Example:

"YYYY-MM-DDTHH:MM:SS.sssZ"