List Merchant Channel Payments

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

Retrieves a list of merchant channel payments based on the provided filters.

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

Current status of the merchant channel.

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

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

sort

string

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

string

Search query to filter merchant channel payments.

Responses

Response body

array of objects

object

channelId

uuid

Unique identifier of the merchant channel.

merchantId

uuid

Unique identifier of the merchant.

merchantDisplayName

string

Display name of the merchant.

reference

string

Reference identifier for the merchant channel payment.

dateCreated

int64

Timestamp when the payment was created (milliseconds since epoch).

lastUpdated

int64

Timestamp when the payment was last updated (milliseconds since epoch).

status

string

Current status of the merchant channel payment.

DETECTED COMPLETE SCREENING_REQUESTED HELD REJECTED

uuid

string

Unique identifier of the channel payment.

hash

string

Hash value associated with the channel payment.

address

string

Blockchain address associated with the merchant channel payment.

tag

string

Tag associated with the payment for identification purposes.

paidCurrency

string

Currency code in which the payment was made (ISO 4217 format).

displayCurrency

string

Currency code used for display purposes (ISO 4217 format).

walletCurrency

string

Currency code used for wallet transactions (ISO 4217 format).

feeCurrency

string

Currency code used for fees (ISO 4217 format).

paidAmount

number

Amount paid in the payment currency.

displayAmount

number

Amount displayed in the display currency.

walletAmount

number

Amount held in the wallet currency.

feeAmount

number

Amount charged as a fee in the fee currency.

exchangeRate

object

Display exchange rate at the time of payment.

displayRate

object

Display exchange rate at the time of payment.

risk

object

Risk assessment details associated with the payment.

sources

array of objects

List of sources associated with the payment.

sources

object

address

string

amount

string

networkFee

object

Network fee details associated with the payment.

network

string

Network protocol used for the merchant channel payment.

wasOnHold

boolean

Indicates whether the channel payment was placed on hold.

Headers

object

X-Api-List-Total

integer

Total number of merchant channel payments available.

X-Api-List-Start

integer

Starting index of the returned merchant channel payments.

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.sandbox.layer1.com/api/v2/channel/payment \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful retrieval of merchant channel payments.

400Invalid request parameters.

404Merchant Channel Not Found

500Internal server error.