Skip to main content

Find Invoice

Api ini digunakan untuk mencari invoice berdasarkan id.

Spesification

Nama APIFind Invoice
Http MethodGET
Path.../api/find/{id}

header wajib yang harus dikirimkan pada saat request adalah:

HeaderDeskripsi
X-Winpay-TimestampWaktu tanggal transaksi, dengan format YYYY-MM-DDTHH:mm:ss+07:00. Waktu harus dalam GMT+7 (waktu Jakarta)
X-Winpay-SignatureSignature hasil generate dari merchant
X-Winpay-KeyClient key merchant
Content-Typeharus application/json

Response

berikut adalah body response yang akan diterima:

ParameterTipeDeskripsi
responseCodestringkode respon
responseMessagestringpesan respon
responseDatedatetanggal respon
responeDatajson element-
responeData.idstringid untuk transaksi terkait
responeData.refstringnomor referensi untuk transaksi terkait
responeData.created_atdatetanggal transaksi dibuat
responeData.back_urlstringurl yang dituju atau ditampilkan setelah customer selesai melakukan pembayaran
responeData.statusstringstatus dari pembayaran
responeData.customerjson element-
responeData.customer.namestringnama customer
responeData.customer.emailstringemail customer
responeData.customer.phonestringnomor HP/telepon customer
responeData.productsjson element-
responeData.products[].uuidstringid untuk transaksi produk terkait
responeData.products[].namestringnama produk
responeData.products[].qtyintegerjumlah produk
responeData.products[].priceintegerharga produk
responeData.paymentjson element-
responeData.payment.uuidstringid untuk pembayaran terkait
responeData.payment.channelstringchannel yang digunakan untuk melakukan pembayaran
responeData.payment.codestringkode yang digunakan untuk melakukan pembayaran
responeData.payment.payment_refstringnomor referensi untuk pembayaran terkait
responeData.payment.paid_amountintegertotal tagihan
responeData.payment.feeintegerbiaya admin
responeData.payment.nettintegernominal 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"
}
}
}