--- title: Payment - API NICEPAY Inquiry Virtual Account SNAP slug: nicepay-api-snap-payment-nicepay-inquiry-virtual-account description: Informasi tentang Payment - API NICEPAY Inquiry Virtual Account SNAP yang terdapat pada sistem NICEPAY image: https://archbee-image-uploads.s3.amazonaws.com/ZHvSjR5ZrsoxwKbJa3xmo/aiqn-GBHEPpA6P0TNmXWc_microsoftteams-image.png icon: {"faIcon":"fa-solid fa-book"} docTags: createdAt: 2023-06-26T03:03:16.159Z --- # Tentang Payment - API NICEPAY Inquiry Virtual Account SNAP *** Bagian ini berisi tentang informasi terkait API dengan standar SNAP yang digunakan pada metode pembayaran Virtual Account dengan fitur NICEPAY Inquiry Virtual Account (NIVA) yang memberikan kebebasan untuk Merchant menyimpan data pelanggan dan membuat nomor Virtual Account sendiri di sistemnya selama masih mengikuti ketentuan pembuatan nomor VA dari NICEPAY. # Payment - API NICEPAY Inquiry Virtual Account SNAP *** :::hint{type="warning"} Silakan mengajukan akses token terlebih dahulu untuk melakukan autentikasi melalui bagian [Request Access Token - API NICEPAY Inquiry Virtual Account SNAP](docId\:tbDHyMKVQK7C20nUkjB0N). ::: | **Service Code** | `25` | | ---------------- | ------------------------------------------------ | | **API Endpoint** | `[merchant-domain]/api/v1.0/transfer-va/payment` | | **HTTP Method** | `HTTP` `POST` | | **Description** | Untuk melakukan pembayaran transaksi NIVA | | **Content-type** | `application/json` | :::hint{type="info"} Pada saat melakukan proses integrasi, NICEPAY akan mengirimkan Public Key kepada Merchant. Kemudian, Merchant wajib memberi informasi terkait *endpoint *API Inquiry VA dan mengirimkan Client ID & Client Secret sesuai dengan spesifikasi NICEPAY kepada tim NICEPAY. Hal tersebut perlu dilakukan agar NICEPAY dapat mengajukan akses token dan melakukan *inquiry* data Pelanggan yang berada di sisi Merchant. Sehingga, proses pembayaran dapat dijalankan dengan lancar oleh Pelanggan Anda. ::: ## Request Payment Header Parameter | **Parameter** | **Tipe** | **Ukuran** | **Kebutuhan** | **Deskripsi** | **Contoh** | | --------------- | -------- | ---------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | | `Content-Type` | String | | Mandatory | `Application / JSON` | | | `Authorization` | String | | Mandatory | Bearer “`access_token`” | | | `X-TIMESTAMP` | String | | Mandatory | Using ISO 8601 as timestamp format.
Transaction date time, in format `YYYYMMDDTHH:mm:ss+07:00`.
Time must be in GMT+7 (Jakarta time).
`2022-03-21T10:11:40+07:00`. | | | `X-SIGNATURE` | String | | Mandatory | Signature will be generated by Merchant.
[Panduan X-Signature - Symmetric](docId\:UZex33ReLyENKOgbJJnYp) | | | `X-PARTNER-ID` | String | 20 | Mandatory | `X-PARTNER-ID` = `CLIENT_ID` | | | `X-EXTERNAL-ID` | String | 40 | Mandatory | Unique Reference Number
(`41807553358950093184`) | | | `CHANNEL-ID` | String | | Mandatory | Unique Channel Merchant Credential ID Number.
Client ID + "01" = Channel ID
`"IONPAYTEST" + "01" = "IONPAYTEST01"` | IONPAYTEST01 | ## Request Payment Body Parameter | **Parameter** | **Tipe** | **Ukuran** | **Kebutuhan** | **Deskripsi** | | ----------------------- | -------- | ---------- | ------------- | ------------------------------------------------------ | | `partnerServiceId` | String | 20 | Mandatory | Partner Service ID / Prefix | | `customerNo` | String | 40 | Mandatory | Customer Number | | `virtualAccountNo` | String | 25 | Mandatory | Virtual Account Number | | `virtualAccountName` | String | 100 | Optional | Virtual Account Name | | `trxId` | String | 40 | Mandatory | Merchant Order Number | | `paymentRequestId` | String | 128 | Mandatory | TXID (Transaction ID Generated by NICEPAY) | | `hashedSourceAccountNo` | String | 32 | Optional | Source account number in hash or unhash depend on Bank | | `sourceBankCode` | String | 11 | Optional | Source account Bank | | `paidAmount` | Object | | Mandatory | Total Amount
`"paidAmount": {...}` | | `value` | String | 12 | Mandatory | Value | | `currency` | String | 3 | Mandatory | Currency | | `trxDateTime` | String | 25 | Optional | Date Transaction | | `additionalInfo` | Object | | Mandatory | Additional Information
`"additionalInfo": {...}` | | `bankCd` | String | 4 | Mandatory | [Bank Code - API SNAP](docId:9WOQy5-1hlf_uCwshSDHO) | ## Response Payment Parameter | **Parameter** | **Tipe** | **Ukuran** | **Kebutuhan** | **Deskripsi** | | -------------------- | -------- | ---------- | ------------- | ---------------------------------------------------------------------------- | | `responseCode` | String | | Mandatory | [General Response Code and Message - API SNAP](docId\:lKqJXSl5CMKdXYXxHYYSs) | | `responseMessage` | String | | Mandatory | Response Message | | `virtualAccountData` | Object | | Mandatory | | | `partnerServiceId` | String | 20 | Mandatory | Partner Service ID / Prefix | | `customerNo` | String | 40 | Mandatory | Customer Number | | `virtualAccountNo` | String | 25 | Mandatory | Virtual Account Number | | `virtualAccountName` | String | 100 | Mandatory | Virtual Account Name | | `trxId` | String | 40 | Mandatory | Reference Number from Merchant | | `paymentRequestId` | String | 128 | Mandatory | TXID (Transaction ID Generated by NICEPAY) | | `paidAmount` | Object | | Mandatory | Total Amount
`"paidAmount": {...}` | | `value` | String | 12 | Mandatory | Transaction Amount | | `currency` | String | 3 | Mandatory | Currency | | `trxDateTime` | String | 25 | Optional | Date Transaction | | `additionalInfo` | Object | | Optional | Additional Information
`"additionalInfo": {...}` | | `goodsNm` | String | 200 | Mandatory | Goods Name | ## Sample Parameter :::CodeblockTabs Sample Request ```json //HEADER SECTION Content-Type: application/json Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJJT05QQVlURVNUIiwiaXNzIjoiTklDRVBBWSIsIm5hbWUiOiJCUklOIiwiZXhwIjoiMjAyNC0wMi0xMVQwODowOTozNVoifQ==.aIybLX36dYwfFvW7dcoenXkOe2EAwIYq84ZtPuIf3K8= X-TIMESTAMP: 2024-12-31T10:11:40+07:00 X-SIGNATURE: ufBw7R8RhW79IOiV/Hlv607M60qzAYBv8uZmbSrYb6/Thlo/FhQVP4xRyelUehoSS9o+QS6vWTKb/ygtucC+tQ== X-PARTNER-ID: FIXOPEN001 X-EXTERNAL-ID: tXid202402111402271707638113 CHANNEL-ID: FIXOPEN001 { "partnerServiceId": "70151021", "customerNo": "10000001", "virtualAccountNo": "7015102110000001", "virtualAccountName": "John Test", "trxId": "ref100000001", "trxDateTime": "2024-02-01T15:40:06+07:00", "paymentRequestId": "FIXOPEN0010000000006", "hashedSourceAccountNo": "abcdefghij12345", "sourceBankCode": "008", "paidAmount": { "value": "10000.00", "currency": "IDR" }, "additionalInfo": { "bankCd": "BMRI", } } ``` Sample Response ```json { "responseCode": "2002500", "responseMessage": "Successful", "virtualAccountData": { "partnerServiceId": "70151021", "customerNo": "10000001", "virtualAccountNo": "7015102110000001", "virtualAccountName": "John Test", "paymentRequestId": "FIXOPEN0010000000006", "paidAmount": { "value": "100000.00", "currency": "IDR" }, "trxDateTime": "2024-02-01T15:40:06+07:00", "trxId": "ref100000001" }, "additionalInfo": { "goodsNm": "Test Item", } } ``` :::