Disbursement
The Check Fee API allows you to determine the fees associated with various transactions within the Singapay Payment Gateway. This API is essential for understanding the cost implications of transactions before processing them.
Method | Path | Format | Authentication |
---|---|---|---|
POST | /api/v1.0/disbursements/check-fee | json | OAuth 2.0 with Access Token |
Field | Value | Type | Mandatory | Length | Description | Example |
---|---|---|---|---|---|---|
X-PARTNER-ID | api_key | Alphanumeric | Mandatory | API key obtained from the merchant dashboard. | b3ed7d4b-a96c-6c08-b3c7-12c3124242d9 | |
Accept | application/json | Alphabetic | Mandatory | Specifies JSON as the expected response format. | application/json | |
Authorization | Bearer {bearerToken} | Alphanumeric | Mandatory | Bearer token obtained from the get access token endpoint. | Bearer eyJ0eXAiOiJKV1{…} |
Field | Type | Mandatory | Length | Description | Example |
---|---|---|---|---|---|
bank_code | Alphabetic | Mandatory | - | Bank code like BRI, BNI, BCA | BRI |
{
"bank_code": "BRI",
}
Field | Type | Mandatory | Length | Description | Example |
---|---|---|---|---|---|
status | Numeric | Mandatory | 3 | HTTP Status Code | 200 |
success | Boolean | Mandatory | 1 | 2xx is true. 4xx-500 is false. | true |
data | Array Object | Conditional | - | - | - |
> value | Numeric | Mandatory | - | Bank service fee to beneficiary bank. Default or same bank account is Rp. 0,- | 2000.00 |
> currency | Alphabetic | Mandatory | - | Currency | IDR |
Success: Here’s an example of a successful response.
{
"status": 200,
"success": true,
"data": {
"value": "2000.00",
"currency": "IDR"
}
}
Error: This is an example of an unsuccessful request.
{
"status": 401,
"success": false,
"error": {
"code": 401,
"message": "Unauthorized partner, please sign in"
}
}