Reading channel deposit
GET
/api/public/v1/channels/:channel_id/transactions/:deposit_id
This endpoint returns channel deposit details by its ID.
Headers
Path Parameters
Response
Response Body
Last updated
GET
/api/public/v1/channels/:channel_id/transactions/:deposit_id
This endpoint returns channel deposit details by its ID.
Headers
Path Parameters
Response
Response Body
Last updated
Name | Value |
---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Content-Type
application/vnd.api+json
Authorization
Bearer <api_key>
channel_id
string
Channe ID.
deposit_id
string
Deposit ID.
data.id
string
Channel deposit ID.
data.type
string
Always channelTransactions
.
data.attributes.hash
string
Transaction hash.
data.attributes.amountCurrency
string
Channel currency to display to end users. Determines the currency due after processing and conversion. Refer to supported currencies.
data.attributes.amount
string
Determines the amount due after processing and conversion. This is the amount the end-user's deposit resulted in, and this is the amount you will want to credit to the user's account on your platform.
data.attributes.payCurrency
string
Crypto currency that customer paod in. Refer to supported currencies.
data.attributes.payAmount
string
Crypto amount that customer paid in.
data.attributes.exchangeRate
string
Exchange rate applied to the deposit.
data.attributes.fee
string
Fee amount taken by Txn for processing this deposit.
data.attributes.feeCurrency
string
Fee currency.
data.attributes.address
string
Channel address.
data.attributes.networkCode
string
Network code.
data.attributes.networkName
string
Network name.
data.attributes.reference
string
The custom reference ID inherited from the parent channel.
data.attributes.channelId
string
The ID of the parent channel that this particular deposit is linked to.
data.attributes.status
string
Channel deposit status. Refer to the Channel deposit flow for more info.
data.attributes.createdAt
string
Timestamp when a channel deposit was created.
data.attributes.updatedAt
string
Timestamp when a channel deposit was last updated.