Afișare listă plăți cu opțiuni de filtrare
GET /v2/mia/payments
Acest endpoint permite obținerea unei liste de plăți, folosind filtre și opțiuni de sortare pentru a restrânge rezultatele. Informațiile returnate includ detalii despre fiecare plată în parte, precum suma, comisionul, starea plății, plătitorul etc.
Request parameters (query)
count
integer
Da
Numărul de elemente returnate în rezultat
offset
integer
Da
Poziția de start în setul de rezultate
sortBy
string (enum)
Nu
Câmpul după care se sortează: orderId
, amount
, status
, executedAt
. Implicit: executedAt
order
string (enum)
Nu
Ordinea sortării: asc
, desc
. Implicit: asc
payId
string (guid)
Nu
Filtrare după ID-ul plății
referenceId
string (15)
Nu
Cod RRN pentru plăți instant
qrId
string (guid)
Nu
Filtrare după ID-ul codului QR
extensionId
string (guid)
Nu
Filtrare după ID-ul extensiei codului QR
orderId
string (100)
Nu
Filtrare după identificatorul comenzii la comerciant
amountFrom
number (decimal)
Nu
Filtrare după sumă minimă (inclusiv)
amountTo
number (decimal)
Nu
Filtrare după sumă maximă (inclusiv)
description
string (500)
Nu
Filtrare după descriere
payerName
string (200)
Nu
Filtrare după numele plătitorului
payerIban
string (200)
Nu
Filtrare după IBAN-ul plătitorului
status
string (enum)
Nu
Filtrare după starea plății: Executed
, Refunded
executedAtFrom
string (datetime)
Nu
Filtrare după data executării – de la (format ISO 8601-1:2019)
executedAtTo
string (datetime)
Nu
Filtrare după data executării – până la (format ISO 8601-1:2019)
terminalId
string (100)
Nu
Filtrare după terminal (furnizat de bancă)
Example request
curl -G "https://api.example.com/v2/mia/payments" \
-H "Authorization: Bearer {{access_token}}" \
--data-urlencode "count=10" \
--data-urlencode "offset=0" \
--data-urlencode "qrId=789e0123-f456-7890-a123-456789012345" \
--data-urlencode "sortBy=executedAt" \
--data-urlencode "order=asc"
Response parameters
result.totalCount
integer
Numărul total de plăți ce corespund filtrelor
result.items[]
array
Lista cu obiecte de tip plată
result.items[].payId
string (guid)
ID-ul unic al plății
result.items[].referenceId
string (15)
Cod RRN pentru serviciul de plăți instant
result.items[].qrId
string (guid)
ID-ul codului QR
result.items[].extensionId
string (guid)
ID-ul extensiei codului QR
result.items[].orderId
string (100)
ID-ul comenzii de la comerciant
result.items[].amount
number (decimal)
Suma plății
result.items[].commission
number (decimal)
Comisionul aplicat
result.items[].currency
string (enum)
Moneda plății (ex. MDL
, format ISO 4217)
result.items[].description
string (500)
Descrierea comenzii/plății
result.items[].payerName
string (200)
Numele abreviat al plătitorului
result.items[].payerIban
string (200)
IBAN-ul plătitorului
result.items[].status
string (enum)
Starea plății: Executed
, Refunded
result.items[].executedAt
string (datetime)
Data și ora executării (ISO 8601-1:2019)
result.items[].refundedAt
string (datetime)
Data și ora rambursării (dacă există) (ISO 8601-1:2019)
result.items[].terminalId
string (100)
ID-ul terminalului furnizat de bancă
ok
boolean
true
dacă cererea a fost procesată fără erori
errors[]
array
Lista erorilor (dacă ok = false
)
errors[].errorCode
string
Codul erorii
errors[].errorMessage
string
Descrierea erorii
Example response
{
"result": {
"totalCount": 42,
"items": [
{
"payId": "123e4567-e89b-12d3-a456-426614174000",
"referenceId": "QR000123456789",
"qrId": "789e0123-f456-7890-a123-456789012345",
"extensionId": "40e6ba44-7dff-48cc-91ec-386a38318c68",
"amount": 50.00,
"commission": 0.50,
"currency": "MDL",
"description": "Payment for order #123",
"payerName": "John D.",
"payerIban": "MD24AG00225100013104168",
"status": "Executed",
"executedAt": "2024-08-05T10:32:28+03:00",
"terminalId": "P011111"
},
{
"payId": "456e7890-a12b-34cd-5678-9e01f23g4567",
"referenceId": "QR000123456780",
"qrId": "789e0123-f456-7890-a123-456789012345",
"extensionId": "37efb479-c41b-4a39-bd27-ea1aef05134f",
"amount": 100.00,
"commission": 1.00,
"currency": "MDL",
"description": "Payment for order #1234",
"payerName": "Jane S.",
"payerIban": "MD24AG000225100014156789",
"status": "Refunded",
"executedAt": "2024-08-04T09:15:00+03:00",
"refundedAt": "2024-08-05T09:17:05+03:00",
"terminalId": "P011111"
}
]
},
"ok": true
}
Last updated