Retrieve all payments by filter

/v2/payments

Returns a list of payments associated with the authenticated merchant. Supports filtering, pagination, and sorting via query parameters.

Request

HTTP Method: GET Endpoint:

/v2/payments

Headers:

Authorization: {tokenType} {access_token}
Content-Type: application/json

---

Query Parameters

Filtering parameters

Name	Type	Description
paymentId	string (UUID)	Filters results by a specific payment identifier.
paymentIntentId	string (UUID)	Filters payments associated with a specific payment intent.
terminalId	string	Identifier of the terminal that initiated the payment.
amountFrom	number (decimal)	Minimum payment amount (inclusive).
amountTo	number (decimal)	Maximum payment amount (inclusive).
currency	string	Currency code of the payment (ISO 4217).
orderId	string	Merchant order identifier associated with the payment.
note	string	Filters payments by note content.
status	string	Payment status (e.g. Executed).
executedAtFrom	string (ISO 8601 datetime)	Start of execution date interval (inclusive).
executedAtTo	string (ISO 8601 datetime)	End of execution date interval (inclusive).
recipientIban	string	IBAN of the payment recipient.
referenceNumber	string	Reference number assigned to the payment.
senderIban	string	IBAN of the payment sender.
senderName	string	Name of the payment sender.
providerType	string	Provider channel used for the payment (e.g. QR).
mcc	string	Merchant Category Code associated with the payment.
type	string	Payment type (e.g. MIA).

---

Pagination and sorting parameters

Name	Type	Description
count	integer (int32)	Number of records to return per page.
offset	integer (int32)	Number of records to skip before starting to return results.
sortBy	string	Field name used for sorting the results.
order	string	Sort direction (asc or desc).

Query example

GET /v2/payments?<your_query_params_here> HTTP/1.1

---

Response

Response Parameters

result object

Name	Type	Description
items	array	List of payments matching the provided filters.
totalCount	integer	Total number of records matching the filters, regardless of pagination.

---

Payment item object

Name	Type	Description
paymentId	string (UUID)	Unique identifier of the executed payment.
paymentIntentId	string | null	Identifier of the related payment intent, if applicable.
executedAt	string (ISO 8601 datetime)	Date and time when the payment was executed.
status	string	Current status of the payment. Possible values: Executed — The payment was successfully executed PartiallyRefunded — The payment was partially refunded Refunded — The payment was fully refunded Failed — The payment failed
amount	number	Amount of the payment.
currency	string	Currency code of the payment (ISO 4217).
type	string	Payment type (e.g. MIA).
providerType	string	Provider channel used for the payment (e.g. QR).
senderName	string	Name of the payment sender.
senderIban	string	IBAN of the payment sender.
recipientIban	string	IBAN of the payment recipient.
referenceNumber	string	Reference number assigned to the payment.
mcc	string	Merchant Category Code associated with the payment.
orderId	string	Merchant order identifier linked to the payment.
terminalId	string	Identifier of the terminal that initiated the payment.
refundedAmount	number	Total amount already refunded for this payment.
requestedRefundAmount	number	Total refund amount currently requested.
firstRefundedAt	string | null	Date and time of the first refund operation, if any.
lastRefundedAt	string | null	Date and time of the most recent refund operation, if any.
note	string | null	Optional note attached to the payment.

---

Root-level fields

Name	Type	Description
ok	boolean	Indicates whether the request was processed successfully.
errors	array | null	List of errors, if the request failed.

---

Example response

{
  "result": {
    "items": [
      {
        "paymentId": "ae20c2ae-328b-456d-bed1-52646b5eacab",
        "paymentIntentId": null,
        "executedAt": "2024-01-12T00:00:00+03:00",
        "status": "Executed",
        "amount": 50.61,
        "currency": "MDL",
        "type": "MIA",
        "providerType": "QR",
        "senderName": "John D.",
        "senderIban": "MD16AG000000022595083585",
        "recipientIban": "MD16AG000000011111111111",
        "referenceNumber": "MIA012345678",
        "mcc": "5811",
        "orderId": "123",
        "terminalId": "123456789012345678901234567890123456",
        "refundedAmount": 0,
        "requestedRefundAmount": 0,
        "firstRefundedAt": null,
        "lastRefundedAt": null,
        "note": null
      },
      {
        "paymentId": "ae20c2ae-328b-456d-bed1-52646b5eacab",
        "paymentIntentId": null,
        "executedAt": "2024-01-12T00:00:00+03:00",
        "status": "Executed",
        "amount": 50.61,
        "currency": "MDL",
        "type": "MIA",
        "providerType": "QR",
        "senderName": "John D.",
        "senderIban": "MD16AG000000022595083585",
        "recipientIban": "MD16AG000000011111111111",
        "referenceNumber": "MIA012345678",
        "mcc": "5811",
        "orderId": "123",
        "terminalId": "123456789012345678901234567890123456",
        "refundedAmount": 0,
        "requestedRefundAmount": 0,
        "firstRefundedAt": null,
        "lastRefundedAt": null,
        "note": null
      }
    ],
    "totalCount": 2
  },
  "ok": true,
  "errors": null
}