Cancel Transaction - API Payout (Disbursement) SNAP
This API with SNAP standards uses to request abort the Disbursement process after approval phase and before the execution time.
Please request the access token firsthand before doing the authentication through the Request Access Token API - SNAP section.
API Endpoint | |
|---|---|
HTTP Method | POST |
Description | Cancel Payout Transaction |
Content-type | application/json |
Parameter | Type | Length | Required | Description | Example |
|---|---|---|---|---|---|
Content-Type | String | 127 | Mandatory | Content type, value always 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 | Unique Partner ID, Partner ID = Client ID | |
X-EXTERNAL- ID | String | 40 | Mandatory | Unique messaging Reference ID generated by Merchant. Numeric String. Reference number that should be unique in every transaction. | |
CHANNEL-ID | String | 20 | Mandatory | Unique Channel Merchant Credential ID Number. Client ID + "01" = Channel ID "IONPAYTEST" + "01" = "IONPAYTEST01" | IONPAYTEST01 |
Parameter | Type | Length | Required | Description |
|---|---|---|---|---|
merchantId | String | 10 | Mandatory | Merchant identifier that is unique per each Merchant |
originalReferenceNo | String | 40 | Mandatory | Original transaction identifier on service provider system |
originalPartnerReferenceNo | String | 40 | Mandatory | Original transaction identifier on consumer system |
Parameter | Type | Length | Required | Description |
|---|---|---|---|---|
responseCode | String | 7 | Mandatory | Refer to General Response Code and Message - API SNAP list |
responseMessage | String | 150 | Mandatory | Refer to General Response Code and Message - API SNAP list |
originalRefere nceNo | String | 40 | Mandatory | Original transaction identifier on service provider system |
originalPartner ReferenceNo | String | 40 | Mandatory | Original transaction identifier on service provider system. Must be filled upon successful transaction. |
beneficiaryAccountNo | String | 25 | Mandatory | Beneficiary Account Number |
beneficiaryName | String | 100 | Mandatory | Beneficiary Name |
beneficiaryBankCode | String | 4 | Mandatory | Beneficiary Bank Code - API SNAP |
amount | Array of JSON Object | Variable | Mandatory | Amount Information "amount": {...} |
value | String | 12 | Mandatory | Transaction amount, If it’s IDR then value includes 2 decimal digits. e.g. IDR 10.000,- will be placed with 10000.00 |
currency | String | 3 | Mandatory | Currency code based on ISO |
