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

Refund Transaction - API E-Wallet (Direct Debit) SNAP

7min

About Refund Transaction - API E-Wallet (Direct Debit) SNAP



This API uses to request the refund process from a transaction on the E-Wallet payment method with Direct Debit Host to Host Feature based on the SNAP BI standard.



Refund 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

58

API Endpoint

HTTP Method

POST

Description

Request refund transaction for authentication

Content-type

application/json



Request Refund Header Parameter

Parameter

Type

Length

Required

Description

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

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 Refund Body Parameter

Parameter

Type

Length

Mandatory

Description

merchantId

String

10

Mandatory

Merchant identifier that is unique per each Merchant

subMerchantId

String

32

Optional

Sub Merchant ID

originalReferenceNo

String

40

Mandatory

Original transaction identifier on service provider system

originalPartnerReferenceNo

String

40

Mandatory

Original transaction identifier on consumer system

partnerRefundNo

String

40

Mandatory

Reference number from Merchant for the refund

refundAmount

Array of JSON Object

Variable

Mandatory

Amount of refund

"refundAmount": { "value": "10000.00", "currency": "IDR" }

value

String

12

Mandatory

Value

currency

String

3

Mandatory

Currency

externalStoreId

String

32

Optional

Unique identifier of Shop ID in Client system

reason

String

256

Optional

Refund reason

additionalInfo

JSON Object

Variable

Optional

Additional information

"additionalInfo": { "refundType": "1" }

refundType

String

2

Mandatory

Refund Type:

1: Full Refund

2: Partial Refund



Response Refund Parameter

Parameter

Type

Length

Mandatory

Description

responseCode

String

7

Mandatory

responseMessage

String

150

Mandatory

originalReferenceNo

String

40

Mandatory

Original transaction identifier on service provider system

originalPartnerReferenceNo

String

40

Mandatory

Original transaction identifier on service provider system.

Must be filled upon successful transaction.

refundNo

String

40

Mandatory

Refund number identifier on service provider system reference Number

partnerRefundNo

String

40

Mandatory

Reference number from Merchant for the refund

refundAmount

Array of JSON Object

Variable

Mandatory

Amount of refund

"refundAmount": { "value": "10000.00", "currency": "IDR" }

value

String

12

Mandatory

Value

currency

String

3

Mandatory

Currency

refundTime

String

25

Mandatory

Refund time ISO-8601, in format YYYYMMDDTHH:mm:ss+07:00.

Time must be in GMT+7 (Jakarta time).

additionalInfo

JSON Object

Variable

Mandatory

Additional Information

"additionalInfo": { "refundType": "1" }

refundType

String

2

Mandatory

Refund Type:

1: Full Refund

2: Partial Refund



Sample Parameter

Sample Request
Sample Response