BVbvnk
Crypto Channels

List channel payments

Changed on

Retrieves a list of payments to a channel on a specific Wallet ID.

get/api/v2/channel/payment

Request

Query parameters

walletIdstring required
Example:a:24092328494070:G5i4XZ9:1

Unique identifier of the wallet associated with the transaction.

status'DETECTED' | 'COMPLETE' | 'HELD' | 'CANCELLED'

The status of the channel payment.

Example:COMPLETE
fromDatestring
Example:2023-03-30

The start date in format 'YYYY-MM-dd'.

toDatestring
Example:2023-03-30

The end date in format 'YYYY-MM-dd'.

offsetstring
Example:0

Where to start fetching records.

maxstring
Example:10

Maximum number of items in response.

qstring

Use it to query channel based on the reference provided during creation. Can be UUID of the payment, reference, channel UUID, transaction hash, or wallet code.

Response

OK

channelIdstring

The ID of the channel.

merchantIdstring

The merchant ID linked to channel.

merchantDisplayNamestring

The display name fo the merchant.

referencestring

The unique reference of the channel.

dateCreatedinteger

The date and time, encoded into UNIX epoch timestamps.

lastUpdatedinteger

The date and time, encoded into UNIX epoch timestamps.

status'DETECTED' | 'COMPLETE' | 'HELD' | 'CANCELLED'

The status of the channel payment.

uuidstring

The uuid fo the channel payment.

hashstring

The transaction hash of the channel payment.

addressstring

The address of the channel.

tagstring

The tag of the channel.

paidCurrencystring

The currency of the payment.

displayCurrencystring

The display currency of the channel.

walletCurrencystring

The currency of the wallet linked to the channel.

feeCurrencystring

The currency of the fee taken.

paidAmountnumber

The amount paid to the channel.

displayAmountnumber

The amount displayed of the channel payment.

walletAmountnumber

The amount converted to the wallet linked to the channel.

feeAmountnumber

The amount of the fee taken.

sourcesstring[]

The address source of the payment.

Example response

[
  {
    "channelId": "9d1f67f2-a647-404b-9b02-247c77be81d0",
    "merchantId": "0a12a214-1619-43fa-9be1-0029f6a440a0",
    "merchantDisplayName": "Merchant A",
    "reference": "c1b933d5-3354-4f83-a05f-0b53f1be85f2",
    "dateCreated": 1631619489000,
    "lastUpdated": 1631619562000,
    "status": "COMPLETE",
    "uuid": "c0dc9c14-0312-4a6b-a1a3-a6dcebdcc8a4",
    "hash": "0x152f2b3a3650a3e2e132abca0f81421c552ae14bc8466fac16889e8d32b3fd6a",
    "address": "0xb4e8bb9918248007dc9d0dc12ae1142f0d62ef0e",
    "paidCurrency": "ETH",
    "displayCurrency": "JPY",
    "walletCurrency": "EUR",
    "feeCurrency": "EUR",
    "paidAmount": 0.01,
    "displayAmount": 3592.27,
    "walletAmount": 27.62,
    "feeAmount": 0.27,
    "exchangeRate": {
      "base": "ETH",
      "counter": "EUR",
      "rate": 1680.1
    },
    "displayRate": {
      "base": "ETH",
      "counter": "EUR",
      "rate": 1680.1
    },
    "risk": {
      "level": "UNKNOWN",
      "resourceName": "UNKNOWN",
      "resourceCategory": "UNKNOWN",
      "alerts": []
    }
  }
]

Changes

  • 97d6c0d2fe2eRevision changes
    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      response property items/risk deprecated