---
title: Registration - API Payout (Disbursement) SNAP
slug: nicepay-api-snap-registration-payout-disbursement
description: Informasi tentang Registration - API Payout (Disbursement) SNAP yang terdapat pada sistem NICEPAY
image: https://archbee-image-uploads.s3.amazonaws.com/ZHvSjR5ZrsoxwKbJa3xmo/GtQ03NGQw41aO5zWvTyi9_microsoftteams-image.png
icon: {"faIcon":"fa-solid fa-book"}
docTags:
createdAt: 2023-02-17T11:10:01.000Z
---
# Tentang Registration - API Payout (Disbursement) SNAP
***
API ini digunakan untuk mendaftarkan proses Payout atau Disbursement sebelum melakukan proses transaksi.
# Registration - API Payout (Disbursement) SNAP
***
:::hint{type="warning"}
Silakan mengajukan akses token terlebih dahulu untuk melakukan autentikasi melalui bagian [Request Access Token API - SNAP](docId:92feymrQs_iebHXrfgXUq).
:::
| **API Endpoint** | ****`/nicepay/api/v1.0/transfer/registration` |
| ---------------- | -------------------------------------------------------------------------- |
| **HTTP Method** | **POST** |
| **Description** | Create Transaction Payout or Disbursement
|
| **Content-type** | `application/json` |
## Request Registration 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 Registration Disbursement Body Parameter
| **Parameter** | **Tipe** | **Ukuran** | **Kebutuhan** | **Deskripsi** |
| ------------------------------ | ------------------------- | ---------- | ------------- | ----------------------------------------------------------------------------------------- |
| `merchantId` | String | 10 | Mandatory | Merchant identifier that is unique per each Merchant |
| `msId` | String | 20 | Optional | Merchant Seller ID |
| `beneficiaryAccountNo` | String | 25 | Mandatory | Beneficiary Account Number |
| `beneficiaryName` | String | 100 | Mandatory | Beneficiary Name |
| `beneficiaryPhone` | String | 20 | Mandatory | Beneficiary Phone |
| `beneficiaryCustomerResidence` | String | 2 | Mandatory | Beneficiary Customer Residence:
`1`: Indonesia
`2`: Non Indonesia |
| `beneficiaryCustomerType` | String | 2 | Mandatory | Beneficiary Customer Type:
`1`: Personal
`2`: Company
`3`: Government |
| `beneficiaryPostalCode` | String
| 6 | Optional | Beneficiary Postal Code |
| `payoutMethod` | String | 4 | Mandatory | Payout Method:
`0`: Over Booking
`1`: Online Trans
`2`: SKN
`3`: RTGS |
| `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, including thecents |
| `currency` | String | 3 | Mandatory | Currency Code based on ISO |
| `partnerReferenceNo` | String | 40 | Mandatory | Transaction ID from Merchant |
| `reservedDt` | String | 8 | Optional | The date when the payment will be automatic reserved. `YYYYMMDD`: `20251231` |
| `reservedTm` | String | 6 | Optional | The date when the payment will be automatic reserved. `HH24MISS`: `235959` |
| `description` | String | 40 | Optional | Description Transaction |
## Response Registration 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 |
| `partnerReferenceNo` | String | 40 | Mandatory | Merchant Transaction Identifier |
| `originalReferenceNo` | String | 40 | Mandatory | Original Transaction Identifier on Service
Provider System |
| `beneficiaryaccountNo` | String | 25 | Mandatory | Beneficiary Account Number |
| `beneficiaryName` | String | 100 | Mandatory | Beneficiary Name |
| `payoutMethod` | String | 4 | Mandatory | Payout Method:
`0`: Over Booking
`1`: Online Trans
`2`: SKN
`3`: RTGS |
| `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: tXid202402111402271707638103
CHANNEL-ID: IONPAYTEST
{
"merchantId": "IONPAYTEST",
"msId": "",
"beneficiaryAccountNo": "5345000060",
"beneficiaryName": "IONPAY NETWORKS",
"beneficiaryPhone": "08123456789",
"beneficiaryCustomerResidence": "1",
"beneficiaryCustomerType": "1",
"beneficiaryPostalCode": "123456",
"payoutMethod": "0",
"beneficiaryBankCode": "CENA",
"amount": {
"value": "12345678.00",
"currency": "IDR"
},
"partnerReferenceNo": "order1676975014155",
"description": "This is test Request",
"reservedDt": "20230222",
"reservedTm": "172334"
}
```
Sample Response
```json
{
"responseCode": "2000000",
"responseMessage": "Successful",
"partnerReferenceNo": "order1676975014155",
"originalReferenceNo": "IONPAYTEST07202302211723331619",
"beneficiaryaccountNo": "5345000060",
"beneficiaryName": "NICEPAY",
"payoutMethod": "1",
"beneficiaryBankCode": "CENA",
"amount": {
"value": "12345678.00",
"currency": "IDR"
}
}
```
:::