Find Invoice
Api ini digunakan untuk mencari invoice berdasarkan id.
Spesification
Nama API | Find Invoice |
Http Method | GET |
Path | .../api/find/{id} |
Header
header wajib yang harus dikirimkan pada saat request adalah:
Header | Deskripsi |
---|---|
X-Winpay-Timestamp | Waktu tanggal transaksi, dengan format YYYY-MM-DDTHH:mm:ss+07:00. Waktu harus dalam GMT+7 (waktu Jakarta) |
X-Winpay-Signature | Signature hasil generate dari merchant |
X-Winpay-Key | Client key merchant |
Content-Type | harus application/json |
Response
berikut adalah body response yang akan diterima:
Parameter | Tipe | Deskripsi |
---|---|---|
responseCode | string | kode respon |
responseMessage | string | pesan respon |
responseDate | date | tanggal respon |
responeData | json element | - |
responeData.id | string | id untuk transaksi terkait |
responeData.ref | string | nomor referensi untuk transaksi terkait |
responeData.created_at | date | tanggal transaksi dibuat |
responeData.back_url | string | url yang dituju atau ditampilkan setelah customer selesai melakukan pembayaran |
responeData.status | string | status dari pembayaran |
responeData.customer | json element | - |
responeData.customer.name | string | nama customer |
responeData.customer.email | string | email customer |
responeData.customer.phone | string | nomor HP/telepon customer |
responeData.products | json element | - |
responeData.products[].uuid | string | id untuk transaksi produk terkait |
responeData.products[].name | string | nama produk |
responeData.products[].qty | integer | jumlah produk |
responeData.products[].price | integer | harga produk |
responeData.payment | json element | - |
responeData.payment.uuid | string | id untuk pembayaran terkait |
responeData.payment.channel | string | channel yang digunakan untuk melakukan pembayaran |
responeData.payment.code | string | kode yang digunakan untuk melakukan pembayaran |
responeData.payment.payment_ref | string | nomor referensi untuk pembayaran terkait |
responeData.payment.paid_amount | integer | total tagihan |
responeData.payment.fee | integer | biaya admin |
responeData.payment.nett | integer | nominal yang harus dibayar |
Response Sample
{
"responseCode": "2000300",
"responseMessage": "Invoice Found",
"responseDate": "2022-04-11T15:27:43+07:00",
"responseData": {
"id": "a3ef3f93-7fcb-439a-889e-14976a46492e",
"ref": "01002676201405,201406,201407,201408,201409,201410",
"created_at": "2022-04-11 11:41:45",
"redirect_url": "https://checkout.bmstaging.id/HJHKvf1chmn",
"back_url": "https://your-invoice-url.com",
"status": "PAID",
"customer": {
"name": "PERM. BUMI CITRA FAJ",
"email": "[email protected]",
"phone": "01002676"
},
"products": [
{
"uuid": "0b81e4b1-a1c7-4d96-985f-b24b7ed80b67",
"name": "01002676",
"qty": 1,
"price": "305300"
}
],
"payment": {
"uuid": "6b67178b-0378-4bee-b4ac-87945890ca0f",
"channel": "BSI",
"code": "164965211642",
"payment_ref": "10460",
"paid_amount": "306300",
"fee": "1000",
"nett": "305300",
"created_at": "2022-04-11T04:43:03.000000Z",
"updated_at": "2022-04-11T04:43:03.000000Z"
}
}
}