Cancel - API Virtual Account SNAP
This API with SNAP standards uses to request transaction cancellation process on Virtual Account payment method.
Please request the access token firsthand before doing the authentication through the Request Access Token API - SNAP section.
Service Code | 31 |
|---|---|
API Endpoint | /api/v1.0/transfer-va/delete-va |
HTTP Method | DELETE |
Description | To request VA transaction cancellation process |
Content-Type | application/json |
Parameter | Type | Length | Required | Description | Example |
|---|---|---|---|---|---|
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. | |
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 |
Parameter | Type | Length | Required | Description |
|---|---|---|---|---|
partnerServiceId | String | 20 | Mandatory | Partner Service ID / Prefix |
customerNo | String | 40 | Mandatory | Customer Number (Mandatory for Fix type) |
virtualAccountNo | String | 25 | Mandatory | Virtual Account Number |
trxId | String | 40 | Mandatory | Transaction ID (Reference Number from Merchant) |
additionalInfo | Object | | Mandatory | "additionalInfo": { "totalAmount": { ... }, ... } |
totalAmount | Object | | Mandatory | "totalAmount": { ... } |
value | String | 12 | Mandatory | Transaction Amount |
currency | String | 3 | Mandatory | Currency |
tXidVA | String | 40 | Mandatory | Transaction ID |
cancelMessage | String | 255 | Mandatory | Cancel Message |
Parameter | Type | Length | Required | Description |
|---|---|---|---|---|
responseCode | String | | Mandatory | |
responseMessage | String | | Mandatory | |
virtualAccountData | Object | | Mandatory | "virtualAccountData": { ... } |
partnerServiceId | String | 20 | Mandatory | Partner Service ID / Prefix |
customerNo | String | 40 | Mandatory | Customer Number (Mandatory for Fix type) |
virtualAccountNo | String | 40 | Mandatory | Virtual Account Number |
trxId | String | 40 | Mandatory | Transaction ID (Reference Number from Merchant) |
additionalInfo | Object | | Mandatory | "additionalInfo": { ..., "totalAmount": { ... } } |
tXidVA | String | 40 | Mandatory | Transaction ID |
cancelMessage | String | 200 | Mandatory | Cancel Message |
cancelVATime | String | 8 | Mandatory | Cancel Virtual Account Time |
totalAmount | Object | | Mandatory | "totalAmount": { ... } |
value | String | 12 | Mandatory | Transaction Amount |
currency | String | 3 | Mandatory | Currency |
