Singapay Home Page
Logo Icon
  1. Disbursement
  2. Inquiry Status

Information

MethodPathFormatAuthentication
POST/api/v2.0/disbursement/{account_id}/inquiry-statusjsonOAuth 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…

Body Structure

FieldTypeMandatoryLengthDescriptionExample
reference_numberStringMandatoryMax: 64Reference number of the transaction to inquire about.“1134567891011”

Body Example

{
    "reference_number": "1134567891011"
}

Response Details

Response Structure

FieldTypeMandatoryLengthDescriptionExample
response_codeStringMandatory5API response code (see Appendix 01)“SP000”
response_messageStringMandatory-Description of the response“Successfully”
dataObjectConditional-Transaction details (null if error)-
> transaction_idStringMandatory-Unique identifier for the transaction“331222025121209092460774035”
> reference_numberStringMandatory-Reference number of the transaction“1134567891011”
> transaction_statusObjectMandatory-Status of the transaction-
>> codeStringMandatory-Transaction status code (see Appendix 02)“03”
>> descStringMandatory-Transaction status description“Pending”
> post_timestampStringMandatory-Date requested with Unix Timestamp millisecond format“1765505364000”
> processed_timestampStringOptional-Date finished with Unix Timestamp millisecond format“1765505964000” or null
> bankObjectMandatory-Beneficiary bank details-
>> codeStringMandatory-Bank code (e.g., BRI, BNI, DANAMON)“BRI”
>> account_nameStringOptional-Beneficiary bank account name. Can be null“Cengkal Marpaung”
>> account_numberStringMandatory-Beneficiary bank account number“1234567890000”
> gross_amountObjectMandatory-The total amount before any fees are deducted-
>> currencyStringMandatory3Currency code“IDR”
>> valueStringMandatory-Transaction amount“51000.00”
> feeObjectMandatory-Fee details for the transaction-
>> nameStringMandatory-Name of the transaction fee“Transfer Fee”
>> valueStringMandatory-Amount of the transaction fee“1000.00”
>> currencyStringMandatory3Currency code“IDR”
> net_amountObjectMandatory-The amount received by the beneficiary after fees-
>> currencyStringMandatory3Currency code“IDR”
>> valueStringMandatory-Net transaction amount“50000.00”
> balance_afterObjectMandatory-The remaining balance in the account after transaction-
>> valueStringMandatory-Balance amount“1000000.00”
>> currencyStringMandatory3Currency code“IDR”
> notesStringConditional-Additional notes for the transaction. Can be null“sometimes”

Response Examples

Success Response: Transaction found and status is Pending.

{
    "response_code": "SP000",
    "response_message": "Successfully",
    "data": {
        "transaction_id": "331222025121209092460774035",
        "reference_number": "1134567891011",
        "transaction_status": {
            "code": "03",
            "desc": "Pending"
        },
        "post_timestamp": "1765505364000",
        "processed_timestamp": null,
        "bank": {
            "code": "BRI",
            "account_name": "Cengkal Marpaung",
            "account_number": "1234567890000"
        },
        "gross_amount": {
            "currency": "IDR",
            "value": "51000.00"
        },
        "fee": {
            "name": "Transfer Fee",
            "value": "1000.00",
            "currency": "IDR"
        },
        "net_amount": {
            "currency": "IDR",
            "value": "50000.00"
        },
        "balance_after": {
            "value": "1000000.00",
            "currency": "IDR"
        },
        "notes": "sometimes"
    }
}

Success Response: Transaction found and status is Failed.

{
    "response_code": "SP000",
    "response_message": "Successfully",
    "data": {
        "transaction_id": "331222025121209092460774035",
        "reference_number": "1134567891011",
        "transaction_status": {
            "code": "06",
            "desc": "Failed"
        },
        "post_timestamp": "1765505364000",
        "processed_timestamp": "1765505964000",
        "bank": {
            "code": "BRI",
            "account_name": "Cengkal Marpaung",
            "account_number": "1234567890000"
        },
        "gross_amount": {
            "currency": "IDR",
            "value": "51000.00"
        },
        "fee": {
            "name": "Transfer Fee",
            "value": "1000.00",
            "currency": "IDR"
        },
        "net_amount": {
            "currency": "IDR",
            "value": "50000.00"
        },
        "balance_after": {
            "value": "1000000.00",
            "currency": "IDR"
        },
        "notes": "sometimes"
    }
}

Success Response: Transaction found and status is Success.

{
    "response_code": "SP000",
    "response_message": "Successfully",
    "data": {
        "transaction_id": "331222025121209092460774035",
        "reference_number": "1134567891011",
        "transaction_status": {
            "code": "00",
            "desc": "Success"
        },
        "post_timestamp": "1765505364000",
        "processed_timestamp": "1765505964000",
        "bank": {
            "code": "BRI",
            "account_name": "Cengkal Marpaung",
            "account_number": "1234567890000"
        },
        "gross_amount": {
            "currency": "IDR",
            "value": "51000.00"
        },
        "fee": {
            "name": "Transfer Fee",
            "value": "1000.00",
            "currency": "IDR"
        },
        "net_amount": {
            "currency": "IDR",
            "value": "50000.00"
        },
        "balance_after": {
            "value": "1000000.00",
            "currency": "IDR"
        },
        "notes": "sometimes"
    }
}

Error Response: Validation error - The reference number field is required.

{
    "response_code": "SP018",
    "response_message": "Validation error - The reference number field is required.",
    "data": null
}

Error Response: Transaction not found.

{
    "response_code": "SP009",
    "response_message": "Transaction Not Found",
    "data": null
}

Error Response: Invalid reference number.

{
    "response_code": "SP008",
    "response_message": "Invalid Reference Number",
    "data": {
        "reference_number": "113456xxxx"
    }
}

Error Response: General failure.

{
    "response_code": "SP002",
    "response_message": "General Failure",
    "data": null
}

For detailed information about response codes and transaction statuses, refer to: