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

Webhooks

Төлбөрийн мэдэгдлийн webhook бүртгэх, жагсаах, устгах

Webhook жагсаах

Партнёрийн бүртгэлтэй webhook-уудыг жагсаана (secret буцаахгүй).

GET
/api/v1/webhooks
X-API-Key<token>

In: header

Response Body

curl -X GET "https://sandbox-tts.qpay.mn/api/v1/webhooks"
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "url": "https://partner.mn/webhooks/govpay",
    "events": [
      "payment.confirmed"
    ],
    "active": true,
    "createdAt": "2019-08-24T14:15:22Z"
  }
]

Webhook бүртгэх

Төлбөрийн мэдэгдэл хүлээн авах endpoint бүртгэнэ.

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

In: header

urlstring

Мэдэгдэл хүлээн авах HTTPS URL

secretstring

HMAC-SHA256 гарын үсэг шалгахад ашиглах нууц

eventsarray<string>

Захиалах event-ууд

Response Body

curl -X POST "https://sandbox-tts.qpay.mn/api/v1/webhooks" \  -H "Content-Type: application/json" \  -d '{    "url": "https://partner.mn/webhooks/govpay",    "secret": "string",    "events": [      "payment.submitted",      "payment.confirmed"    ]  }'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "partnerId": "bf408d53-df49-40a6-8455-a34bd4360901",
  "url": "https://partner.mn/webhooks/govpay",
  "secret": "string",
  "events": [
    "payment.submitted",
    "payment.confirmed"
  ],
  "active": true,
  "createdAt": "2019-08-24T14:15:22Z"
}

Webhook устгах

Webhook-ийг идэвхгүй болгоно (soft delete).

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

In: header

Path Parameters

idstring
Formatuuid

Response Body

curl -X DELETE "https://sandbox-tts.qpay.mn/api/v1/webhooks/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "ok": true
}