Check Status Transaction - API E-Wallet (Direct Debit) SNAP
Tentang Check Status Transaction - API E-Wallet (Direct Debit) SNAP
API ini digunakan untuk melakukan pemeriksaan status transaksi yang dilakukan dengan metode pembayaran E-Wallet dengan Fitur Direct Debit Host to Host yang sesuai standar SNAP.
Check Status Transaction - API E-Wallet (Direct Debit) SNAP
Silakan mengajukan akses token terlebih dahulu untuk melakukan autentikasi melalui bagian Request Access Token API - SNAP.
Service Code | 55 |
|---|---|
API Endpoint | |
HTTP Method | POST |
Description | Request check status for authentication |
Content-type | application/json |
Request Header Parameter for Check Status Transaction - API E-Wallet (Direct Debit) SNAP
Parameter | Tipe | Ukuran | Kebutuhan | Deskripsi | Contoh |
|---|---|---|---|---|---|
Content-Type | String | 127 | Mandatory | Application/Json | |
Authorization | String | Variable | Mandatory | Bearer “accessToken” | |
X-TIMESTAMP | String | 25 | 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 | Variable | 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 | 20 | Mandatory | Unique Channel Merchant Credential ID Number Client ID + "01" = Channel ID "IONPAYTEST" + "01" = "IONPAYTEST01" | IONPAYTEST01 |
Request Body Parameter for Check Status Transaction - API E-Wallet (Direct Debit) SNAP
Parameter | Tipe | Kebutuhan | Ukuran | Deskripsi atau Contoh |
|---|---|---|---|---|
merchantId | String | Mandatory | 10 | Merchant identifier that is unique per each Merchant |
subMerchantId | String | Optional | 32 | Sub Merchant ID |
originalReferenceNo | String | Mandatory | 40 | Original transaction identifier on service provider system |
originalPartnerReferenceNo | String | Mandatory | 40 | Original transaction identifier on consumer system |
externalStoreId | String | Optional | 32 | Unique identifier of Shop ID in Client system |
serviceCode | String | Mandatory | 2 | Transaction type indicator (service code of the original transaction request) |
amount | Array of JSON Object | Mandatory | Variable | Amount of transaction "amount": { "value": "12345678.00", "currency": "IDR" } |
value | String | Mandatory | 12 | Value |
currency | String | Mandatory | 3 | Currency |
transactionDate | String | Optional | 25 | Transaction date: ISO8601, in format YYYYMMDDTHH: mm:ss+07:00. Time must be in GMT+7 (Jakarta time). |
additionalInfo | JSON Object | Optional | Variable | Additional information |
Response Parameter for Check Status Transaction - API E-Wallet (Direct Debit) SNAP
Nama Parameter BI | Tipe Parameter | Kebutuhan | NICEPAY Parameter | Deskripsi atau Contoh |
|---|---|---|---|---|
responseCode | String | Mandatory | 7 | Refer to General Response Code and Message - API SNAP list |
responseMessage | String | Mandatory | 150 | Refer to General Response Code and Message - API SNAP list |
originalReferenceNo | String | Mandatory | 40 | Original transaction identifier on service provider system |
originalPartnerReferenceNo | String | Mandatory | 40 | Original transaction identifier on service provider system. Must be filled upon successful transaction |
serviceCode | String | Mandatory | 2 | Transaction type indicator (service code of the original transaction request) |
latestTransactionStatus | String | Mandatory | 2 | Category code . Example: 00: Success 01: Initiated 02: Paying 03: Pending 04: Refunded 05: Canceled 06: Failed 07: Not found |
transactionStatusDesc | String | Optional | 50 | Description status transaction |
transAmount | Array of JSON Object | Mandatory | Variable | Amount of transaction "transAmount": { "currency": "IDR", "value": "239.00" } |
value | String | Mandatory | 12 | Value |
currency | String | Mandatory | 3 | Currency |
paidTime | String | Conditional | 25 | Transaction date: ISO 8601 YYYY-MM DDThh:mm:ss If the the transaction is Success, it will contain time from after payment completely successful. Meanwhile for transactions that are Pending or Failed, it will contain time from during initial payment request to the Partner. |
additionalInfo | JSON Object | Optional | Variable | Additional Information "additionalInfo": { ... } |
mitra_cd | String | Mandatory | 4 | |
goodsNm | String | Mandatory | 200 | Goods Name |
billingNm | String | Mandatory | 100 | Buyer Name |
billingPhone | String | Mandatory | 20 | Buyer Phone Number |
Sample Parameter for Check Status Transaction API E-Wallet (Direct Debit) SNAP
Request Parameter
PARTNER_ID = "TNICEEW051"
SUB_MERCHANT_ID = "23489182303312"
ORIGINAL_REF_NO = "TNICEEW05105202210141451109841"
ORIGINAL_PARTNER_REF_NO = "2020102900000000000001"
SERVICE_CODE = "54"
TRANSACTION_DATE = "2020-12-21T14:56:11+07:00"
EXTERNAL_STORE_ID = "239840198240795109"
AMOUNT_VALUE = "12345678.00"
bodyCreateToken = (
builderAccessToken.BuildAccessToken()
.setGrantType("client_credentials")
.setAdditionalInfo({})
.build()
)
amount = {
"value": AMOUNT_VALUE,
"currency": "IDR"
}
additionalInfo = {}
bodyDirectDebitInquiry = (
builderDirectDebit.BuildDirectDebitInquiry()
.setMerchantId(PARTNER_ID)
.setSubMerchantId(SUB_MERCHANT_ID)
.setOriginalPartnerReferenceNo(ORIGINAL_PARTNER_REF_NO)
.setOriginalReferenceNo(ORIGINAL_REF_NO)
.setServiceCode(SERVICE_CODE)
.setTransactionDate(TRANSACTION_DATE)
.setExternalStoreId(EXTERNAL_STORE_ID)
.setAmount(amount)
.setAdditionalInfo(additionalInfo)
.build()
)
environment = (builderEnvironment.BuildEnvironment()
.isCloud(False)
.isProduction(False)
.build())
result = SnapService.serviceTransaction(bodyCreateToken.jsonAccessToken(),
bodyDirectDebitInquiry.jsonDirectDebitInquiry(),
ConstantsEndpoints.inquiryDirectDebit(),
environment)Response Parameter
{
"responseCode": "2005500",
"responseMessage": "Successful",
"originalPartnerReferenceNo": "2020102900000000000001",
"originalReferenceNo": "TNICEEW05105202210141451109841",
"serviceCode": "54",
"latestTransactionStatus": "00",
"transactionStatusDesc": "success",
"transAmount": {
"currency": "IDR",
"value": "100.00"
},
"paidTime": "2020-12-21T14:56:11+07:00",
"additionalInfo": {
"mitra_cd": "DANA",
"goodsNm": "Merchant Goods 1",
"billingNm": "Buyer Name",
"billingPhone": "02112345678"
}
}