Get payments

Get payments based on parameters.

SecurityapiKeyAuth
Request
query Parameters
dateFrom
string <date-time>

Earliest creation date to query from (ISO8601)

dateTo
string <date-time>

Earliest creation date to query from (ISO8601)

paginationLimit
integer <int32>

Number of items to return per page

paginationOffset
integer <int32>

Number of items to skip

sortType
string

Field upon which to order results. Currently limited to datetime fields.

Value: "finalisedAt"
sortDirection
string (sortDirection)

Direction with which to sort. "ASC" or "DESC". Default "DESC".

Enum: "ASC" "DESC"
relatedId
string <uuid>

Value for filtering related payment id.

Responses
200

successful operation

get/payments
Response samples
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}