List Channel Payments

get

https://api.sandbox.layer1.com/api/v2/channel/payment

Lists inbound channel deposits across every Channel on your account. Use this to reconcile expected deposits or to back-fill if a webhook delivery was missed.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

uuid

Unique identifier of the merchant channel payment.

reference

string

Reference identifier for the merchant channel payment.

merchantId

uuid

Unique identifier of the merchant.

hash

string

Hash value associated with the merchant channel payment.

status

string

enum

Current status of the merchant channel.

Allowed:

fromDate

date-time

Start date for filtering merchant channel payments (ISO 8601 format).

toDate

date-time

End date for filtering merchant channel payments (ISO 8601 format).

address

string

Address associated with the merchant channel.

offset

int32

≥ 0

Pagination offset (zero or greater).

max

int32

≥ 1

Maximum number of records to return (greater than zero).

order

string

enum

Order of sorting: 'asc' for ascending or 'desc' for descending.

Allowed:

sort

string

enum

The sort parameter specifies which field to sort the channel payments by. Available sort fields include:

displayAmount: Sort by the amount in display currency
paidAmount: Sort by the amount paid in cryptocurrency
hash: Sort by transaction hash
uuid: Sort by unique identifier
status: Sort by payment status (COMPLETE, DETECTED, etc.)
lastUpdated: Sort by when the payment was last updated
dateCreated: Sort by when the payment was created

Allowed:

string

Search query to filter merchant channel payments.

Responses

200Successful retrieval of merchant channel payments.

400Invalid request parameters.

404Merchant Channel Not Found

500Internal server error.