Singapay Home Page
Logo Icon
  1. Statement
  2. List

Information

MethodPathFormatAuthentication
GET/api/v1.0/statements/{account_id}jsonOAuth 2.0 with Access Token

Request Details

Headers Structure

FieldValueTypeMandatoryLengthDescriptionExample
X-PARTNER-IDapi_keyAlphanumericMandatoryAPI key obtained from the merchant dashboard.b3ed7d4b-a96c-6c08-b3c7-12c3124242d9
Acceptapplication/jsonAlphabeticMandatorySpecifies JSON as the expected response format.application/json
AuthorizationBearer {bearerToken}AlphanumericMandatoryBearer token obtained from the get access token endpoint.Bearer eyJ0eXAiOiJKV1{…}

Response Details

Response Structure

FieldTypeMandatoryLengthDescriptionExample
statusNumericMandatory3HTTP Status Code.200
successBooleanMandatory1Indicates successful request.true
dataArray ObjectMandatory-An array containing a list of balance mutation records.-
> transaction_idAlphanumericMandatory-Unique ID for the balance transaction/mutation record.6601K3GDEQVPHBBP4GRYQADG0KXT
> merchant_reff_noAlphanumeric or nullOptional-Your custom reference from the related transaction (e.g. merchant_reff_no or payment reference on the underlying channel). Present when the source transaction had a value; otherwise null.INV-2026-0042
> typeAlphabeticMandatory-The type of ledger movement (credit or debit).credit
> kindAlphabeticMandatory-The nature or category of the transaction (e.g., disbursement, settlement).disbursement
> balance_afterObjectMandatory-The balance of the account after this transaction.-
>> valueString/NumericMandatory-The numeric value of the balance.52000.00
>> currencyAlphabeticMandatory3The currency code (e.g., IDR).IDR
> debitObjectMandatory-The amount debited from the balance.-
>> valueString/NumericMandatory-The numeric value of the debit.0.00
>> currencyAlphabeticMandatory3The currency code.IDR
> creditObjectMandatory-The amount credited to the balance.-
>> valueString/NumericMandatory-The numeric value of the credit.52000.00
>> currencyAlphabeticMandatory3The currency code.IDR
> processed_timestampString/NumericMandatory-Timestamp when the transaction was processed (in milliseconds or seconds).1756119787000
additional_infoObjectConditional-Object containing additional request information.-
> start_dateDatetimeConditional-Start date used for filtering the balance log.2025-08-01
> end_dateDatetimeConditional-End date used for filtering the balance log.2025-08-31
paginationObjectMandatory-Object containing pagination metadata.-
> countNumericMandatory-Number of items in the current page.1
> totalNumericMandatory-Total number of items across all pages.1
> perPageNumericMandatory-Items per page setting.25
> currentPageNumericMandatory-The current page number.1
> totalPagesNumericMandatory-The total number of pages.1
> linksObjectMandatory-Object containing pagination links.

Response Example

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

{
    "status": 200,
    "success": true,
    "data": [
        {
            "transaction_id": "6601K3GDEQVPHBBP4GRYQADG0KXT",
            "merchant_reff_no": "INV-2026-0042",
            "type": "credit",
            "kind": "disbursement",
            "balance_after": {
                "value": "52000.00",
                "currency": "IDR"
            },
            "debit": {
                "value": "0.00",
                "currency": "IDR"
            },
            "credit": {
                "value": "52000.00",
                "currency": "IDR"
            },
            "processed_timestamp": "1756119787000"
        }
    ],
    "additional_info": {
        "start_date": "2025-08-01",
        "end_date": "2025-08-31"
    },
    "pagination": {
        "count": 1,
        "total": 1,
        "perPage": 25,
        "currentPage": 1,
        "totalPages": 1,
        "links": {}
    }
}