Cancel Payment

The Cancel Payment feature allows merchants to cancel a payment. If the transaction has not been paid yet, the payment will be marked as canceled. If the payment has already been completed, the transaction will be voided.

Feature cancel payment only applicable to E-Wallet DANA.

Name	API Direct Debit Cancel Payment
Service Code	57
Path	/v1.0/debit/cancel
Version	1.0
HTTP Method	POST
Type Format	JSON

Request Body

Details

Key	Value	Mandatory	Length	Description
originalpartnerReferenceNo	String	M	64	Transaction identifier on service consumer system
originalReferenceNo	String	M	64	Original transaction identifier on service provider system
reason	String	O	256	Cancellation reason.
additionalInfo	Object	O		Additional information

Example request body

Details

POST .../v1.0/debit/cancel HTTP/1.2
Content-type: application/json
X-TIMESTAMP: 2020-12-23T07:44:11+07:00
X-SIGNATURE: 85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5
ORIGIN: www.hostname.com
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
CHANNEL-ID: 95221

{
   "originalPartnerReferenceNo":"2020102900000000000001",
   "originalReferenceNo":"2020102977770000000009",
   "reason":"Barang tidak tersedia",
   "additionalInfo":{
   }
}

Response Body

Details

Parameter	Data Type	Mandatory	Length	Description
responseCode	String	M	7	Response code
responseMessage	String	M	150	Response description
originalPartnerReferenceNo	String	M	64	Original transaction identifier on service consumer system
originalReferenceNo	String	M	64	Original transaction identifier on service provider system
cancelTime	String	C	25	Cancel time ISO-8601. Must be filled if cancelled transaction success
additionalInfo	Object	O		Additional information

Example Response

Details

Content-type: application/json
X-TIMESTAMP: 2020-12-23T07:44:16+07:00

{
   "responseCode":"2005700",
   "responseMessage":"Request has been processed successfully",
   "originalPartnerReferenceNo":"2020102900000000000001",
   "originalReferenceNo":"2020102977770000000009",
   "cancelTime":"2020-12-21T17:07:25+07:00",
   "additionalInfo":{
   }
}