Virtual Account SNAP
VA Inquiry Status (SNAP)
Check Virtual Account status via SNAP transfer-va service.
HTTPMethod: POST
URL: ${ROOT_URL}/v1.0/transfer-va/status
Service Code: 28
Version: 1.0
ServiceGroup: transfer-va
ProductType: status
| Parameter | Required | Type | Length | Remarks |
|---|
| Content-Type | M | String | - | Fixed value application/json |
| Authorization | C | String | Dynamic | access_token value; mandatory if using symmetric encryption |
| X-TIMESTAMP | M | String | 64 | Jakarta time, 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 | Client IP (IPv4) |
| Parameter | Required | Type | Length | Remarks |
|---|
| partnerServiceId | M | String | 8 | Derivative of X-PARTNER-ID, similar to company code, 8 digit left padding space. partnerServiceId + customerNo or virtualAccountNo |
| customerNo | M | String | 20 | Unique number (up to 20 digits). partnerServiceId + customerNo or virtualAccountNo |
| virtualAccountNo | M | String | 28 | partnerServiceId + customerNo (max 20 digits) |
| inquiryRequestId | M | String | 128 | paymentRequestId from asynchronous notification |
| paymentRequestId | O | String | 128 | paymentRequestId from asynchronous notification |
| additionalInfo | O | Object | - | - |
| Parameter | Required | Type | Length | Remarks |
|---|
| Content-Type | M | String | - | Fixed value application/json |
| X-TIMESTAMP | M | String | 64 | Jakarta time, format 2021-11-29T09:22:18+07:00 |
| Parameter | Required | Type | Length | Remarks |
|---|
| responseCode | M | String | 7 | HTTP status code + service code + case code |
| responseMessage | M | String | 150 | Response description |
| + virtualAccountData | O | Object | - | - |
| + paymentFlagReason | O | Object | - | Reason for Payment Status multi language |
| - english | O | String | 200 | Reason for Payment Status in English |
| - indonesia | O | String | 200 | Reason for inquiryStatus in Bahasa |
| - partnerServiceId | M | String | 8 | Derivative of X-PARTNER-ID, similar to company code, 8 digit left padding space |
| - customerNo | M | String | 20 | Fixed value 00000000000000000000 |
| - virtualAccountNo | M | String | 28 | virtualAccountNo |
| - inquiryRequestId | M | String | 128 | From Request Parameter |
| - paymentRequestId | M | String | 128 | From Request Parameter |
| + paidAmount | O | Object | - | Transaction amount |
| - value | M | String | 16,2 | Amount with 2 decimals |
| - currency | M | String | 3 | Currency, fixed value: IDR |
| - paidBills | M | String | 6 | Hexadecimal format of binary of flag of paid bills |
| + totalAmount | O | Object | - | Transaction amount |
| - value | M | String | 16,2 | Amount with 2 decimals, e.g. 10000.00; static VA: 0.00 |
| - currency | M | String | 3 | Currency, fixed value: IDR |
| - trxDateTime | O | String | 25 | Transaction time ISO-8601 standard |
| - transactionDate | O | String | 25 | Successful payment time |
| - referenceNo | O | String | 15 | Platform Transaction Number |
| - paymentType | O | Number | 1 | Type of payment |
| - flagAdvise | O | String | 1 | Status is this a retry notification |
| - paymentFlagStatus | O | String | 2 | Status for Payment Flag |
| + billDetails | O | List | - | Array with maximum 24 Objects (Currently not used) |
| - billCode | O | String | 2 | Bill code for Customer choose |
| - billNo | O | String | 18 | Bill number from Partner |
| - billName | O | String | 20 | Bill Name |
| - billShortName | O | String | 10 | Bill Name to shown to |
| + billDescription | O | Object | - | Bill Description |
| - english | O | String | 18 | Bill Description in English |
| - indonesia | O | String | 18 | Bill Description in Bahasa |
| - billSubCompany | O | String | 5 | Partner's product code |
| + billAmount | O | Object | - | Transaction Amount |
| - value | M | String | 16,2 | Amount with 2 decimal |
| - currency | M | String | 3 | Currency, fixed value: IDR |
| + additionalInfo | O | Object | - | Additional Information for custom use for each bill |
| - billReferenceNo | O | String | 15 | Bill auth code generated by PJP |
| - status | O | String | 2 | Payment status for specific Bill |
| + reason | O | Object | - | Reason for Payment Status for specific Bill multi language |
| - english | O | String | 64 | Reason for Payment Status for specific Bill in English |
| - indonesia | O | String | 64 | Reason for Payment Status for specific Bill in Bahasa |
| + freeTexts | O | List | - | Array with maximum 25 Objects |
| - english | O | String | 32 | Will be shown in Channel |
| - indonesia | O | String | 32 | Will be shown in Channel |
| + additionalInfo | O | Object | - | - |
| - transFeeRate | O | decimal(8,6) | No | Transaction Fee Rate |
| - transFeeAmount | O | decimal(12,2) | No | Transaction Fee Amount |
| - totalTransFee | O | decimal(12,2) | No | Total Transaction Fee (excluding VAT) |
| - vatFee | O | decimal(12,2) | No | Tax |
| - payer | O | String(60) | No | Actual Payer |
| - accountNo | O | String(32) | No | Actual Payer Account Number |
Content-type: application/json
X-TIMESTAMP: 2020-12-21T14:36:19+07:00
{
"responseCode":"2003100",
"responseMessage":"Success",
"virtualAccountData":{
"partnerServiceId":" 088899",
"customerNo":"12345678901234567890",
"virtualAccountNo":" 08889912345678901234567890",
"trxId":"abcdefgh1234",
"additionalInfo":{
}
}
}