NICEPAY API
...
Advance API
Virtual Account - Advance API

Virtual Account Static

34min

Tentang API Virtual Account Static (Fix Open)



Pada metode pembayaran Virtual Account Static (fix open), Pelanggan dapat menggunakan nomor Virtual Account yang sama untuk melakukan transaksi secara berulang. Integrasi VA statis digunakan untuk metode pembayaran Fix Open VA.

  • Untuk mengetahui lebih lanjut mengenai informasi pembayaran Virtual Account, Anda dapat membaca di Virtual Account (VA).
  • Untuk pengaturan metode pembayaran Virtual Account secara umum, Anda dapat mengunjungi API Virtual Account atau pelajari penjelasan secara umum mengenai Panduan Bayar VA.



Merchant Registration


Sebelum menggunakan sistem NICEPAY, Merchant harus terdaftar terlebih dahulu dengan NICEPAY service. Silakan hubungi NICEPAY tim Sales NICEPAY di Marketing NICEPAY.


Kredensial

Deskripsi

iMid

Merchant ID

encodeKey

Merchant API Key

Untuk mendukung kebutuhan setup, silakan unduh file berikut sebagai NICEPAY library.



NICEPAY API Registration



NICEPAY API Registration bertujuan agar Merchant dapat mendaftarkan sistem API pada pembayaran di sistem Merchant dan terintegrasi dengan sistem dari NICEPAY. Tahapan ini dilakukan paling dahulu supaya sistem mengetahui bahwa Merchant yang bersangkutan sudah terdaftar secara resmi dan dapat terhubung dengan layanan dari NICEPAY.

API URL

https://www.nicepay.co.id/nicepay/api/vacctCustomerRegist.do

Request Method

POST

Merchant Token

SHA256(iMid+customerId+merchantKey)

Request Format

application/x-www-form-urlencoded



Request Parameter for Registration VA Static



Berikut ini adalah daftar parameter untuk melakukan pengajuan pendaftaran metode pembayaran Virtual Account tipe static (fix open). Parameter ini digunakan melalui platform pengujian API sebagai salah satu tahapan supaya sistem milik Merchant dapat terhubung dengan layanan dari NICEPAY.

Parameter

Tipe

Ukuran

Deskripsi

Contoh / Catatan

iMid

Required

AN

10

Merchant ID

FIXOPEN001

customerId

Required

N

Max 8 (Depend on Merchant Prefix)

Merchant Customer ID

10021198

customerNm

Required

AN

20 - 30

Customer Name

Jack

merchantToken

Required

AN

255

Merchant Token

c31fec3c0e66c9d8703f9f8221f7c450950d7d26822abe037ce33c12f462c785



Response Parameter untuk Registration VA Static



Berikut adalah response parameter dari hasil request parameter untuk meregistrasikan metode pembayaran Virtual Account Statistic.

Parameter

Tipe

Ukuran

Deskripsi

Contoh / Catatan

resultCd

Required

N

4

0000

resultMsg

Required

AN

255

Result message: Error Code

SUCCESS

customerID

Required

N

Max 8 (Depend on Merchant Prefix)

Merchant Customer ID

10021198

customerNm

AN

20 - 30

Merchant Customer Name

Jack

vacctInfoList

Required

Array of object



Bank Virtual Account List

Bank Virtual Account List

[ { "bankCd": "BDIN", "vacctNo": "7917019110021198" },...]



Sample JSON Registration Virtual Account Static


Form-urlencoded Request
JSON Response
Java Request


Vacct Info List

Parameter

Tipe

Ukuran

Deskripsi

Contoh / Catatan

bankCd

Required

AN

4

Bank Code

BDIN

vacctNo

Required

N

16

Virtual Account Number

7917019110021198

Sample JSON Vacct Account

JSON Vacct Account Response




NICEPAY Virtual Account Inquiry



NICEPAY Virtual Account Inquiry bertujuan untuk mendapatkan informasi Pelanggan serta nomor Virtual Account agar dapat dilakukan pemantauan untuk pengembangan berikutnya.

Pengaturan pada NICEPAY Virtual Account Inquiry bertujuan untuk mengumpulkan informasi daftar Virtual Account yang terdaftar dari Bank mana saja berdasarkan merFixId.

Target Url

https://www.nicepay.co.id/nicepay/api/vacctCustomerInquiry.do

Method

POST, GET

Description

Untuk melakukan pengecekan VA pada customerId

Merchant Token

SHA256(iMid+customerId+merchantKey)

Request Format

application/x-www-form-urlencoded



Request Parameter for Virtual Account Inquiry



Berikut ini adalah daftar parameter untuk melakukan request Virtual Account inquiry. Parameter ini digunakan melalui platform pengujian API sebagai salah satu tahapan supaya sistem milik Merchant dapat terhubung dengan sistem dari NICEPAY.

Parameter

Tipe

Ukuran

Deskripsi

Contoh / Catatan

iMid

Required

AN

10

Merchant ID

FIXOPEN001

customerId

Required

N

Max 8 (Depend on Merchant Prefix)

Merchant Customer ID

10021198

merchantToken

Required

AN

255

Merchant Token

c31fec3c0e66c9d8703f9f8221f7c450950d7d26822abe037ce33c12f462c785



Response Parameter for Inquiry



Berikut adalah response parameter dari hasil request parameter untuk mendaftarkan metode pembayaran Virtual Account Static.

Parameter

Tipe

Ukuran

Deskripsi

Contoh / Catatan

resultCd

Required

N

4

0000

resultMsg

Required

AN

255

Result Message: Error Code

SUCCESS

customerID

Required

N

Max 8 (Depend on Merchant Prefix)

Merchant Customer ID

10021198

customerNm

Required

A

20 - 30

Merchant Customer Name

Jack

vacctInfoList

Required

Array of object



Bank Virtual Account List

[

        {

            "bankCd": "BDIN",

            "vacctNo": "7917019110021198"

        },

        {

            "bankCd": "BNIA",

            "vacctNo": "11695109010021198"

        },

...

]



Sample JSON NICEPAY Virtual Account Inquiry


Form-Urlencode Request
JSON Response
Java Request


Vacct Info List

Parameter

Tipe

Ukuran

Deskripsi

Contoh / Catatan

bankCd

Required

AN

4

Bank Code

BDIN

vacctNo

Required

N

16

Virtual Account Number

7917019110021198

Sample JSON Vacct Account

JSON Vacct Account




NICEPAY Virtual Account Deposit



NICEPAY Virtual Account Deposit dalam sistem bertujuan untuk memeriksa status Virtual Account fix open dan untuk menampilkan seberapa banyak amt (amount) yang dibayarkan dengan tXid (ID transaksi) tertentu dan dalam waktu tertentu.

Target Url

https://www.nicepay.co.id/nicepay/api/vacctInquiry.do

Method

POST

Description

API Check Status For VA Fixopen

Merchant Token

SHA256(iMid+customerId+merchantKey)

Request Format

application/x-www-form-urlencoded



Request Parameter for Virtual Account Check Status



Berikut ini adalah daftar parameter untuk melakukan mengajukan pemeriksaan status deposit Virtual Account. Parameter ini digunakan melalui platform pengujian API sebagai salah satu tahapan supaya sistem milik Merchant dapat terhubung dengan sistem dari NICEPAY.

Parameter

Tipe

Ukuran

Deskripsi

Contoh / Catatan

iMid

Required

AN

10

Merchant ID

FIXOPEN001

vacctNo

Required

N

16

Virtual Account Number

8804910910021197

merchantToken

Required

AN

255

Merchant Token

20221215

startDt

Required

N

8

Request Start Date (YYYYMMDD)

20221222

endDt

Required

N

8

Request Start Date (YYYYMMDD)

75d137e8823108e47d04dadc3290cb36dc305d573323123f410c6f61acf1db63



Response Parameter for Virtual Account Check Status



Berikut adalah response parameter dari hasil request parameter untuk pemeriksaan status Virtual Account.

Parameter

Tipe

Ukuran

Deskripsi

Contoh / Catatan

resultCd

Required

N

4

0000

resultMsg

Required

AN

255

Result Message: Error Code

SUCCESS

vacctNo

Required

N

16

Virtual Account Number

8804910910021197

depositInfo

Required

Array of object



Bank Virtual Account List

[ { "bankCd": "BMRI", "date": "20221220", "time": "100733", "amt": "1600000", "tXid": "FIXOPEN00102202212201007334066", "status": "0", "referenceNo": "10021197" },...]



Sample JSON Virtual Account Deposit


Form-Urlencode Request
JSON Response
Java Request




NICEPAY Virtual Account Update



NICEPAY Virtual Account Update dalam sistem bertujuan untuk memperbarui informasi mengenai profil Virtual Account milik Merchant. Merchant dapat melakukan modifikasi pada Virtual Account untuk perbaharui atau hapus melalui updateType.

Target Url

https://www.nicepay.co.id/nicepay/api/vacctCustomerUpdate.do

Method

POST

Description

merficAcctNm API for Virtual Account Update

Merchant Token

SHA256(iMid+customerId+merchantKey)

Request format

application/x-www-form-urlencoded



Request Parameter for Virtual Account Update



Berikut ini adalah daftar parameter untuk melakukan request update dari transaksi yang dilakukan pada metode pembayaran Virtual Account tipe Static (fix open). Parameter ini digunakan melalui platform pengujian API sebagai salah satu tahapan supaya sistem milik Merchant dapat terhubung dengan layanan dari NICEPAY.

Parameter

Tipe

Ukuran

Deskripsi

Contoh / Catatan

iMid

Required

AN

10

Merchant ID

FIXOPEN001

customerId

Required

N

Max 8 (Depend on Merchant Prefix)

Customer ID

10021197

merchantToken

Required

AN

255

Merchant Token

c92a4372a8417d96407becec2c3221033358c16e1c29b5ccf7fe0cec211ecbf4

customerNm

Required

AN

20 - 30

Customer Name

Howard

updateType

Required

N

2

1: Create

2: Update

3: Delete

2



Response Parameter for Virtual Account Update



Berikut adalah response parameter dari hasil request parameter untuk Virtual Account update.

Parameter

Tipe

Ukuran

Deskripsi

Contoh / Catatan

resultCd

Required

N

4

0000

resultMsg

Required

AN

255

Result Message: Error Code

SUCCESS

customerNm

Required

AN

20 - 30

Merchant Customer Name

Howard

customerId

Required

N

Max 8 (Depend on Merchant Prefix)

Merchant Customer ID

10021197

vacctInfoList

Required

Array of Object



Bank Virtual Account List

[ { "bankCd": "BDIN", "vacctNo": "7917019110021197" },...]



Sample JSON for VA Update


Form-Urlencode Request
JSON Response
Java Request




See Also

Kunjungi halaman Status Inquiry - API Checkout untuk mengetahui API untuk memeriksa status inquiry khusus Checkout.

Kunjungi halaman Cancel - API Checkout untuk mengetahui API untuk membatalkan transaksi khusus Checkout.

Kunjungi halaman Status Inquiry - API Virtual Account untuk mengetahui API Virtual Account untuk memeriksa status inquiry pada API khusus Payment.

Kunjungi halaman Cancel - API Virtual Account untuk mengetahui API Virtual Account untuk membatalkan transaksi pada API khusus Payment.