Create HTML5 URL
Buat link halaman pembayaran HTML5 dari Paylabs.
Request URL
URL: ${ROOT_URL}/payment/v2.3/h5/createLink
HTTPMethod: POST
EndpointUrl: /payment/v2.3/h5/createLink
URL HTML5 adalah halaman pembayaran Paylabs sehingga merchant tidak perlu membangun halaman sendiri. Inquiry status, notifyUrl, dan redirectUrl sama dengan metode API.
HTML5 Request Parameters
Header
| Field Name | Type | Value | Required |
|---|---|---|---|
| Content-Type | String(30) | Isi dengan nilai "application/json;charset=utf-8" | Yes |
| X-TIMESTAMP | String(29) | Waktu saat ini, dengan format 2022-09-16T16:58:47.964+07:00 | Yes |
| X-SIGNATURE | String(64) | Signature. Untuk selengkapnya cek | Yes |
| X-PARTNER-ID | String(20) | Merchant ID | Yes |
| X-REQUEST-ID | String(64) | ID unik merepresentasikan setiap request yang dikirim | Yes |
Body
| Parameter | Type | Required | Remarks |
|---|---|---|---|
| requestId | String(64) | Yes | Kode unik untuk setiap request |
| merchantId | String(20) | Yes | ID unik yang disediakan oleh payment gateway ke merchant |
| storeId | String(30) | No | Jika Merchant memiliki cabang dan ingin membuat order dengan ID cabang |
| merchantTradeNo | String(32) | Yes | Kode unik yang dibuat oleh Merchant untuk setiap transaksi |
| amount | Decimal(12,2) | Yes | Dalam Rupiah, dengan dua angka belakang koma |
| payer | String(60) | No | Nama orang yang melakukan pembayaran |
| phoneNumber | String(20) | Yes | Nomor telepon pelanggan |
| productName | String(100) | Yes | Nama layanan atau produk |
| notifyUrl | String(200) | No | URL yang akan ditembak saat terjadi pembayaran. Untuk parameternya cek di bagian Inquiry Order |
| redirectUrl | String(200) | Yes | Baik saat sukses ataupun gagal, akan diarahkan ke URL tersebut |
| lang | String(10) | No | Default Bahasa Indonesia; gunakan en untuk Bahasa Inggris |
| paymentType | String(20) | No | Nama tipe pembayaran. Jika kosong, customer bisa memilih dari opsi yang tersedia |
| feeType | String(3) | No | Jenis pengurangan biaya layanan: BEN/OUR. Default BEN. Jika OUR, biaya layanan ditambahkan ke nominal order otomatis. |
HTML5 Response Parameters
Header
| Field Name | Type | Value | Required |
|---|---|---|---|
| Content-Type | String(30) | Isi dengan nilai "application/json;charset=utf-8" | Yes |
| X-TIMESTAMP | String(29) | Waktu saat ini, dengan format 2022-09-16T16:58:47.964+07:00 | Yes |
| X-SIGNATURE | String(64) | Signature. Untuk selengkapnya cek | Yes |
| X-PARTNER-ID | String(20) | Merchant ID | Yes |
| X-REQUEST-ID | String(64) | ID unik merepresentasikan setiap request yang dikirim | Yes |
Body
| Parameter | Type | Required | Remarks |
|---|---|---|---|
| errCode | String(32) | No | 0 berarti sukses, lainnya cek Kode Error |
| errCodeDes | String(128) | No | Deskripsi error |
| requestId | String(64) | Yes | ID unik untuk setiap request |
| merchantId | String(20) | No | Merchant ID |
| storeId | String(30) | No | Jika menggunakan store cabang |
| merchantTradeNo | String(32) | Yes | Nomor order merchant |
| url | String(200) | No | Payment URL. Jika paymentType kosong, halaman menampilkan opsi pembayaran untuk dipilih customer. |
Example
Request
POST /payment/v2.3/h5/createLink
# HTTP Header
Content-Type: application/json;charset=utf-8
X-TIMESTAMP: 2022-09-16T16:58:47.964+07:00
X-SIGNATURE: xxxxxxxxx
X-PARTNER-ID: 010001
X-REQUEST-ID: xxxxxxxxxxxxxxxxxxxxxxxx
# HTTP Body
{
"merchantId":"0010001",
"merchantTradeNo":"11649757268000",
"requestId":"21649757268000",
"amount":"10200",
"phoneNumber":00000000,
"productName":"apple",
"redirectUrl":"https://www.google.com",
"lang":"en",
"payer":"test"
}Response
POST /payment/v2.3/h5/createLink
# HTTP Header
Content-Type: application/json;charset=utf-8
X-TIMESTAMP: 2022-09-16T16:58:47.964+07:00
X-SIGNATURE: xxxxxxxxx
X-PARTNER-ID: 010001
X-REQUEST-ID: xxxxxxxxxxxxxxxxxxxxxxxx
# HTTP Body
{
"merchantId":"0010001",
"requestId":"21649757268000",
"errCode":"0",
"url":"http://paylabs-dev.com/payer/en-home-index.html?k=c2b2da7c8ce8b00691a68c38d77e000e9f412199770e6b1adf72bbc6c2914ee808f93e627825ecb4679cd31eea1c5114"
}