API лавлах

Merchant V2

Version 2.0.0PaymentsНийтийн
Postman collection татах

Merchant V2

Merchant V2 нь merchant-уудад invoice үүсгэх, төлбөрийн төлөв шалгах, и-баримтын урсгал удирдах боломжийг HTTP REST API-аар олгодог.

Орчин

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

Нэвтрэлт

Merchant V2 нь хоёр алхамт нэвтрэлтийн урсгал ашигладаг.

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

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

Authorization: Basic {base64(client_id:client_secret)}

Энэ нь хамгаалагдсан endpoint-уудад ашиглах access token буцаана.

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

Бусад хамгаалагдсан endpoint дээр дараах header ашиглана:

Authorization: Bearer {access_token}

Шаардлагатай үед POST /v2/auth/refresh ашиглан token сунгана.

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

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

  • token авах болон сунгах
  • invoice үүсгэх болон цуцлах
  • төлбөрийн мэдээлэл харах болон шалгах
  • гүйлгээний жагсаалт авах
  • төлбөр цуцлах болон буцаалтын урсгал
  • и-баримт үүсгэх болон цуцлах
  • Visa QR callback хүлээн авах

Үндсэн endpoint бүлгүүд

Auth

Нэвтрэх болон token-ийн lifecycle удирдах endpoint-ууд.

Invoice

Invoice үүсгэх, цуцлах, мөн invoice-той холбоотой төлбөрийн урсгалыг удирдах endpoint-ууд.

Payment

Гүйлгээний мэдээлэл харах, төлбөр баталгаажуулах, жагсаалт авах, шаардлагатай тохиолдолд цуцлах болон буцаалт хийх endpoint-ууд.

Ebarimt

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

Visa QR

Visa QR lookup callback хүлээн авах endpoint.

Интеграцийн зөвлөмж

Төлбөр баталгаажуулах

Боломжтой бол callback-д суурилсан баталгаажуулалт ашиглана.

Төлбөрийн callback хүлээн авсны дараа дараах endpoint-оор гүйлгээг баталгаажуулна:

POST /v2/payment/check

Төлөв шалгах endpoint-уудыг хэт ойр давтамжаар poll хийхээс зайлсхий.

Token ашиглалт

Token хүчинтэй хугацаа дуусаагүй байхад шаардлагагүйгээр дахин дахин шинээр авахгүй байх нь зөв.

Домэйн түвшний чухал тэмдэглэл

Зарим хүсэлтийн payload нь дараах бизнес өгөгдлүүдийг шаарддаг:

  • банкны код
  • дүүрэг, байршлын мэдээлэл
  • татварын төрөл
  • ангиллын код
  • invoice line-ууд
  • хүлээн авагч, салбар, ажилтан, терминал, гүйлгээний мета өгөгдөл

Талбар тус бүрийн яг шаардлагатай бүтэц, жишээг endpoint reference болон schema-уудаас шалгана.

Банкны кодууд

Merchant API нь зарим гүйлгээний payload дээр банкны код ашигладаг.

Дэмжигдэх утгууд:

КодНэр
010000Монгол банк
020000Капитал банк
040000Худалдаа хөгжлийн банк
050000Хаан банк
150000Голомт банк
190000Тээвэр хөгжлийн банк
210000Ариг банк
220000Кредит банк
290000ҮХО банк
300000Капитрон банк
320000Хас банк
330000Чингисхаан банк
340000Төрийн банк
360000Хөгжлийн банк
380000Богд банк
390000М банк
500000Мобифинанс
900000Төрийн сан
993000Инвэскор ББСБ
TOKIТоки

Зөвлөмжит эхний интеграцийн урсгал

Merchant интеграцийн түгээмэл дараалал:

  1. Access token авна.
  2. Invoice үүсгэнэ.
  3. Хэрэглэгчид QR эсвэл deeplink төлбөрийн сонголт харуулна.
  4. Төлбөрийн callback хүлээн авна.
  5. POST /v2/payment/check ашиглан төлбөрийг баталгаажуулна.
  6. Шаардлагатай бол и-баримт үүсгэнэ.
Endpoints