Inquiry Account - Singapay PG

Information

Method	Path	Format	Authentication
POST	`/api/v2.0/ewallet/account-inquiry`	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

Key	Data Type	Mandatory	Description
account_id	String	YES	Your Account ID
ewallet_code	String	YES	E-Wallet vendor code (e.g., DANA, SHOPEEPAY, OVO, GOPAY, SINGAPAY)
customer_number	String	YES	Customer’s e-wallet account number (phone number) to top up
amount	Object	YES	Net amount to be received by customer
> value	String (ISO 4217)	YES	Amount with 2 decimal digits (e.g., IDR 10,000 = “10000.00”)
> currency	String (ISO 4217)	YES	Currency code (IDR)

Response

Response Body

Key	Data Type	Mandatory	Description
response_code	String	YES	Response code (see Response Code appendix)
response_message	String	YES	Response description (see Response Code appendix)
data	Object	No	Conditional parameter (present on success)
> ewallet_code	String	YES	E-Wallet vendor code
> customer_number	String	YES	Customer’s e-wallet account number
> customer_name	String	YES	Customer’s e-wallet account name
> min_amount	Object	YES	Minimum transaction amount for this account
>> value	String (ISO 4217)	YES	Amount with 2 decimal digits
>> currency	String (ISO 4217)	YES	Currency code (IDR)
> max_amount	Object	YES	Maximum transaction amount for this account
>> value	String (ISO 4217)	YES	Amount with 2 decimal digits
>> currency	String (ISO 4217)	YES	Currency code (IDR)
> amount	Object	YES	Net amount received by customer
>> value	String (ISO 4217)	YES	Amount with 2 decimal digits
>> currency	String (ISO 4217)	YES	Currency code (IDR)
> fee_amount	Object	YES	Total fee per transaction charged to merchant (based on agreement)
>> value	String (ISO 4217)	YES	Amount with 2 decimal digits
>> currency	String (ISO 4217)	YES	Currency code (IDR)
> gross_amount	Object	YES	Total balance deducted from merchant account (amount + fee_amount)
>> value	String (ISO 4217)	YES	Amount with 2 decimal digits
>> currency	String (ISO 4217)	YES	Currency code (IDR)

Examples

Request Example

{
  "account_id": "01K5G4FZZ18DMK0M5QTR8Y9QY9",
  "ewallet_code": "DANA",
  "customer_number": "085733347341",
  "amount": {
    "value": "11000.00",
    "currency": "IDR"
  }
}

Response Example - Success

{
  "response_code": "SP000",
  "response_message": "Successful",
  "data": {
    "ewallet_code": "DANA",
    "customer_number": "082199721405",
    "customer_name": "Dhany",
    "min_amount": {
      "value": "10000.00",
      "currency": "IDR"
    },
    "max_amount": {
      "value": "2000000.00",
      "currency": "IDR"
    },
    "amount": {
      "value": "21000.00",
      "currency": "IDR"
    },
    "fee_amount": {
      "value": "500.00",
      "currency": "IDR"
    },
    "gross_amount": {
      "value": "21500.00",
      "currency": "IDR"
    }
  }
}

Response Example - Error

{
  "response_code": "SP117",
  "response_message": "Beneficiary Account Not Found",
  "data": {
    "ewallet_code": "DANA",
    "customer_number": "082199722404"
  }
}

Important Notes

Always perform account inquiry before triggering a top-up transaction
For sandbox testing, you can use the following customer number: 62811742234
Check the min_amount and max_amount in the response to ensure your transaction is within limits
The gross_amount is what will be deducted from your merchant account (includes fees)
The amount is what the customer will receive in their e-wallet
Refer to the Response Code appendix for all possible response codes

On this page