Create Invoice
API ini digunakan untuk membuat/request invoice.
Spesification
Nama API | Create Invoice |
Http Method | POST |
Path | .../api/create |
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 |
Request
berikut adalah body request yang harus dikirimkan:
Parameter | Tipe | Deskripsi |
---|---|---|
customer | JSON Object | - |
customer.name | String | nama customer |
customer.email | String | email customer |
customer.phone | String | nomor HP/telepon customer |
invoice | JSON Object | - |
invoice.ref | String | nomor referensi untuk transaksi terkait |
invoice.products | Array of JSON Object | - |
invoice.products[].name | String | nama produk |
invoice.products[].qty | Integer | jumlah produk |
invoice.products[].price | Integer | harga produk/nominal yang harus dibayar |
back_url | String URL/Javascript Back Command | url yang dituju atau ditampilkan setelah customer selesai melakukan pembayaran |
interval | Integer | setting expired untuk channel yang direquest (min:60 menit, max:120 menit) |
Request Sample
{
"customer": {
"name": "Delina Prasetya",
"email": "gigih.putri@corp.bm.co.id",
"phone": "082342341"
},
"invoice": {
"ref": "111130",
"products": [
{
"name": "01002676",
"qty": 1,
"price": 260000
}
]
},
"back_url": "https://your-invoice-url.com",
"interval": 120
}
Response
berikut adalah body response yang akan diterima:
Parameter | Tipe | Deskripsi |
---|---|---|
responseCode | String | kode respon |
responseMessage | String | pesan respon |
responseDate | Date | tanggal respon |
responseData | JSON Object | - |
responseData.id | String | id transaksi |
responseData.ref | String | nomor referensi untuk transaksi terkait |
responseData.created_at | Date | waktu transaksi terbuat |
responseData.redirect_url | String | url chackout page |
responseData.back url | String URL/Javascript Back Command | url yang dituju atau ditampilkan setelah customer selesai melakukan pembayaran |
responseData.customer | JSON Object | - |
responseData.customer.name | String | nama customer |
responseData.customer.email | String | email customer |
responseData.customer.phone | String | nomor HP/telepon customer |
responseData.products | Array of JSON Object | - |
responseData.products[].uuid | String | id untuk transaksi produk terkait |
responseData.products[].name | String | nama produk |
responseData.products[].qty | Integer | jumlah produk |
responseData.products[].price | Integer | harga produk/nominal yang harus dibayar |
Response Sample
{
"responseCode": "2010300",
"responseMessage": "Invoice created",
"responseDate": "2023-10-25T14:12:14+07:00",
"responseData": {
"id": "2edff262-6228-4da1-96d7-729bf9fc85f0",
"ref": "0000001792131232161",
"created_at": "2023-10-25 14:12:14",
"redirect_url": "https://checkout.winpay.id/upu90zxyid",
"back_url": "https://your-invoice-url.com",
"customer": {
"name": "Delina Prasetya",
"email": "gigih.putri@corp.bm.co.id",
"phone": "082342341"
},
"products": [
{
"uuid": "92cd6096-ab4a-4e79-be61-c4cdbeedd281",
"name": "01002676",
"qty": 1,
"price": 260000
}
]
}
}