Cancel - API Virtual Account SNAP

7min

Tentang Cancel - API Virtual Account SNAP
﻿
API dengan standar SNAP ini digunakan untuk melakukan pengajuan pembatalan proses transaksi pada metode pembayaran Virtual Account.
﻿
Merchant Cancel - API Virtual Account SNAP
﻿
Silakan mengajukan akses token terlebih dahulu untuk melakukan autentikasi melalui bagian Request Access Token API - SNAP﻿.
Service Code
31
API Endpoint
/api/v1.0/transfer-va/delete-va
HTTP Method
DELETE
Description
Untuk mengajukan pembatalan proses transaksi VA
Content-Type
application/json
﻿
Request Cancel 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﻿ 
﻿
X-PARTNER-ID
String
20
Mandatory
X-PARTNER-ID = CLIENT_ID 
﻿
X-EXTERNAL-ID
String
40
Mandatory
Unique Reference Number
(41807553358950093184)
﻿
CHANNEL-ID
String
20
Mandatory
Unique Channel Merchant Credential ID Number
Client ID + "01" =  Channel ID 
"IONPAYTEST" + "01" = "IONPAYTEST01" 
IONPAYTEST01
﻿
Request Cancel Body Parameter
Parameter
Tipe
Ukuran
Kebutuhan
Deskripsi
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
﻿
   Optional
"additionalInfo": {
    "totalAmount": {
      ...
    },
    ...
  }
totalAmount
Object
﻿
Optional
"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
Tipe
Ukuran
Kebutuhan
Deskripsi
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	Untuk mengajukan pembatalan proses transaksi VA
Content-Type	application/json

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
X-PARTNER-ID	String	20	Mandatory	X-PARTNER-ID = CLIENT_ID
X-EXTERNAL-ID	String	40	Mandatory	Unique Reference Number (41807553358950093184)
CHANNEL-ID	String	20	Mandatory	Unique Channel Merchant Credential ID Number Client ID + "01" = Channel ID "IONPAYTEST" + "01" = "IONPAYTEST01"	IONPAYTEST01

Parameter	Tipe	Ukuran	Kebutuhan	Deskripsi
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		Optional	"additionalInfo": { "totalAmount": { ... }, ... }
totalAmount	Object		Optional	"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	Tipe	Ukuran	Kebutuhan	Deskripsi
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 24 Dec 2024

Did this page help you?

Check Status Transaction - API Virtual Account SNAP

API QRIS SNAP

Cancel - API Virtual Account SNAP

Tentang Cancel - API Virtual Account SNAP

Merchant Cancel - API Virtual Account SNAP

Request Cancel Header Parameter

Request Cancel Body Parameter

Response Cancel Parameter

Sample Parameter

Selamat Datang di NICEPAY DOCS