List channel payments

get
List channel payments

https://business-sandbox.cryptopay.me/api/channels/:channel_id/payments
This endpoint allows you to get a list of all channel payments.
Request
Response
Headers
Authorization
required
string
HMAC using API key and signature
Content-Type
required
string
application/json
Date
required
string
Current date in HTTP-date format
Query Parameters
channel_id
optional
string
Channel ID
starting_after
optional
string
Pagination parameter. Channel payment ID to start after
200: OK
[
{
"id": "284d4b79-fea6-46ce-bc2f-0f9cbed6367e",
"paid_amount": "0.02",
"paid_currency": "BTC",
"received_amount": "97.26",
"received_currency": "EUR",
"fee"=>"0.99",
"fee_currency": "EUR",
"txid": "09723bf75253f3d2bf2f150fd8b5da5bc3026b95f1fe50b1f5f76f43d67a2e30",
"exchange": {
"pair": "BTCEUR",
"rate": "4912.8021",
"fee": "0.0",
"fee_currency": "EUR"
},
"status": "completed",
"custom_id": "631044494",
"channel_id": "50eb5775-f77e-4c64-870b-dc93624b5967",
"address": "2N9uVK2MDFNgBVqPnvCTV66Dinx3cp5J7S4",
"risk": {
"score": 0.0,
"level": "low",
"resource_name": "default",
"resource_category": "unknown"
},
"created_at": "2019-05-02T11:00:01+00:00"
}
]

API call example.

curl -X GET \
https://business-sandbox.cryptopay.me/api/channels/50eb5775-f77e-4c64-870b-dc93624b5967/payments \
-H 'Authorization: HMAC ***' \
-H 'Content-Type: application/json' \
-H 'Date: Tue, 19 Mar 2019 10:11:40 GMT'

Response schema.

Array [

Parameter

Type

Description

id

string

Channel payment ID

paid_amount

string

Cryptocurrency transaction amount that was received

paid_currency

string

Cryptocurrency type

received_amount

string

Amount credited to your Cryptopay account

received_currency

string

Account currency

fee

string

Processing fee

fee_currency

string

Processing fee currency

txid

string

Cryptocurrency transaction ID on the blockchain

exchange

object

Exchange details

pair

string

Currency pair

rate

string

Exchange rate

fee

string

Exchange fee

fee_currency

string

Exchange fee currency

status

string

Channel payment status. Refer to a list of channel payment statuses

custom_id

string

Channel payment custom_id value inherited from its parent channel

channel_id

string

Channel ID

address

string

Channel cryptocurrency address

risk

object

Cryptocurrency transaction risk level details

score

number

Transaction risk score

level

string

Transaction risk level. low, medium or high depending on the score value

resource_name

string

A resource name the transaction has been received from e.g. Bitstamp

resource_category

string

A resource category the transaction has been received from e.g. Exchange

created_at

string

Channel payment creation date and time

]