List Payments

get https://api.sandbox.layer1.com/api/v1/pay/summary

Retrieves a list of payments on a specific Merchant ID.

Responses

Response body

array of objects

object

uuid

string

The unique identifier for the merchant payment.

merchantDisplayName

string

The display name for the merchant payment.

merchantId

string

The Merchant ID. You can find it on the Merchant Details page in your account.

dateCreated

int64

The date and time, encoded into UNIX epoch timestamps.

expiryDate

int64

The date and time, encoded into UNIX epoch timestamps

quoteExpiryDate

int64

The date and time, encoded into UNIX epoch timestamps

acceptanceExpiryDate

int64

The date and time, encoded into UNIX epoch timestamps

quoteStatus

string

reference

string

The custom payment reference ID to tie the payment to your customer.

type

string

Defaults to IN

Defines whether a payment in or payment out.

IN OUT

subType

string

Defaults to merchantPayIn

The payment sub type

merchantPayIn merchantPayOut merchantRefund

status

string

The payment status.

PENDING PROCESSING CANCELLED COMPLETE UNDERPAID OVERPAID EXPIRED

displayCurrency

object

Contains the type of currency, amount to be paid, and amount received.

walletCurrency

object

Contains the type of currency, amount to be paid, and amount received.

paidCurrency

object

Contains the type of currency, amount to be paid, and amount received.

feeCurrency

object

Contains the type of currency, amount to be paid, and amount received.

displayRate

object

Contains exchange rate information to convert from base currency to counter currency.

exchangeRate

object

Contains exchange rate information to convert from base currency to counter currency.

address

object

Payment address details

returnUrl

string

The URL that the customer will be redirected to if they click 'Back to Merchant' button on the payment web page.

redirectUrl

string

The URL to the payment page that you redirect your customers to.

transactions

array of objects

transactions

object

dateCreated

int64

The date and time, encoded into UNIX epoch timestamps.

dateConfirmed

int64

The date and time, encoded into UNIX epoch timestamps.

hash

string

Transaction hash.

amount

number

The payment amount.

risk

object

Has additional fields

networkFeeCurrency

string

The currency acronym.

networkFeeAmount

number

The network fee amount.

sources

array of strings

The list of source addresses, only applicable if payment in.

sources

displayRate

object

Contains exchange rate information to convert from base currency to counter currency.

exchangeRate

object

Contains exchange rate information to convert from base currency to counter currency.

refund

object

The payment this object is a refund of. This should reference the pay in that this refund was created for.

Has additional fields

refunds

array of objects

Refunds that have been requested for this payment. This should reference the refund payout for this pay in.

refunds

object

Language

Credentials

Header

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://api.sandbox.layer1.com/api/v1/pay/summary?merchantId=5C8D8D78-366A-4AFB-B658-A64CE543C5DB' \
3
     --header 'accept: application/json'

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

application/json

200OK

400Bad Request

500Unexpected Error