Virtual Account SNAP
Create Virtual Account
Panduan lengkap untuk membuat Virtual Account menggunakan API Paylabs.
HTTPMethod: POST
${ROOT_URL}/v1.0/transfer-va/create-va
Service Code: 27
Version: 1.0
ServiceGroup: transfer-va
ProductType: create-va
Request
Header
| Parameter | Required | Type | Length | Remarks |
|---|---|---|---|---|
| Content-Type | M | String | - | Fixed value application/json |
| Authorization | C | String | Dynamic | Nilai access_token, jika Anda menggunakan enkripsi symmetric, kolom ini wajib diisi |
| X-TIMESTAMP | M | String | 64 | Waktu Jakarta, format 2021-11-29T09:22:18+07:00 |
| X-PARTNER-ID | M | String | 36 | Merchant ID |
| X-EXTERNAL-ID | M | String | 12 | Request ID |
| X-SIGNATURE | M | String | Dynamic | Signature strings |
| X-IP-ADDRESS | M | String | 15 | IP Client (IPv4) |
Body
| Parameter | Required | Type | Length | Remarks |
|---|---|---|---|---|
| partnerServiceId | M | String | 8 | turunan X-PARTNER-ID, mirip dengan kode perusahaan, 8 digit spasi disebelah kiri |
| customerNo | M | String | 20 | No virtualAccount 00000000000000000000 |
| virtualAccountNo | M | String | 28 | partnerServiceId + customerNo |
| virtualAccountName | M | String | 255 | Nama Customer. contoh: Jokul Doe |
| virtualAccountEmail | O | String | 255 | |
| virtualAccountPhone | O | String | 30 | No Hp, Format: 62xxxxxxxxxxxxx |
| trxId | M | String | 64 | No Transaksi Merchant |
| +totalAmount | M | Object | - | Transaction amount |
| 「value | M | String | 16,2 | Amount dengan 2 digit angka dibelakang koma.contoh: 10000.00 , static va : 0.00 |
| 「currency | M | String | 3 | Mata Uang. fixed value : IDR |
| +billDetails | O | List | - | Array dengan maksimal 24 Objects(Sementara belum tersedia) |
| 「billCode | O | String | 2 | Kode tagihan untuk Customer pilih |
| 「billNo | O | String | 18 | No taghan dari Partner |
| 「billName | O | String | 20 | Bill Name |
| 「billShortName | O | String | 18 | Bill Name to shown to |
| +billDescription | O | Object | - | Deskripsi Tagihan |
| 「english | O | String | 18 | Deskripsi Tagihan menggunakan bahasa inggris |
| 「indonesia | O | String | 18 | Deskripsi Tagihan menggunakan bahasa Indonesia |
| 「billSubCompany | O | String | 5 | - |
| +billAmount | O | Object | - | - |
| 「value | M | String | 16,2 | Amount dengan 2 digit angka dibelakang koma. contoh: 10000.00 |
| 「currency | M | String | 3 | Mata Uang. fixed value : IDR |
| +additionalInfo | O | Object | - | - |
| +freeTexts | O | List | - | Array dengan maksimal 25 Objects |
| 「english | O | String | 32 | Akan ditampilkan di Channel |
| 「indonesia | O | String | 32 | Akan ditampilkan di Channel |
| virtualAccountTrxType | O | String | 1 | Type Virtual Account |
| +feeAmount | O | Object | - | Transaction Amount.(Sementara Tidak Tersedia) |
| 「value | M | String | 16,2 | Amount dengan 2 digit angka dibelakang koma. contoh: 10000.00 |
| 「currency | M | String | 3 | Mata Uang. fixed value : IDR |
| expiredDate | M | String | 25 | waktu kadaluwarsa Virtual Account.ISO-8601 contoh: 2020-12-31T23:59:59-07:00 |
| +additionalInfo | M | Object | - | Informasi tambahan |
| 「paymentType | M | String | 32 | Type Payment |
| 「storeId | O | String | 32 | Jika Merchant memiliki cabang dan ingin membuat order dengan ID cabang |
paymentType
VA: Ini akan kedaluwarsa setelah satu pembayaran berhasil dalam masa berlaku. MultipleVA: Jumlah tetap dapat dibayarkan beberapa kali selama masa berlaku. Static***VA: Anda dapat membayar jumlah berapa pun beberapa kali selama masa berlaku
| Payment type | Encodings (code) |
|---|---|
| BCA | BCAVA, MultipleBCAVA, StaticBCAVA |
| BNI | BNIVA, MultipleBNIVA |
| BRI | BRIVA, MultipleBRIVA |
| BSI | BSIVA, MultipleBSIVA |
| CIMB | CIMBVA, MultipleCIMBVA |
| Danamon | DanamonVA, MultipleDanamonVA |
| INA | INAVA, MultipleINAVA |
| Permata | PermataVA, MultiplePermataVA |
| Mandiri | MandiriVA, MultipleMandiriVA, StaticMandiriVA |
| Maybank | MaybankVA, MultipleMaybankVA |
| Muamalat | MuamalatVA, MultipleMuamalatVA |
| Sinarmas | SinarmasVA, MultipleSinarmasVA |
| BNC | BNCVA, MultipleBNCVA, StaticBNCVA |
| Nobu | NobuVA, MultipleNobuVA, StaticNobuVA |
Example
POST .../v1.0/transfer-va/create-va HTTP/1.2
Content-type: application/json
X-TIMESTAMP: 2020-12-21T14:56:11+07:00
X-SIGNATURE: 85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5
X-ORIGIN: www.hostname.com
X-PARTNER-ID: 010001
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
{
"partnerServiceId":" 088899",
"customerNo":"00000000000000000000",
"virtualAccountNo":" 08889912345678901234567890",
"virtualAccountName":"Jokul Doe",
"virtualAccountEmail":"jokul@email.com",
"virtualAccountPhone":"6281828384858",
"trxId":"abcdefgh1234",
"totalAmount":{
"value": "12345678.00",
"currency": "IDR"
},
"billDetails":[
{
"billCode": "01",
"billNo": "123456789012345678",
"billName": "Bill A for Jan",
"billShortName": "Bill A",
"billDescription":{
"english": "Maintenance",
"indonesia": "Pemeliharaan"
},
"billSubCompany": "00001",
"billAmount":{
"value": "12345678.00",
"currency": "IDR"
},
"additionalInfo":{
}
}
],
"freeTexts":[
{
"english": "Free text",
"indonesia": "Tulisan bebas"
}
],
"virtualAccountTrxType":"1",
"feeAmount":{
"value": "12345678.00",
"currency": "IDR"
},
"expiredDate":"2020-12-31T23:59:59-07:00",
"additionalInfo":{
"paymentType": "XXXVA"
}
}Response
Header
| Parameter | Required | Type | Length | Remarks |
|---|---|---|---|---|
| Content-Type | M | String | - | Fixed value application/json |
| X-TIMESTAMP | M | String | 64 | Waktu Jakarta, format 2021-11-29T09:22:18+07:00 |
Body
| Parameter | Required | Type | Length | Remarks |
|---|---|---|---|---|
| responseCode | M | String | 7 | Kode Response. response code = HTTP status code + service code + case code |
| responseMessage | M | String | 150 | Pesan Response |
| +virtualAccountData | O | Object | - | - |
| 「partnerServiceId | M | String | 8 | turunan X-PARTNER-ID, mirip dengan kode perusahaan, 8 digit spasi disebelah kiri |
| 「customerNo | M | String | 20 | No virtualAccount. fixed value 00000000000000000000 |
| 「virtualAccountNo | M | String | 20 | No virtualAccount |
| 「virtualAccountName | M | String | 255 | Nama Customer. contoh: Jokul Doe |
| 「virtualAccountEmail | O | String | 255 | |
| 「virtualAccountPhone | O | String | 30 | No Hp, Format: 62xxxxxxxxxxxxx |
| 「trxId | O | String | 32 | Platform Order No / Order No |
| +totalAmount | O | Object | - | Transaction Amount |
| 「value | M | String | 16,2 | Amount dengan 2 digit angka dibelakang koma.contoh: 10000.00 , static va : 0.00 |
| 「currency | M | String | 3 | Mata Uang. fixed value : IDR |
| +billDetails | O | List | - | Array dengan maksimal 24 Objects(Sementara Tidak Tersedia) |
| 「billCode | O | String | 2 | Kode tagihan untuk Customer pilih |
| 「billNo | O | String | 18 | Bill No dari Partner |
| 「billName | O | String | 20 | Bill Name |
| 「billShortName | O | String | 10 | Bill Name to shown to |
| +billDescription | O | Object | - | Deskripsi Tagihan |
| 「english | O | String | 18 | Deskripsi Tagihan menggunakan bahasa inggris |
| 「indonesia | O | String | 18 | Deskripsi Tagihan menggunakan bahasa Indonesia |
| 「billSubCompany | O | String | 5 | Kode Product Partner |
| +billAmount | O | Object | - | Transaction Amount |
| 「value | M | String | 16,2 | Amount dengan 2 digit angka dibelakang koma. contoh: 10000.00 |
| 「currency | M | String | 3 | Mata Uang. fixed value : IDR |
| +additionalInfo | O | Object | - | Informasi Tambahan untuk customer khusus untuk setiap tagihan |
| +freeTexts | O | List | - | Array dengan maksimal 25 Objects |
| 「english | O | String | 32 | Akan ditampilkan di Channel |
| 「indonesia | O | String | 32 | Akan ditampilkan di Channel |
| 「virtualAccountTrxType | O | String | 1 | Type Virtual Account |
| +feeAmount | O | Object | - | Transaction Amount. |
| 「value | M | String | 16,2 | Amount dengan 2 digit angka dibelakang koma. contoh: 10000.00 |
| 「currency | M | String | 3 | Mata Uang. fixed value : IDR |
| 「expiredDate | M | String | 25 | waktu kadaluwarsa Virtual Account.ISO-8601 |
| +additionalInfo | O | Object | - | Informasi tambahan untuk customer gunakan |
Example
Content-type: application/json
X-TIMESTAMP: 2020-12-21T14:36:19+07:00
{
"responseCode":"2002700",
"responseMessage":"Success",
"virtualAccountData":{
"partnerServiceId":" 088899",
"customerNo":"00000000000000000000",
"virtualAccountNo":" 08889912345678901234567890",
"virtualAccountName":"Jokul Doe",
"virtualAccountEmail":"jokul@email.com",
"virtualAccountPhone":"6281828384858",
"trxId":"abcdefgh1234",
"totalAmount":{
"value": "12345678.00",
"currency": "IDR"
},
"billDetails":[
{
"billCode": "01",
"billNo": "123456789012345678",
"billName": "Bill A for Jan",
"billShortName": "Bill A",
"billDescription":{
"english": "Maintenance",
"indonesia": "Pemeliharaan"
},
"billSubCompany": "00001",
"billAmount":{
"value": "12345678.00",
"currency": "IDR"
},
"additionalInfo":{
}
}
],
"freeTexts":[
{
"english": "Free text",
"indonesia": "Tulisan bebas"
}
],
"virtualAccountTrxType":"1",
"feeAmount":{
"value": "12345678.00",
"currency": "IDR"
},
"expiredDate":"2020-12-31T23:59:59-07:00",
"additionalInfo":{
"deviceId": "12345679237",
"channel": "mobilephone"
}
}
}