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

ParameterRequiredTypeLengthRemarks
Content-TypeMString-Fixed value application/json
AuthorizationCStringDynamicNilai access_token, jika Anda menggunakan enkripsi symmetric, kolom ini wajib diisi
X-TIMESTAMPMString64Waktu Jakarta, format 2021-11-29T09:22:18+07:00
X-PARTNER-IDMString36Merchant ID
X-EXTERNAL-IDMString12Request ID
X-SIGNATUREMStringDynamicSignature strings
X-IP-ADDRESSMString15IP Client (IPv4)

Body

ParameterRequiredTypeLengthRemarks
partnerServiceIdMString8turunan X-PARTNER-ID, mirip dengan kode perusahaan, 8 digit spasi disebelah kiri
customerNoMString20No virtualAccount 00000000000000000000
virtualAccountNoMString28partnerServiceId + customerNo
virtualAccountNameMString255Nama Customer. contoh: Jokul Doe
virtualAccountEmailOString255Email
virtualAccountPhoneOString30No Hp, Format: 62xxxxxxxxxxxxx
trxIdMString64No Transaksi Merchant
+totalAmountMObject-Transaction amount
「valueMString16,2Amount dengan 2 digit angka dibelakang koma.contoh: 10000.00 , static va : 0.00
「currencyMString3Mata Uang. fixed value : IDR
+billDetailsOList-Array dengan maksimal 24 Objects(Sementara belum tersedia)
「billCodeOString2Kode tagihan untuk Customer pilih
「billNoOString18No taghan dari Partner
「billNameOString20Bill Name
「billShortNameOString18Bill Name to shown to
+billDescriptionOObject-Deskripsi Tagihan
「englishOString18Deskripsi Tagihan menggunakan bahasa inggris
「indonesiaOString18Deskripsi Tagihan menggunakan bahasa Indonesia
「billSubCompanyOString5-
+billAmountOObject--
「valueMString16,2Amount dengan 2 digit angka dibelakang koma. contoh: 10000.00
「currencyMString3Mata Uang. fixed value : IDR
+additionalInfoOObject--
+freeTextsOList-Array dengan maksimal 25 Objects
「englishOString32Akan ditampilkan di Channel
「indonesiaOString32Akan ditampilkan di Channel
virtualAccountTrxTypeOString1Type Virtual Account
+feeAmountOObject-Transaction Amount.(Sementara Tidak Tersedia)
「valueMString16,2Amount dengan 2 digit angka dibelakang koma. contoh: 10000.00
「currencyMString3Mata Uang. fixed value : IDR
expiredDateMString25waktu kadaluwarsa Virtual Account.ISO-8601 contoh: 2020-12-31T23:59:59-07:00
+additionalInfoMObject-Informasi tambahan
「paymentTypeMString32Type Payment
「storeIdOString32Jika 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 typeEncodings (code)
BCABCAVA, MultipleBCAVA, StaticBCAVA
BNIBNIVA, MultipleBNIVA
BRIBRIVA, MultipleBRIVA
BSIBSIVA, MultipleBSIVA
CIMBCIMBVA, MultipleCIMBVA
DanamonDanamonVA, MultipleDanamonVA
INAINAVA, MultipleINAVA
PermataPermataVA, MultiplePermataVA
MandiriMandiriVA, MultipleMandiriVA, StaticMandiriVA
MaybankMaybankVA, MultipleMaybankVA
MuamalatMuamalatVA, MultipleMuamalatVA
SinarmasSinarmasVA, MultipleSinarmasVA
BNCBNCVA, MultipleBNCVA, StaticBNCVA
NobuNobuVA, 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

ParameterRequiredTypeLengthRemarks
Content-TypeMString-Fixed value application/json
X-TIMESTAMPMString64Waktu Jakarta, format 2021-11-29T09:22:18+07:00

Body

ParameterRequiredTypeLengthRemarks
responseCodeMString7Kode Response. response code = HTTP status code + service code + case code
responseMessageMString150Pesan Response
+virtualAccountDataOObject--
「partnerServiceIdMString8turunan X-PARTNER-ID, mirip dengan kode perusahaan, 8 digit spasi disebelah kiri
「customerNoMString20No virtualAccount. fixed value 00000000000000000000
「virtualAccountNoMString20No virtualAccount
「virtualAccountNameMString255Nama Customer. contoh: Jokul Doe
「virtualAccountEmailOString255Email
「virtualAccountPhoneOString30No Hp, Format: 62xxxxxxxxxxxxx
「trxIdOString32Platform Order No / Order No
+totalAmountOObject-Transaction Amount
「valueMString16,2Amount dengan 2 digit angka dibelakang koma.contoh: 10000.00 , static va : 0.00
「currencyMString3Mata Uang. fixed value : IDR
+billDetailsOList-Array dengan maksimal 24 Objects(Sementara Tidak Tersedia)
「billCodeOString2Kode tagihan untuk Customer pilih
「billNoOString18Bill No dari Partner
「billNameOString20Bill Name
「billShortNameOString10Bill Name to shown to
+billDescriptionOObject-Deskripsi Tagihan
「englishOString18Deskripsi Tagihan menggunakan bahasa inggris
「indonesiaOString18Deskripsi Tagihan menggunakan bahasa Indonesia
「billSubCompanyOString5Kode Product Partner
+billAmountOObject-Transaction Amount
「valueMString16,2Amount dengan 2 digit angka dibelakang koma. contoh: 10000.00
「currencyMString3Mata Uang. fixed value : IDR
+additionalInfoOObject-Informasi Tambahan untuk customer khusus untuk setiap tagihan
+freeTextsOList-Array dengan maksimal 25 Objects
「englishOString32Akan ditampilkan di Channel
「indonesiaOString32Akan ditampilkan di Channel
「virtualAccountTrxTypeOString1Type Virtual Account
+feeAmountOObject-Transaction Amount.
「valueMString16,2Amount dengan 2 digit angka dibelakang koma. contoh: 10000.00
「currencyMString3Mata Uang. fixed value : IDR
「expiredDateMString25waktu kadaluwarsa Virtual Account.ISO-8601
+additionalInfoOObject-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"
     }
   }
}