For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get Onramp Transfer

Get Onramp Transfer

get
/v0/customers/{customer_id}/onramp-transfer/{transfer_id}
Path parameters
transfer_idstring · uuidRequired

The unique identifier of the cross-chain transfer

customer_idstring · uuidRequired

The unique identifier of the customer

Header parameters
Api-KeystringRequired

Your secret API key, available in the developer dashboard. Include this header on every request to authenticate your application.

Responses
200

Get onramp transfer response

application/json
idstring · uuidOptional

The unique identifier for the onramp transfer

statusstring · enumOptional

The current status of the onramp transfer

Possible values:
amountstring · decimalOptional

The amount of the onramp transfer as a numeric string

Example: 1000.50Pattern: ^[0-9]+(\.[0-9]+)?$
source_currencystring · enumOptional

The currency to be deposited

Example: usdPossible values:
source_railsstring · enumOptional

The deposit rails to be used for the transaction

Example: achPossible values:
destination_networkstring · enumOptional

The blockchain network for the destination

Example: polygonPossible values:
destination_tokenstring · enumOptional

The token for the destination

Example: usdcPossible values:
destination_addressstringOptional

The blockchain address where the funds will be sent

Example: 0x742d35Cc6634C0532925a3b844Bc454e4438f44e
destination_tx_hashstringOptional

The blockchain transaction hash of the destination withdrawal

Example: 0xabc123def456abc123def456abc123def456abc123def456abc123def456abc1
get
/v0/customers/{customer_id}/onramp-transfer/{transfer_id}
200

Get onramp transfer response

Last updated