Retrieve List of Payments with Filtering Options
GET /v2/mia/payments
This endpoint allows retrieving a list of payments, using filters and sorting options to narrow down the results. The returned data includes details for each payment, such as amount, commission, payment status, payer information, etc.
Request parameters (query)
count
integer
Yes
Number of items returned in the result
offset
integer
Yes
Starting index in the result set
sortBy
string (enum)
No
Field to sort by: orderId, amount, status, executedAt. Default: executedAt
order
string (enum)
No
Sort order: asc, desc. Default: asc
payId
string (guid)
No
Filter by payment ID
referenceId
string (15)
No
RRN code for instant payments
qrId
string (guid)
No
Filter by QR code ID
extensionId
string (guid)
No
Filter by QR extension ID
orderId
string (100)
No
Filter by merchant order identifier
amountFrom
number (decimal)
No
Filter by minimum amount (inclusive)
amountTo
number (decimal)
No
Filter by maximum amount (inclusive)
description
string (500)
No
Filter by description
payerName
string (200)
No
Filter by payer name
payerIban
string (200)
No
Filter by payer IBAN
status
string (enum)
No
Filter by payment status: Executed, Refunded
executedAtFrom
string (datetime)
No
Filter by execution date — from (ISO 8601-1:2019 format)
executedAtTo
string (datetime)
No
Filter by execution date — to (ISO 8601-1:2019 format)
terminalId
string (100)
No
Filter by terminal ID (provided by the bank)
Example request
Response parameters
result.totalCount
integer
Total number of payments matching the filters
result.items[]
array
List of payment objects
result.items[].payId
string (guid)
Unique ID of the payment
result.items[].referenceId
string (15)
RRN code for the instant payment service
result.items[].qrId
string (guid)
QR code ID
result.items[].extensionId
string (guid)
QR extension ID
result.items[].orderId
string (100)
Merchant order ID
result.items[].amount
number (decimal)
Payment amount
result.items[].commission
number (decimal)
Applied commission
result.items[].currency
string (enum)
Payment currency (e.g.,MDL, ISO 4217 format)
result.items[].description
string (500)
Order/payment description
result.items[].payerName
string (200)
Abbreviated name of the payer
result.items[].payerIban
string (200)
Payer’s IBAN
result.items[].status
string (enum)
Payment status: Executed, Refunded
result.items[].executedAt
string (datetime)
Execution date and time (ISO 8601-1:2019)
result.items[].refundedAt
string (datetime)
Refund date and time (if any, ISO 8601-1:2019)
result.items[].terminalId
string (100)
Terminal ID provided by the bank
ok
boolean
true if the request was processed without errors
errors[]
array
List of errors (if ok = false)
errors[].errorCode
string
Error code
errors[].errorMessage
string
Error description
Example response
Last updated