eBarimt 3.0 API

QPay eBarimt 3.0 API нь мерчантын нэхэмжлэх үүсгэх, төлбөр амжилттай эсэхийг баталгаажуулах, тухайн төлбөр дээр и-баримт үүсгэх эсвэл цуцлах боломжийг HTTP REST API-аар олгоно.

Орчин

• Sandbox: https://merchant-sandbox.qpay.mn
• Production: https://merchant.qpay.mn

Нэвтрэлт

eBarimt 3.0 нь Merchant API-ийн хоёр алхамт token урсгалыг ашиглана.

Алхам 1 - Access token авах

POST /v2/auth/token endpoint-ийг дараах header-тай дуудна:

Authorization: Basic {base64(client_id:client_secret)}

Алхам 2 - Хамгаалагдсан endpoint дуудах

Invoice, payment, eBarimt endpoint-ууд дээр дараах header ашиглана:

Authorization: Bearer {access_token}

Үндсэн боломжууд

Энэхүү API нь дараах үйлдлүүдийг дэмжинэ:

• eBarimt татварын мэдээлэлтэй мерчантын нэхэмжлэх үүсгэх
• payment callback авсны дараа төлбөр төлөгдсөн эсэхийг шалгах
• төлөгдсөн гүйлгээ дээр и-баримт үүсгэх
• иргэн эсвэл байгууллагад и-баримт үүсгэх
• төлбөр буцаагдсан үед бүртгэгдсэн и-баримтыг цуцлах

Endpoint бүлгүүд

Auth

Merchant API дуудлагад ашиглах access token авах endpoint.

Invoice

Төлөх боломжтой нэхэмжлэх үүсгэнэ. eBarimt-д шаардлагатай district_code, tax_type, classification_code, мөрийн татварын мэдээлэл зэрэг талбаруудыг дамжуулна.

Payment

Нэхэмжлэх төлөгдсөн эсэхийг баталгаажуулж, буцсан payment_id утгыг авна.

Ebarimt

Төлөгдсөн гүйлгээнд и-баримт үүсгэх эсвэл payment_id-аар и-баримт цуцлах endpoint-ууд.

Гүйлгээний урсгал

Бүрэн урсгал нь хоёр үе шаттай: нэхэмжлэл үүсгэх (НЭХЭМЖЛЭЛ ҮҮСГЭХ) ба гүйлгээ шалгах (ГҮЙЛГЭЭ ШАЛГАХ). Томруулж харахын тулд зураг дээр дарна уу.

Зөвлөмжит интеграцийн дараалал

1. POST /v2/auth/token ашиглан access token авна.
2. POST /v2/invoice ашиглан нэхэмжлэх үүсгэхдээ шаардлагатай eBarimt татварын талбаруудыг дамжуулна.
3. Буцсан QR эсвэл deeplink төлбөрийн мэдээллийг хэрэглэгчид харуулна.
4. Callback авсны дараа POST /v2/payment/check ашиглан төлбөрийг баталгаажуулна.
5. Буцсан payment_id ашиглан POST /v2/ebarimt_v3/create endpoint-оор и-баримт үүсгэнэ.
6. Төлбөр буцаагдсан бол DELETE /v2/ebarimt_v3/{payment_id} endpoint-оор и-баримтыг цуцална.

Анхаарах зүйлс

• Production орчинд и-баримт үүсгэхээс өмнө QPay-д хандан eBarimt тохиргоог идэвхжүүлнэ.
• Иргэнд баримт үүсгэх бол ebarimt_receiver_type: CITIZEN, байгууллагад бол COMPANY ашиглана.
• Нэхэмжлэхийн tax_type талбарын дэмжигдэх утгууд нь 1, 2, 3.
• Payment status-ийг cron job-оор байнга шалгахгүй; payment callback авсны дараа POST /v2/payment/check дуудна.