Read Channel Payment

Read Channel Payment

GET https://api.sandbox.coindirect.com/api/v2/channel/payment/:uuid

This endpoint allows you to read Channel Payment.

Path Parameters

Name	Type	Description
uuid	string	Channel Payment UUID

Headers

Name	Type	Description
Authorization	string	HAWK Token. See Authentication page

200 Channel Payment successfully retrieved.

{
  "channelId": "0c4c6186-f371-4a82-a734-f0aeb1d41af4",
  "merchantId": "82737577-ae9a-4305-a544-61bef6681f0c",
  "merchantDisplayName": "Casino",
  "reference": "1ca5346d-ba7e-4f82-b51d-c53be4d5b0c9",
  "dateCreated": 1643207593000,
  "lastUpdated": 1643210803000,
  "status": "COMPLETE",
  "uuid": "0c9b97aa-fa22-459b-8d3c-a3f97d7c40a5",
  "hash": "9092ed5fabe5fdddb3b9bfd202451ff57b2c8d83f9fb4943589a21f380e30fc6",
  "address": "18cZvTB3rr8BRzQru8QVMabJMp4uvGHLMT",
  "tag": null,
  "paidCurrency": "BTC",
  "displayCurrency": "EUR",
  "walletCurrency": "EUR",
  "feeCurrency": "EUR",
  "paidAmount": 0.001,
  "displayAmount": 32.23,
  "walletAmount": 32.23,
  "feeAmount": 0.32,
  "exchangeRate": {
    "base": "BTC",
    "counter": "EUR",
    "rate": 3.223E+4
  },
  "displayRate": {
    "base": "BTC",
    "counter": "EUR",
    "rate": 3.223E+4
  },
  "risk": {
    "level": "LOW",
    "resourceName": "UNKNOWN",
    "resourceCategory": "UNKNOWN",
    "alerts": []
  },
  "sources": [
    "3G5HoushtPmVPyCwEPf9hLad5xE2MRLVGa"
  ],
  "networkFee": {
    "paidCurrency": "BTC",
    "paidAmount": 0E-18,
    "displayCurrency": "EUR",
    "displayAmount": 0E-18
  }
}

Response parameters

Parameter	Type	Description
address	string	Parent channel's destination address
channelId	string	Parent channel's UUID
dateCreated	number	Payment creation date
displayAmount	number	Payment price
displayCurrency	string	Payment currency e.g. JPY
displayRate	object	Display currency spot rate e.g. EUR/JPY
displayRate.base	string	Base currency e.g. EUR
displayRate.counter	string	Counter currency e.g. JPY
displayRate.rate	number	Display currency exchange rate
exchangeRate	object	Wallet currency exchange rate
exchangeRate.base	string	Base currency e.g. ETH
exchangeRate.counter	string	Counter currency e.g. EUR
exchangeRate.rate	number	Wallet currency spot rate
feeAmount	number	Fee amount
feeCurrency	string	Fee currency
hash	string	Cryptocurrency transaction hash
lastUpdated	number	Payment last update date
merchantId	string	Merchant ID
paidAmount	number	The amount of received cryptocurrency
paidCurrency	string	Cryptocurrency code
reference	string	Channel reference ID. Payments always inherit parent channel reference ID
risk	object	Provides risk details after BVNK runs automated tx risk checks on its side
risk.level	string	Risk level. Can be LOW, MEDIUM, HIGH or SEVERE
risk.resourceName	string	The resource name that the transaction is connected to
risk.resourceCategory	string	The resource category. E.g. Exchange or Dark Market, etc
status	string	Payment status
tag	number	Destination tag (in the case of XRP)
uuid	string	Payment UUID
walletAmount	number	The amount credited to your wallet
walletCurrency	string	Wallet currency