Cancel - API Virtual Account SNAP

7min

About Cancel - API Virtual Account SNAP
﻿
This API with SNAP standards uses to request transaction cancellation process on Virtual Account payment method.
﻿
Merchant Cancel Virtual Account API
﻿
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
﻿
Request Cancel Header Parameter
Parameter
Type
Length
Required
Description
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
Request message signature
(EIFYcRuFfFh8nkVhLZrkGKYfk36SDM8VvV3EW/OoKbkCspqMCiU/9ZhCiO29EjUEF0j7vjkQpSidvtIpt/BkLg ==)
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
Channel Identification with name of Merchant + 2 digits number (mid01)
﻿
Request Cancel Body Parameter
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
﻿
 Response Cancel Parameter
Parameter
Type
Length
Required
Description
responseCode
String
﻿
Mandatory
﻿General Response Code and Message - API SNAP﻿﻿
responseMessage
String
﻿
Mandatory
﻿General Response Code and Message - API SNAP﻿﻿
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
﻿
Sample Parameter
Sample Request
Sample Response
{
    "responseCode": "2003100",
    "responseMessage": "Success",
    "virtualAccountData": {
        "partnerServiceId": "088899",
        "customerNo": "12345678901234567890",
        "virtualAccountNo": "9912304000007307",
        "trxId": "2024123000000000000001",
        "additionalInfo": {
            "tXidVA": "NORMALTEST02202401181001033629",
            "cancelMessage": "Cancel Virtual Account",
            "cancelVATime": "2024-12-31T10:11:40+07:00",
            "totalAmount": {
                "value": "10000.00",
                "currency": "IDR"
            }
        }
    }
}
{
    "responseCode": "2003100",
    "responseMessage": "Success",
    "virtualAccountData": {
        "partnerServiceId": "088899",
        "customerNo": "12345678901234567890",
        "virtualAccountNo": "9912304000007307",
        "trxId": "2024123000000000000001",
        "additionalInfo": {
            "tXidVA": "NORMALTEST02202401181001033629",
            "cancelMessage": "Cancel Virtual Account",
            "cancelVATime": "2024-12-31T10:11:40+07:00",
            "totalAmount": {
                "value": "10000.00",
                "currency": "IDR"
            }
        }
    }
}
﻿
﻿

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
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	Request message signature (EIFYcRuFfFh8nkVhLZrkGKYfk36SDM8VvV3EW/OoKbkCspqMCiU/9ZhCiO29EjUEF0j7vjkQpSidvtIpt/BkLg ==)
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	Channel Identification with name of Merchant + 2 digits number (mid01)

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	General Response Code and Message - API SNAP
responseMessage	String		Mandatory	General Response Code and Message - API SNAP
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

Updated 15 Mar 2024

Did this page help you?

Check Status Transaction - API Virtual Account SNAP

API QRIS SNAP

Cancel - API Virtual Account SNAP

About Cancel - API Virtual Account SNAP

Merchant Cancel Virtual Account API

Request Cancel Header Parameter

Request Cancel Body Parameter

Response Cancel Parameter

Sample Parameter

Welcome to NICEPAY DOCS