InvoiceDetail
Нэхэмжлэлийн дэлгэрэнгүй
ААН өөрийн үүсгэсэн нэхэмжлэлийн дэлгэрэнгүйг авах. Нэхэмжлэлийн дэлгэрэнгүй мэдээллээс нэхэмжлэлийн төлвийг өөрчлөгдсөн эсэхийг шалгах боломж олгоно.
Нэхэмжлэлийн дэлгэрэнгүй авах хүсэлт:
METHOD | URL | HEADER |
---|---|---|
GET | /api/w/invoices/{invoiceNumber} | x-and-auth-token: Token |
invoiceNumber
Дэлгэрэнгүй мэдээллийг нь авах гэж буй нэхэмжлэлийн дугаар.
Token
Мерчантын урт хугацааны Token. Энэхүү Token-ыг мерчант үүсгэх үед хүчинтэй хугацаа тохируулж үүсгэнэ.
Response
Нэр | Төрөл | Тайлбар |
---|---|---|
code | Integer | Хариу код 0 - амжилттай эсвэл алдааны код |
response | Mixed | Хэрвээ алдаа гарсан тохиолдолд алдааны тайлбар байна. Амжилттай бол нэхэмжлэлийн дэлгэрэнгүй. |
Response-ын дэлгэрэнгүй
Параметер | Төрөл | Тайлбар |
---|---|---|
invoiceNumber | String | Сонордуулгын гарчиг |
amount | Integer | Нэхэмжлэлийн мөнгөн дүн |
status | Integer | Нэхэмжлэлийн төлөв: 0 - Хүлээгдэж байгаа 1 - Төлөгдсөн 2 - Цуцлагдсан 3 - Хугацаа нь дууссан |
trackingData | JSON | Мерчантын нэхэмжлэл дээрх өгөгдөл |
createdAt | String | Нэхэмжлэл үүссэн огноо |
expireDate | String | Нэхэмжлэл дуусах огноо |
paidDate | String | Нэхэмжлэл төлөгдсөн огноо. Хэрвээ төлөгдөөгүй тохиолдолд null ирнэ. |
invoiceNumber
Нэхэмжлэл үүсгэх үед нэхэмжлэлийн дугаар болох цор ганц тэмдэгт үүснэ.
amount
Нэхэмжлэлийн мөнгөн дүн.
status
Нэхэмжлэлийн одоогийн төлөв. Төлөв нь нэхэмжлэл төлөгдсөн эсэх, цуцлагдсан эсэх, хүчинтэй хугацаа нь дууссан эсэх эсвэл төлөгдөөгүй хүлээгдэж байгааг илэрхийлнэ.
trackingData
trackingData нь мерчант нэхэмжлэлийг таних зорилготой өөрийн мэдээллээ хадгалах талбар.
createdAt
createdAt нь нэхэмжлэл үүсгэсэн огноо.
expireDate
expireDate нь нэхэмжлэл цуцлагдсан огноо.
paidDate
paidDate нь нэхэмжлэлийн төлөгдсөн огноо.
Хүсэлт илгээж буй жишээ:
curl --request GET \
--url 'https://mgw.test.lending.mn/api/w/invoices/{invoiceNumber}' \
--header 'x-and-auth-token: {token}'
Амжилттай болсон хариу
{
"code": 0,
"response": {
"invoiceNumber": "7a459581-6c80-4efb-be9f-f07978261f94",
"description": "Нэхэмжлэл",
"status": 1,
"amount": 7000,
"trackingData": "#123456",
"createdAt": "2018-10-17T08:17:04+08:00",
"expireDate": "2018-10-17T08:30:04+08:00",
"paidDate": "2018-10-17T08:25:04+08:00"
}
}
Амжилтгүй болсон хариу
{
"code": 400,
"response": {
"error": "invalid_client",
"error_description": "The client credentials are invalid"
}
}