NICEPAY API
...
Payment API - SNAP
API E-Wallet (Direct Debit) SN...

Check Status Transaction - API E-Wallet (Direct Debit) SNAP

7min

About Check Status Transaction - API E-Wallet (Direct Debit) SNAP



This API uses to check the payment transaction status on the E-Wallet payment method with Direct Debit Host to Host Feature based on the SNAP BI standard.



Check Status Transaction - API E-Wallet (Direct Debit) SNAP



Please request the access token firsthand before performing the authentication through the Request Access Token API - SNAP section.

Service Code

55

API Endpoint

HTTP Method

POST

Description

Request check status for authentication

Content-type

application/json



Request Check Status Header Parameter

Parameter

Type

Length

Mandatory

Description

Content-Type

String

127

Mandatory

Application/Json

Authorization

String

Variable

Mandatory

Bearer “access_token

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

X-SIGNATURE: created using asymmetric signature SHA256withRSA algorithm (Private_Key, stringToSign) stringToSign = client ID + “|” + X-TIMESTAMP

X-PARTNER-ID

String

20

Mandatory

X-PARTNER-ID = CLIENT_ID

X-EXTERNAL-ID

String

40

Mandatory

Unique Reference Number

(41807553358950093184)

CHANNEL-ID

String

5

Mandatory

Channel Identification with name of Merchant + 2 digits number (mid01)



Request Check Status Body Parameter

Parameter

Type

Mandatory

Length

Description or Example

merchantId

String

Mandatory

10

Merchant identifier that is unique per each Merchant

subMerchantId

String

O

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

O

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 Check Status Parameter

Parameter

Type

Mandatory

Length

Description or Example

responseCode

String

Mandatory

7

responseMessage

String

Mandatory

150

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 for the status of the transaction.

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

additionalInfo

JSON Object

Optional

Variable

Additional Information

"additionalInfo": { ... }

mitra_cd

String

Mandatory

4

Example:

Indomaret: INDO

Alfamart: ALMA

OVO: OVOE

LinkAja: LINK

DANA: DANA

ShopeePay: ESHP

Jenius: JENC

Kredivo: KDVI

Akulaku: AKLP

Indodana: IDNA

QRIS: QSHP

goodsNm

String

Mandatory

200

Goods Name

billingNm

String

Mandatory

100

Buyer Name

billingPhone

String

Mandatory

20

Buyer Phone Number



Sample Parameter

Sample Request
Sample Response