Afișare listă QR-uri cu opțiuni de filtrare

GET/v2/mia/qr

Acest endpoint permite obținerea unei liste de QR-uri create în platforma MIA, cu posibilitatea de a aplica diferiți parametri de filtrare, sortare și paginare.


Parametri cerere (query)

Nume
Tip
Obligatoriu
Descriere

count

integer

da

Numărul de rezultate returnate.

offset

integer

da

Indexul de pornire pentru setul de rezultate.

sortBy

string (enum)

nu

Câmpul după care se face sortarea. Valori posibile: orderId, type, amountType, status, createdAt, expiresAt. Implicit: createdAt.

order

string (enum)

nu

Ordinea rezultatelor sortate. Valori posibile: asc, desc. Implicit: asc.

qrId

string (GUID)

nu

Filtrare după ID-ul QR-ului.

extensionId

string (GUID)

nu

Filtrare după ID-ul extensiei QR.

orderId

string (max. 100)

nu

Filtrare după ID-ul comenzii din partea comerciantului.

type

string (enum)

nu

Tipul QR-ului. Valori posibile: Static, Dynamic, Hybrid.

amountType

string (enum)

nu

Tipul sumei. Valori posibile: Fixed, Controlled, Free.

amountFrom

number (decimal)

nu

Valoare minimă pentru sumă.

amountTo

number (decimal)

nu

Valoare maximă pentru sumă.

description

string (max. 500)

nu

Filtrare după descriere.

status

string (enum)

nu

Statusul QR-ului. Valori posibile: Active, Inactive, Expired, Paid, Cancelled.

createdAtFrom

string (datetime)

nu

Data de creare — de la. Format ISO 8601.

createdAtTo

string (datetime)

nu

Data de creare — până la. Format ISO 8601.

expiresAtFrom

string (datetime)

nu

Data de expirare — de la. Format ISO 8601.

expiresAtTo

string (datetime)

nu

Data de expirare — până la. Format ISO 8601.

terminalId

string (max. 100)

nu

ID-ul terminalului, furnizat de bancă.


Exemplu cerere

curl -G "https://api.example.com/v2/mia/qr" \
  -H "Authorization: Bearer {{access_token}}" \
  --data-urlencode "count=10" \
  --data-urlencode "offset=0" \
  --data-urlencode "amountFrom=10.00" \
  --data-urlencode "amountTo=100.00" \
  --data-urlencode "sortBy=createdAt" \
  --data-urlencode "order=desc"

Parametri răspuns

Obiect result

Nume
Tip
Descriere

totalCount

integer

Numărul total de QR-uri găsite în baza filtrelor.

items

array

Lista de obiecte QR.

Obiecte în items

Câmp
Tip
Descriere

qrId

string (GUID)

Identificatorul unic al QR-ului.

extensionId

string (GUID)

ID-ul extensiei QR.

orderId

string (max. 100)

ID-ul comenzii la comerciant.

type

string (enum)

Tipul QR-ului: Static, Dynamic, Hybrid.

url

string (max. 1000)

URL-ul QR-ului. Format: HTTPS.

amountType

string (enum)

Tipul sumei: Fixed, Controlled, Free.

amount

number (decimal)

Suma fixă (dacă este cazul).

amountMin

number (decimal)

Suma minimă (pentru sume controlate).

amountMax

number (decimal)

Suma maximă (pentru sume controlate).

currency

string (enum)

Moneda. Format ISO 4217.

description

string (max. 500)

Descrierea QR-ului.

callbackUrl

string (max. 1000)

URL pentru callback.

redirectUrl

string (max. 1000)

URL pentru redirect.

status

string (enum)

Statusul QR-ului: Active, Inactive, Expired, Paid, Cancelled.

createdAt

string (datetime)

Data creării QR-ului. Format ISO 8601.

updatedAt

string (datetime)

Ultima actualizare. Format ISO 8601.

expiresAt

string (datetime)

Data expirării QR-ului. Format ISO 8601.

terminalId

string (max. 100)

ID-ul terminalului bancar.

Alte câmpuri

Câmp
Tip
Descriere

ok

boolean

true dacă cererea a fost procesată cu succes.

errors

object

Detalii despre erori, dacă există.

errors.errorCode

string

Codul erorii.

errors.errorMessage

string

Descrierea erorii.


Exemplu răspuns

{
  "result": {
    "totalCount": 42,
    "items": [
      {
        "qrId": "123e4567-e89b-12d3-a456-426614174000",
        "extensionId": "40e6ba44-7dff-48cc-91ec-386a38318c68",
        "type": "Dynamic",
        "url": "https://example.com/qr/123e4567-e89b-12d3-a456-426614174000",
        "amountType": "Fixed",
        "amount": 50.00,
        "currency": "MDL",
        "description": "Description",
        "status": "Paid",
        "createdAt": "2024-08-05T10:32:28+03:00",
        "updatedAt": "2024-08-05T10:33:50+03:00",
        "expiresAt": "2024-08-05T10:34:28+03:00",
        "terminalId": "P011111"
      }
    ]
  },
  "ok": true
}

Last updated