Disbursement
The 'Disbursements Transfer' section details the process of transferring funds to beneficiaries within the Singapay Payment Gateway. This includes initiating and managing disbursement transactions, verifying transfer statuses, and ensuring that payments are executed efficiently and accurately. Users can access information on how to process disbursements, monitor transaction progress, and resolve any issues related to fund transfers.
Method | Path | Format | Authentication |
---|---|---|---|
POST | /api/v1.0/disbursements/transfer/{account_id} | 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 |
---|---|---|---|---|---|
password | Alphanumeric | - | 12 | Password with alphanumeric characters | s0M3$tROn6.pSsWd |
bank_account_number | Numeric | Mandatory | - | Bank account number | 283434 |
notes | Alphabetic | - | - | Additional notes | - |
amount | Numeric | Mandatory | - | Transaction amount | 99000 |
currency | Alphabetic | - | - | Currency type | - |
bank_swift_code | Numeric | Mandatory | 8 | Bank swift code | BBRINJA |
{
"password": "s0M3$tROn6.pSsWd",
"amount": "11000.00",
"currency": "IDR",
"bank_swift_code": "BBRINJA",
"bank_account_number": "63434554",
"notes": "lorem ipsum"
}
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 | Object | Conditional | - | - | - |
> transaction_id | Numeric | Mandatory | - | Transaction id | 36455454 |
> status | Alphabetic | Mandatory | - | Transaction status. Value will be success, failed, pending | success |
> bank_code | Alphabetic | Mandatory | - | Bank code like BRI, BNI, DANAMON | BRI |
> bank_account_number | Numeric | Mandatory | - | Beneficiary Bank account number | 283434 |
> bank_account_name | Alphabetic | - | - | Beneficiary Bank account name | - |
> post_timestamp | Timestamp | Mandatory | - | Date requested with Unix timestamp millisecond format | 1714618220440 |
> processed_timestamp | Timestamp | - | - | Date finished with Unix timestamp millisecond format | - |
> notes | Alphabetic | - | - | Additional notes | - |
> amount | Object | Mandatory | - | - | - |
>> value | Numeric | Mandatory | - | Transaction amount the recipient will receive | 11000.00 |
>> currency | Alphabetic | Mandatory | 3 | Currency type | IDR |
> fees | Array | Mandatory | - | - | - |
>> name | Alphabetic | - | - | Transaction fee name | - |
>> value | Numeric | Mandatory | - | Transaction fee | 2000.00 |
>> currency | Alphabetic | Mandatory | 3 | Currency type | IDR |
> total_amount | Object | Mandatory | - | - | - |
>> value | Numeric | Mandatory | - | Total transaction amount the recipient will receive | 11000.00 |
>> currency | Alphabetic | Mandatory | 3 | Currency type | IDR |
> source_account | Object | Mandatory | - | - | - |
>> account_id | Numeric | - | - | Source account id | - |
> balance_after | Object | Mandatory | - | - | - |
>> currency | Alphabetic | Mandatory | 3 | Currency type | IDR |
>> value | Numeric | Mandatory | - | Balance after transaction | 13000.00 |
Success: Here’s an example of a successful response.
{
"status": 200,
"success": true,
"data": {
"status": 200,
"success": true,
"data": {
"id": "4565456565",
"status": "success",
"amount": {
"value": "11000.00",
"currency": "IDR"
},
"fees": [
{
"name": "transfer service fee name",
"value": "2000.00",
"currency": "IDR"
}
],
"total_amount": {
"value": "13000.00",
"currency": "IDR"
},
"bank": {
"code": "BRI",
"account_number": "63434554",
"account_name": "John Doe"
},
"processed_timestamp": "1714618220440",
"post_timestamp": "1714618220440",
"notes": "lorem ipsum"
},
"balance_after": {
"value": "11000.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"
}
}