--- title: Check Status Transaction - API E-Wallet (Direct Debit) SNAP slug: nicepay-api-snap-check-status-transaction-e-wallet-direct-debit description: Informasi tentang Check Status Transaction - API E-Wallet (Direct Debit) SNAP yang terdapat pada sistem NICEPAY image: https://archbee-image-uploads.s3.amazonaws.com/ZHvSjR5ZrsoxwKbJa3xmo/vkkFDRyEg1vCqRgKT7oN1_microsoftteams-image.png icon: {"faIcon":"fa-solid fa-book"} docTags: createdAt: 2023-02-17T09:48:59.000Z --- # 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 *** :::hint{type="warning"} Silakan mengajukan akses token terlebih dahulu untuk melakukan autentikasi melalui bagian [Request Access Token API - SNAP](docId\:GcGqBIYXG1Etcd0Ji9cHX). ::: | **Service Code** | `55` | | ---------------- | ----------------------------------------------------------------------------------- | | **API Endpoint** | [`/api/v1.0/debit/status`](https://dev.nicepay.co.id/nicepay/api/v1.0/debit/status) | | **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.
[Panduan X-Signature - Symmetric](docId\:UZex33ReLyENKOgbJJnYp) | | | `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](docId\:lKqJXSl5CMKdXYXxHYYSs) list | | `responseMessage` | String | Mandatory | 150 | Refer to [General Response Code and Message - API SNAP](docId\:lKqJXSl5CMKdXYXxHYYSs) 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 | [Mitra Code - API SNAP](docId\:mebNfCDEq1GFUs9oE_MOF)
Example:
ShopeePay: `ESHP`
OVO: `OVOE`
LinkAja: `LINK`
DANA: `DANA`
AstraPay: `ASTR` | | `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 :::CodeblockTabs cURL ```curl curl -X POST \ 'https://dev.nicepay.co.id/nicepay/api/v1.0/debit/status' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJJT05QQVlURVNUIiwiaXNzIjoiTklDRVBBWSIsIm5hbWUiOiJCUklOIiwiZXhwIjoiMjAyNC0wMi0xMVQwODowOTozNVoifQ==.aIybLX36dYwfFvW7dcoenXkOe2EAwIYq84ZtPuIf3K8=' \ -H 'X-TIMESTAMP: 2024-12-31T10:11:40+07:00' \ -H 'X-SIGNATURE: ufBw7R8RhW79IOiV/Hlv607M60qzAYBv8uZmbSrYb6/Thlo/FhQVP4xRyelUehoSS9o+QS6vWTKb/ygtucC+tQ==' \ -H 'X-PARTNER-ID: TNICEEW051' \ -H 'X-EXTERNAL-ID: tXid202402111402271707638100' \ -H 'CHANNEL-ID: TNICEEW05101' \ -d '{"merchantId":"23489182303312","subMerchantId":"23489182303312","originalPartnerReferenceNo":"2020102900000000000001","originalReferenceNo":"TNICEEW05105202210141451109841","serviceCode":"54","transactionDate":"2020-12-21T14:56:11+07:00","externalStoreId":"239840198240795109","amount":{"value":"12345678.00","currency":"IDR"},"additionalInfo":{}}' ``` Node.js ```nodejs // --- Debit Payment Status Data (TNICEEW051 Context) --- const PARTNER_ID = "TNICEEW051"; const ACCESS_TOKEN = "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJJT05QQVlURVNUIiwiaXNzIjoiTklDRVBBWSIsIm5hbWUiOiJCUklOIiwiZXhwIjoiMjAyNC0wMi0xMVQwODowOTozNVoifQ==.aIybLX36dYwfFvW7dcoenXkOe2EAwIYq84ZtPuIf3K8="; const X_TIMESTAMP = "2024-12-31T10:11:40+07:00"; const X_EXTERNAL_ID = "tXid202402111402271707638100"; const CHANNEL_ID = "TNICEEW05101"; const MERCHANT_ID_BODY = "23489182303312"; const STORE_ID = "239840198240795109"; const SUB_MERCHANT_ID = "23489182303312"; const PARTNER_REF_NO = "2020102900000000000001"; const ORIGINAL_REF_NO = "TNICEEW05105202210141451109841"; const SERVICE_CODE = "54"; const TRANSACTION_DATE = "2020-12-21T14:56:11+07:00"; const AMOUNT_VALUE = "12345678.00"; // Step 1: Configure the SDK const config = { isProduction: false, privateKey: cons.privateKey, clientSecret: cons.clientSecret, clientId: PARTNER_ID, // TNICEEW051 isCloudServer: false, }; // Step 2: Define the Debit Status Inquiry Request Parameters let paramCheckStatus = { body: { merchantId: MERCHANT_ID_BODY, subMerchantId: SUB_MERCHANT_ID, originalPartnerReferenceNo: PARTNER_REF_NO, originalReferenceNo: ORIGINAL_REF_NO, serviceCode: SERVICE_CODE, transactionDate: TRANSACTION_DATE, externalStoreId: STORE_ID, amount: { value: AMOUNT_VALUE, currency: "IDR", }, additionalInfo: {} }, headers: { X_EXTERNAL_ID: X_EXTERNAL_ID, CHANNEL_ID: CHANNEL_ID, }, }; let snap = new Snap(config); let endPoint = `/api/v1.0/debit/status`; let response = snap .requestSnapTransaction(paramCheckStatus, endPoint, ACCESS_TOKEN, "POST"); ``` ```java final String PARTNER_ID = "TNICEEW05"; // X-PARTNER-ID from cURL final String X_EXTERNAL_ID = "tXid202402111402271707638100"; final String X_TIMESTAMP = "2024-12-31T10:11:40+07:00"; final String ACCESS_TOKEN = "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJJT05QQVlURVNUIiwiaXNzIjoiTklDRVBBWSIsIm5hbWUiOiJCUklOIiwiZXhwIjoiMjAyNC0wMi0xMVQwODowOTozNVoifQ==.aIybLX36dYwfFvW7dcoenXkOe2EAwIYq84ZtPuIf3K8="; // Step 1: Configuration (TNICEEW05 context) final NICEPay config2 = NICEPay.builder() .isProduction(false) .clientSecret("YOUR_CLIENT_SECRET") .partnerId(PARTNER_ID) .externalID(X_EXTERNAL_ID) .timestamp(X_TIMESTAMP) .privateKey("YOUR_PRIVATE_KEY") .build(); final var accessToken = ACCESS_TOKEN; // Step 2: Request Body (Debit Status Inquiry Payload) final InquiryStatus requestData = InquiryStatus.builder() .merchantId("23489182303312") // merchantId from cURL body .subMerchantId("23489182303312") // subMerchantId from cURL body .originalPartnerReferenceNo("2020102900000000000001") .originalReferenceNo("TNICEEW05105202210141451109841") .serviceCode("54") .transactionDate("2020-12-21T14:56:11+07:00") .externalStoreId("239840198240795109") .amount("12345678.00", "IDR") // additionalInfo is implicitly an empty object as per cURL .build(); // Step 3: Execute the Inquiry NICEPayResponse response = SnapInquiryStatusService.callServiceEwalletCheckStatus(requestData, accessToken, config2); ``` ```python 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) ``` C# ```csharp const string PARTNER_ID = "TNICEEW051"; const string CHANNEL_ID = "TNICEEW05101"; const string X_TIMESTAMP = "2024-12-31T10:11:40+07:00"; const string X_EXTERNAL_ID = "tXid202402111402271707638100"; const string ACCESS_TOKEN = "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJJT05QQVlURVNUIiwiaXNzIjoiTklDRVBBWSIsIm5hbWUiOiJCUklOIiwiZXhwIjoiMjAyNC0wMi0xMVQwODowOTozNVoifQ==.aIybLX36dYwfFvW7dcoenXkOe2EAwIYq84ZtPuIf3K8="; string privateKey = config.PrivateKey; string clientSecret = config.ClientSecret; string clientId = PARTNER_ID; string timestamp = X_TIMESTAMP; string channelId = CHANNEL_ID; string random = SignatureGeneratorUtils.GenerateRandomNumberString(8); bool isProduction = false; bool isCloudServer = false; string signature = SignatureGeneratorUtils.GenerateSignature(privateKey, clientId, timestamp); // Create Ewallet service ApiEndpoints apiEndpoints = new ApiEndpoints(); APIService ewalletService = new APIService(apiEndpoints, clientSecret, clientId, channelId, isProduction, isCloudServer); SnapEwalletServices snapEwalletServices = new SnapEwalletServices(clientId); string createRequestBody = snapEwalletServices.GenerateStatusEwalletRequest( merchantId: "23489182303312", subMerchantId: "23489182303312", originalPartnerReferenceNo: "2020102900000000000001", originalReferenceNo: "TNICEEW05105202210141451109841", serviceCode: "54", transactionDate: DateTime.Parse("2020-12-21T14:56:11+07:00"), externalStoreId: "239840198240795109", amountValue: "12345678.00", currency: "IDR" ); Console.WriteLine("Inquiry Ewallet Request: " + createRequestBody); // Send POST request string externalId = X_EXTERNAL_ID; string createResponse = await ewalletService.SendPostRequest(apiEndpoints.StatusEwallet, accessToken, timestamp, createRequestBody, externalId); Console.WriteLine("Inquiry Ewallet Response: " + createResponse); ``` Laravel ```php const string ACCESS_TOKEN = "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJJT05QQVlURVNUIiwiaXNzIjoiTklDRVBBWSIsIm5hbWUiOiJCUklOIiwiZXhwIjoiMjAyNC0wMi0xMVQwODowOTozNVoifQ==.aIybLX36dYwfFvW7dcoenXkOe2EAwIYq84ZtPuIf3K8="; const string X_TIMESTAMP = "2024-12-31T10:11:40+07:00"; const string X_EXTERNAL_ID = "tXid202402111402271707638100"; const string CHANNEL_ID = "TNICEEW05101"; protected $useProd = false; protected $useCloud = false; protected $inquiry_ewallet_endpoint = "/api/v1.0/debit/status"; // Corrected endpoint for status inquiry // Credential protected $client_id = "TNICEEW051"; PROTECTED $key = "_PRIVATE_KEY_MERCHANT"; PROTECTED $client_secret = "_CLIENT_SECRET_MERCHANT"; PROTECTED $access_token = ACCESS_TOKEN; PROTECTED $store_id = "239840198240795109"; $url = HttpUtil::getNicepayDomain($this->useProd, $this->useCloud) . $this->inquiry_ewallet_endpoint; $helper = new Helpers(); $http_method = "POST"; $x_time_stamp = X_TIMESTAMP; $partner_id = $this->client_id; $client_secret = $this->client_secret; $access_token = $this->access_token; $store_id = $this->store_id; $external_id = X_EXTERNAL_ID; $channel_id = CHANNEL_ID; $amount = [ "value" => "12345678.00", "currency" => "IDR" ]; $additionalInfo = new \stdClass(); $body = [ "merchantId" => "23489182303312", // merchantId from cURL body "subMerchantId" => "23489182303312", "originalPartnerReferenceNo" => "2020102900000000000001", "originalReferenceNo" => "TNICEEW05105202210141451109841", "serviceCode" => "54", "transactionDate" => "2020-12-21T14:56:11+07:00", "externalStoreId" => "239840198240795109", "amount" => $amount, "additionalInfo" => $additionalInfo ]; $string_to_sign = $helper->generateStringToSign( $http_method, $this->inquiry_ewallet_endpoint, $access_token, $body, $x_time_stamp ); $signature = $helper->hmacSHA512Encoded( $string_to_sign, $client_secret, OPENSSL_ALGO_SHA512 ); $header = $helper->generateHeader( $access_token, $x_time_stamp, $signature, $partner_id, $external_id, $channel_id ); print_r($string_to_sign); print_r("\r\n"); print_r($header); print_r($body); try { $response = HttpUtil::postJsonRequestWithHeader($url, $body, $header); } catch (Exception $e) { // Handle exception } ``` PHP Native ```php $config = NICEPay::builder() ->setIsProduction(false) ->setPrivateKey($this->oldKeyFormat) ->setClientSecret($this->clientSecret) ->setPartnerId("TNICEEW051") ->setExternalID("tXid202402111402271707638100") ->setTimestamp("2024-12-31T10:11:40+07:00") ->build(); $accessToken = "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJJT05QQVlURVNUIiwiaXNzIjoiTklDRVBBWSIsIm5hbWUiOiJCUklOIiwiZXhwIjoiMjAyNC0wMi0xMVQwODowOTozNVoifQ==.aIybLX36dYwfFvW7dcoenXkOe2EAwIYq84ZtPuIf3K8="; $requestBody = InquiryStatus::builder() ->setMerchantId("23489182303312") ->setSubMerchantId("23489182303312") ->setOriginalPartnerReferenceNo("2020102900000000000001") ->setOriginalReferenceNO("TNICEEW05105202210141451109841") ->setServiceCode("54") ->setTransactionDate("2020-12-21T14:56:11+07:00") ->setExternalStoreId("239840198240795109") ->setAmount("12345678.00", "IDR") ->setAdditionalInfo([]) ->build(); $snapEwalletService = new SnapEwalletService($config); $response = $snapEwalletService->inquiryStatus($requestBody, $accessToken); ``` ```kotlin const val PARTNER_ID = "TNICEEW051" const val X_EXTERNAL_ID = "tXid202402111402271707638100" const val X_TIMESTAMP = "2024-12-31T10:11:40+07:00" const val ACCESS_TOKEN = "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJJT05QQVlURVNUIiwiaXNzIjoiTklDRVBBWSIsIm5hbWUiOiJCUklOIiwiZXhwIjoiMjAyNC0wMi0xMVQwODowOTozNVoifQ==.aIybLX36dYwfFvW7dcoenXkOe2EAwIYq84ZtPuIf3K8=" // Step 1: Initialize the NICEPay Configuration (Header context) var config: NICEPay = NICEPay.Builder() .isProduction(false) .clientSecret("YOUR_CLIENT_SECRET") .partnerId(PARTNER_ID) .externalID(X_EXTERNAL_ID) .timestamp(X_TIMESTAMP) .privateKey("YOUR_PRIVATE_KEY") .build() // Step 2: Define the Static Status Request Body val checkStatusEwallet: SnapCheckStatus = SnapCheckStatus.Builder() .merchantId("23489182303312") .subMerchantId("23489182303312") .originalPartnerReferenceNo("2020102900000000000001") .originalReferenceNo("TNICEEW05105202210141451109841") .serviceCode("54") .transactionDate("2020-12-21T14:56:11+07:00") .externalStoreId("239840198240795109") .amount("12345678.00", "IDR") .build() // Step 3: Execute the Inquiry (Removed dynamic token fetching) val response: NICEPayResponse? = snapEwalletService.checkStatus(checkStatusEwallet, ACCESS_TOKEN, config) ``` CodeIgniter ```php $config = NICEPay::builder() ->setIsProduction(false) ->setIsCloudServer(isCloudServer: true) ->setPrivateKey($this->oldKeyFormat) ->setClientSecret($this->clientSecret) ->setPartnerId("TNICEEW051") ->setExternalID("tXid202402111402271707638100") ->setTimestamp("2024-12-31T10:11:40+07:00") ->build(); $accessToken = "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJJT05QQVlURVNUIiwiaXNzIjoiTklDRVBBWSIsIm5hbWUiOiJCUklOIiwiZXhwIjoiMjAyNC0wMi0xMVQwODowOTozNVoifQ==.aIybLX36dYwfFvW7dcoenXkOe2EAwIYq84ZtPuIf3K8="; $requestBody = InquiryStatusEwallet::builder() ->setMerchantId("23489182303312") ->setSubMerchantId("23489182303312") ->setOriginalPartnerReferenceNo("2020102900000000000001") ->setOriginalReferenceNO("TNICEEW05105202210141451109841") ->setServiceCode("54") ->setTransactionDate("2020-12-21T14:56:11+07:00") ->setExternalStoreId("239840198240795109") ->setAmount("12345678.00", "IDR") ->setAdditionalInfo([]) ->build(); $snapEwalletService = new SnapEwalletService(); try { $response = $snapEwalletService->inquiryStatusEwallet($requestBody, $accessToken, $config); } catch (\Exception $e) { // Handle exception } ``` ::: ### Response Parameter :::CodeblockTabs Sample Response ```json { "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" } } ``` :::