---
title: Cancel Transaction - API Payout (Disbursement) SNAP
slug: nicepay-api-snap-cancel-transaction-payout-disbursement
description: Informasi tentang Cancel Transaction - API Payout (Disbursement) SNAP yang terdapat pada sistem NICEPAY
image: https://archbee-image-uploads.s3.amazonaws.com/ZHvSjR5ZrsoxwKbJa3xmo/iBzYWBsq5w5KMj9WxVeUv_microsoftteams-image.png
icon: {"faIcon":"fa-solid fa-book"}
docTags:
createdAt: 2023-02-17T11:11:04.000Z
---
# Tentang Request Cancel Transaction - API Payout (Disbursement) SNAP
***
API ini digunakan untuk melakukan pengajuan pembatalan proses Disbursement setelah tahap *approval *dan sebelum waktu eksekusi berjalan.
# Request Cancel Transaction - API Payout (Disbursement) SNAP
***
:::hint{type="warning"}
Silakan mengajukan akses token terlebih dahulu untuk melakukan autentikasi melalui bagian [Request Access Token API - SNAP](docId\:GcGqBIYXG1Etcd0Ji9cHX).
:::
| **API Endpoint** | [`/nicepay/api/v1.0/transfer/cancel`](https://www.nicepay.co.id/nicepay/api/v1.0/transfer/cancel) |
| ---------------- | ------------------------------------------------------------------------------------------------- |
| **HTTP Method** | **POST** |
| **Description** | Cancel Payout Transaction
|
| **Content-type** | `application/json` |
## Request Cancel Disbursement Header Parameter
| **Parameter** | **Tipe** | **Ukuran** | **Kebutuhan** | **Deskripsi** | **Contoh** |
| ----------------------- | -------- | ---------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ |
| `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.
[Panduan X-Signature - Symmetric](docId\:UZex33ReLyENKOgbJJnYp) | |
| `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 |
## Request Cancel Disbursement Body Parameter
| **Parameter** | **Tipe** | **Ukuran** | **Kebutuhan** | **Deskripsi** |
| ---------------------------- | -------- | ---------- | ------------- | ---------------------------------------------------------- |
| `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 |
## Response Cancel Disbursement Parameter
| **Parameter** | **Tipe** | **Ukuran** | **Kebutuhan** | **Deskripsi** |
| ------------------------------------ | ------------------------- | ---------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `responseCode` | String | 7 | Mandatory | Refer to [General Response Code and Message - API SNAP](docId\:lKqJXSl5CMKdXYXxHYYSs) list |
| `responseMessage` | String | 150 | Mandatory | Refer to [General Response Code and Message - API SNAP](docId\:lKqJXSl5CMKdXYXxHYYSs) 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](docId:9WOQy5-1hlf_uCwshSDHO) |
| `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 |
## Sample Parameter
:::CodeblockTabs
Request Body
```json
//HEADER SECTION
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJJT05QQVlURVNUIiwiaXNzIjoiTklDRVBBWSIsIm5hbWUiOiJCUklOIiwiZXhwIjoiMjAyNC0wMi0xMVQwODowOTozNVoifQ==.aIybLX36dYwfFvW7dcoenXkOe2EAwIYq84ZtPuIf3K8=
X-TIMESTAMP: 2024-12-31T10:11:40+07:00
X-SIGNATURE: ufBw7R8RhW79IOiV/Hlv607M60qzAYBv8uZmbSrYb6/Thlo/FhQVP4xRyelUehoSS9o+QS6vWTKb/ygtucC+tQ==
X-PARTNER-ID :IONPAYTEST
X-EXTERNAL-ID: eXid202402111402271707638106
CHANNEL-ID: IONPAYTEST
{
"merchantId": "IONPAYTEST",
"originalPartnerReferenceNo": "order1677048512514",
"originalReferenceNo": "IONPAYTEST07202302221348332909"
}
```
Sample Response
```json
{
"responseCode": "2000000",
"responseMessage": "Successful",
"originalPartnerReferenceNo": "order1677048512514",
"originalReferenceNo": "IONPAYTEST07202302221348332909",
"beneficiaryAccountNo": "5345000060",
"beneficiaryName": "NICEPAY",
"beneficiaryBankCode": "CENA",
"amount": {
"value": "10000.00",
"currency": "IDR"
}
}
```
:::