Get Disbursements - Singapay PG

Information

Method	Path	Format	Authentication
GET	`/api/v1.0/disbursements/{account_id}`	json	OAuth 2.0 with Access Token

Request Details

Headers Structure

Field	Value	Type	Mandatory	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{…}

Body Structure

Field	Value	Type	Mandatory	Length	Description	Example
page	{pageNumber}	Numeric	Optional	-	-	2

Body Example

{
  "page": 2,
}

Response Details

Response Structure

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	-	-	-
> transaction_id	Numeric	Mandatory	-	Transaction id	36455454
> status	Alphabetic	Mandatory	-	Transaction status. Value will be success, failed, pending	success
> bank	Object	-	-	-	-
>> code	Alphabetic	Mandatory	-	Bank code like BRI, BNI, DANAMON	BRI
>> account_number	Numeric	Mandatory	-	Beneficiary Bank account number	283434
>> account_name	Alphabetic	-	-	-	-
> post_timestamp	Timestamp	Mandatory	-	Date requested with Unix timestamp millisecond format	1714618220440
> processed_timestamp	Timestamp	-	-	Date finished with Unix timestamp millisecond format	-
> notes	Alphabetic	-	-	-	-
> amount	Object	Mandatory	-	-	-
>> value	Numeric	Mandatory	-	Transaction amount the recipient will receive	11000.00
>> currency	Alphabetic	Mandatory	3	-	IDR
> fees	Array	Mandatory	-	-	-
>> name	Alphabetic	-	-	Transaction fee name	-
>> value	Numeric	Mandatory	-	Transaction fee	2000.00
>> currency	Alphabetic	Mandatory	3	-	IDR
> total_amount	Object	Mandatory	-	-	-
>> value	Numeric	Mandatory	-	Transaction amount the recipient will receive	11000.00
>> currency	Alphabetic	Mandatory	3	-	IDR
pagination	Object	Conditional	-	-	-
> count	Numeric	Mandatory	-	Data quantity	2
> total	Numeric	Mandatory	-	Total of all data	100
> perPage	Numeric	Mandatory	-	Total data per page	10
> currentPage	Numeric	Mandatory	-	Current page	1
> totalPages	Numeric	Mandatory	-	Total page	3
> links	Object	Mandatory	-	Next or previous links	-

Response Example

Success: Here’s an example of a successful response.

{
  "status": 200,
  "success": true,
  "data": [
    {
      "status": 200,
      "success": true,
      "data": {
        "transaction_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"
    }
    }
  ],
  "pagination": {
    "count": 10,
    "total": 14,
    "perPage": 10,
    "currentPage": 1,
    "totalPages": 2,
    "links": {}
  }
}

Error: This is an example of an unsuccessful request.

{
    "status": 401,
    "success": false,
    "error": {
        "code": 401,
        "message": "Unauthorized partner, please sign in"
    }
}

On this page