gov-pay
API лавлагаа

Payments

Нэхэмжлэл төлөх, статус шалгах, цуцлах, тайлан

Нэхэмжлэл төлөх

Нэхэмжлэлийг төлж, төлбөрийн QR + банкны deeplink буцаана. Давхар төлөлтөөс сэргийлэхэд X-Idempotency-Key толгой ашиглана (ижил key → cache хариу).

POST
/api/v1/payments
X-API-Key<token>

In: header

Header Parameters

x-idempotency-keystring
X-Idempotency-Key?string

Idempotency түлхүүр (өөрийн хүсэлтийн UUID)

invoiceIdstring

Төлөх нэхэмжлэлийн gov-pay id (эхлээд GET /invoices-аар авна)

Formatuuid
amount?number

Сонголттой — өгөхгүй бол нэхэмжлэлийн бүтэн дүнгээр; өгвөл хэсэгчилсэн/override дүн

Response Body

curl -X POST "https://sandbox-tts.qpay.mn/api/v1/payments" \  -H "x-idempotency-key: string" \  -H "X-Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "invoiceId": "4f163819-178d-470c-a246-d6768476a6ec"  }'
{
  "success": true,
  "id": "d1f9...",
  "status": "submitted",
  "amount": 45000,
  "invoiceId": "4f163819-178d-470c-a246-d6768476a6ec",
  "invoiceIds": [
    "string"
  ],
  "qpay": {
    "qrText": "0002010102...",
    "qrImage": "string",
    "shortUrl": "string",
    "urls": [
      {
        "name": "Khan bank",
        "description": "Хаан банк",
        "logo": "https://qpay.mn/q/logo/khanbank.png",
        "link": "khanbank://q?qPay_QRcode=..."
      }
    ]
  },
  "message": "idempotent"
}
Empty

Төлбөрийн статус

Төлбөрийн статусыг буцаана. MoF-аас live баталгаажуулалт хийж шинэчилнэ.

GET
/api/v1/payments/{id}
X-API-Key<token>

In: header

Path Parameters

idstring

gov-pay төлбөрийн id

Formatuuid

Response Body

curl -X GET "https://sandbox-tts.qpay.mn/api/v1/payments/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "status": "confirmed",
  "amount": 45000,
  "invoiceId": "4f163819-178d-470c-a246-d6768476a6ec",
  "invoiceIds": [
    "string"
  ],
  "paidAt": "2019-08-24T14:15:22Z"
}
Empty

Төлбөр цуцлах

Төлбөрийг цуцалж, холбоотой нэхэмжлэлүүдийг open төлөвт буцаана.

DELETE
/api/v1/payments/{id}
X-API-Key<token>

In: header

Path Parameters

idstring

gov-pay төлбөрийн id

Formatuuid

Response Body

curl -X DELETE "https://sandbox-tts.qpay.mn/api/v1/payments/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "canceled": true
}
Empty

MoF өдрийн тооцооны тайлан

Тухайн санхүүгийн өдрийн MoF тооцооны (settlement) тайлан.

POST
/api/v1/payments/report
X-API-Key<token>

In: header

financeDaystring

Санхүүгийн өдөр (YYYY-MM-DD)

Response Body

curl -X POST "https://sandbox-tts.qpay.mn/api/v1/payments/report" \  -H "Content-Type: application/json" \  -d '{    "financeDay": "2026-06-29"  }'
{
  "financeDay": "2026-06-29",
  "success": true,
  "entries": [
    {
      "refNum": "MOFPAY-1A2B3C4D",
      "amount": 45000,
      "payerReg": "string",
      "payerName": "string",
      "description": "string",
      "date": "string"
    }
  ]
}