GET /payments

Returns an array of Payments. This operation is useful if you wish to search for a Payment by merchant reference, between dates, or by status code.

Request

Ensure the bearer token is included in the Header of the GET operation:

Header	Mandatory	Description
Authorization	Yes	Bearer token from /authentication/getToken

Parameter	Type	Mandatory	Description
reference	string	No	Filter by your Merchant reference
statusCode	Int	No	Filter by payment status code (see Payment Status Codes for valid values)
errorCode	int	No	Filter by payment error result code (see Payment Error Codes for valid values)
createdAtFrom	string($date-time)	No	Show payments by their created date from a specific date and time
createdAtTo	string($date-time)	No	Show payments by their created date to a specific date and time
completedAtFrom	string($date-time)	No	Show payments by their completed date from a specific date and time
completedAtTo	string($date-time)	No	Show payments by their completed date to a specific date and time
skip	int	No	Items to skip when searching
take	int	No	Items to take when searching

Response

If successful, the operation will return with an array of standard Payment models (ordered by createdAt descending):

[
  {
    "id": "string($guid)",
    "reference": "string",
    "amount": "string",
    "accountId": "string($guid)",
    "currencyCode": "string",
    "statusCode": int,
    "statusMessage": "string",
    "errorCode": int,
    "errorMessage": "string",
    "createdAt": "string($date-time)",
    "completedAt": " string($date-time)",
    "countryCode": "string",
    "returnUrl": "string"
  }
]

Field values and types for each Payment are the same as described in Payment Status.