---
title: Inquiry - API Payout (Disbursement) SNAP
slug: en/nicepay-api-snap-payout-inquiry-transaction-disbursement
description: Information about Request Inquiry Transaction - API Disbursement SNAP available on the NICEPAY system
image: https://archbee-image-uploads.s3.amazonaws.com/ZHvSjR5ZrsoxwKbJa3xmo/VGVhsL2_amdSFRZ4pE5z1_microsoftteams-image.png
icon: {"faIcon":"fa-solid fa-book"}
docTags: 
createdAt: 2023-05-04T03:29:46.000Z
---

# About Inquiry - API Payout (Disbursement) SNAP

***

This API uses to obtain the inquiry transaction detail going through Disbursement process.



# Inquiry - API Payout (Disbursement) SNAP

***

:::hint{type="warning"}
Please request the access token firsthand before doing the authentication through the [Request Access Token API - SNAP](docId:92feymrQs_iebHXrfgXUq) section.
:::

| **API Endpoint** | [`/nicepay/api/v1.0/transfer/inquiry`](https://www.nicepay.co.id/nicepay/api/v1.0/transfer/inquiry) |
| ---------------- | --------------------------------------------------------------------------------------------------- |
| **HTTP Method**  | **POST**                                                                                            |
| **Description**  | To obtain the inquiry transaction detail going through Disbursement process
                    |
| **Content-type** | `application/json`                                                                                  |



## Request Inquiry Disbursement Header Parameter

| **Parameter**   | **Type** | **Length** | **Required** | **Description**                                                                                                                                                                   | **Remarks**  |
| --------------- | -------- | ---------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ |
| `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.<br />Transaction date time, in format `YYYYMMDDTHH:mm:ss+07:00`.<br />Time must be in GMT+7 (Jakarta time).<br />`2022-03-21T10:11:40+07:00`. |              |
| `X-SIGNATURE`   | String   | Variable   | Mandatory    | Signature will be generated by Merchant.<br />[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<br />should be unique in every transaction.                                            |              |
| `CHANNEL-ID`    | String   | 5          | Mandatory    | Unique Channel Merchant Credential ID Number.<br />Client ID + "01" =  Channel ID <br />`"IONPAYTEST" + "01" = "IONPAYTEST01"`                                                    | IONPAYTEST01 |



## Request Inquiry Disbursement Body Parameter

| **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         |
| `beneficiaryAccountNo`       | String   | 25         | Mandatory    | Beneficiary Account Number                                 |



## Response Inquiry Disbursement Parameter

| **Parameter**                  | **Type**             | **Length** | **Required** | **Description**                                                                                                           |
| ------------------------------ | -------------------- | ---------- | ------------ | ------------------------------------------------------------------------------------------------------------------------- |
| `responseCode`                 | String               | 7          | Mandatory    | Refer to [General Response Code and Message - API SNAP](docId\:bJr4kjAmZCKnlN-5zRnvW)                                     |
| `responseMessage`              | String               | 150        | Mandatory    | Refer to [General Response Code and Message - API SNAP](docId\:bJr4kjAmZCKnlN-5zRnvW)                                     |
| `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.                   |
| `beneficiaryAccountNo`         | String               | 25         | Mandatory    | Beneficiary Account Number                                                                                                |
| `beneficiaryName`              | String               | 100        | Mandatory    | Beneficiary Name                                                                                                          |
| `beneficiaryCustomerResidence` | String               | 2          | Mandatory    | Beneficiary Customer Residence:<br />`1`: Indonesia<br />`2`: Non Indonesia                                               |
| `beneficiaryCustomerType`      | String               | 2          | Mandatory    | Beneficiary Customer Type:<br />`1`: Personal<br />`2`: Company<br />`3`: Government                                      |
| `beneficiaryBankCode`          | String               | 4          | Mandatory    | Beneficiary [Bank Code - API SNAP](docId:5PxU_cbDXVy2bIIli8_cv)                                                           |
| `amount`                       | Array of JSON Object | Variable   | Mandatory    | Amount Information<br />`"amount": {...}`                                                                                 |
| `value`                        | String               | 12         | Mandatory    | Transaction amount, If it’s IDR then value includes 2 decimal digits.<br />e.g. IDR 10.000,- will be placed with 10000.00 |
| `currency`                     | String               | 3          | Mandatory    | Currency code based on ISO                                                                                                |
| `transactionDate`              | String               | 25         | Mandatory    | Transaction Date                                                                                                          |
| `latestTransactionStatus`      | String               | 2          | Mandatory    | [Transaction Status - API SNAP](docId\:nVCLmByGXR5Uc_5qmyu7-)                                                             |
| `transactionStatusDesc`        | String               | 50         | Optional     | Transaction Status Description                                                                                            |



## 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: eXid202402111402271707638105
CHANNEL-ID: IONPAYTEST

{
    "merchantId": "IONPAYTEST",
    "originalPartnerReferenceNo": "order1677048512514",
    "originalReferenceNo": "IONPAYTEST07202302221348332909",
    "beneficiaryAccountNo": "5345000060"
}
```

Sample Response

```json
{
    "responseCode": "2000000",
    "responseMessage": "Successful",
    "originalPartnerReferenceNo": "order1677048512514",
    "originalReferenceNo": "IONPAYTEST07202302221348332909",
    "beneficiaryAccountNo": "5345000060",
    "beneficiaryName": "IONPAY NETWORKS",
    "beneficiaryBankCode": "CENA",
    "beneficiaryCustomerResidence": "1",
    "beneficiaryCustomerType": "1",
    "amount": {
        "value": "10000.00",
        "currency": "IDR"
    },
    "latestTransactionStatus": "03",
    "transactionStatusDesc": "Pending"
}
```
:::