API INQUIRY ACCOUNT
About 1 min
Request
The Account Inquiry API enables merchants to retrieve the account name.
Request Path:
production:
https://gateway.smilepayz.com/v2.0/inquiry-account
Header Parameters
| Field | Required | Type | Description |
|---|---|---|---|
| Content-Type | M | String | HTTP content type specification Fixed value: application/json Required for proper request parsing |
| X-TIMESTAMP | M | String | ISO 8601 datetime format with timezone offset Format: yyyy-MM-ddTHH:mm:ss±HH:mm Example: 2020-12-17T10:55:00+07:00 Note: Must be current server time within ±5 minutes |
| X-SIGNATURE | M | String | Digital signature for request authentication. See Signature Generation |
| X-PARTNER-ID | M | String | Unique merchant identifier assigned by the platform Format: Alphanumeric string Used for merchant authentication and transaction routing Please enter merchantID |
Body Parameters
| Field | Required | Type | Description |
|---|---|---|---|
| merchantId | M | String | Primary merchant identifier assigned by the platform Format: Alphanumeric string Used for transaction routing and settlement processing |
| bankAccountNo | M | String | the account number to be queried |
| paymentMethod | M | String | the payment method like bank name or e-wallet name |
| area | M | Integer | Area code ,for Indonesia is 10 |
:::
Example Header – Balance Inquiry Request:
POST {Base URL}/v2.0/inquiry-balance HTTP/1.2
Content-type: application/json
X-TIMESTAMP: 2020-12-18T15:06:00+07:00
X-SIGNATURE: 85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5
X-PARTNER-ID: 20001
{
"merchantId": "20019",
"bankAccountNo": "40755555555",
"paymentMethod": "BCA",
"area": 10
}
Response
HTTP Request
| Field | Required | Type | Description |
|---|---|---|---|
| Content-Type | M | String | HTTP response content type specification Fixed value: application/json Indicates JSON response format |
| X-TIMESTAMP | M | String | ISO 8601 datetime format with timezone offset Format: yyyy-MM-ddTHH:mm:ss±HH:mm Example: 2020-12-17T10:55:00+07:00 |
Response Body
| Field | Required | Type | Description |
|---|---|---|---|
| code | M | String | API response status code indicating operation result Format: Two-digit string Success: "00", Error: Other codes Used for programmatic response handling |
| message | M | String | Human-readable response status description Format: UTF-8 encoded string Provides detailed information about the operation result |
| bankAccountNo | O | String | the account number |
| bankAccountName | O | List | Account holder name |
| paymentMethod | O | String | the payment method like bank name or e-wallet name |
Example Body – Balance Inquiry Response:
Content-type: application/json
X-TIMESTAMP: 2020-12-17T10:55:00+07:00
{
"bankAccountNo": "40755456555",
"bankAccountName": "the name",
"paymentMethod": "BCA",
"message": null,
"code": "00"
}
