Account Inquiry - Customer Topup
Specification
The Following tabel is spesification for this API :
API Name | Account Inquiry - Customer Topup |
---|---|
Function | This API is used for merchant to do inquiry customer account via Paydia Bisnis |
Service Code | 37 |
Method | POST |
URL | /snap/v1.0/emoney/account-inquiry |
Accept | application/json |
Content Type | application/json |
Related Service | Customer Topup |
Request
The following part will be describe about parameter of request in this API:
Request Parameter
The following table is a list of request parameter in this API:
Header
The following table is Header of Request Parameters :
No | Name | Type | Length | Required | Condition | Remarks |
---|---|---|---|---|---|---|
1 | Content-Type | String | Variable, 127 max | Mandatory | - | Content type, value always application/json |
2 | Authorization | String | Variable | Mandatory | - | Contains B2B Bearer JWT Token, you've got it from Access Token B2B |
3 | X-TIMESTAMP | String | Fixed, 25 max | Mandatory | - | Transaction date time, in format YYYY-MM-DDTHH:mm:ss+07:00. Time must be in GMT+7 (Jakarta time) |
4 | X-PARTNER-ID | String | Variable, 36 max | Mandatory | - | ID for partner was generated by Paydia. Unique ID for a partner |
5 | X-EXTERNAL-ID | String | Variable, 36 max | Mandatory | - | Unique messaging reference ID generated by merchant. Numeric String. Reference number that should be unique in the same day |
6 | CHANNEL-ID | String | Variable, 5 max | Mandatory | - | Device identification on which the API services is currently being accessed by the end user (customer) |
7 | X-SIGNATURE | String | Variable | Mandatory | - | Signature need to be generated with Symmetric Signature method |
Body
The following table is a body of request parameter:
No | Name | Type | Length | Required | Condition | Remarks |
---|---|---|---|---|---|---|
1 | partnerReferenceNo | String | Variable, 64 max | Mandatory | - | Unique transaction identifier on partner system which assigned to each transaction |
2 | amount | Money | Variable | Optional | - | Contains two sub-fields:
|
3 | customerNumber | String | Variable, 32 max | Mandatory | - | Destination customer account number |
4 | additionalInfo | JSON Object | Variable | Mandatory | - | Additional information |
5 | additionalInfo.productCode | String | Variable, 32 max | Mandatory | - | Additional information of product code |
Request Sample
The following script is a request sample of this API:
POST /snap/v1.0/emoney/account-inquiry
X-TIMESTAMP: 2024-07-23T10:59:57+07:00
X-PARTNER-ID: 35d1a1127182a65e4fe0256242a40a6d
X-SIGNATURE: M76Zbg5Hz9ohet1TdEGMOjdjSO4G3eSpdVb/zeiTtaP7iSh6KnHBtpF+KJFDi9e7NG96/zcSNSl+57SBVDrAjQ==
X-EXTERNAL-ID: 1721707205
CHANNEL-ID: 860
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJQYXlkaWEiLCJpYXQiOjE3MjE3MDcxNjYsImV4cCI6MTcyMTc5MzU2Nn0.5Kobxoo0W5mP2Zjfohd5UwifPyFFxLa32iOFiO2LcpY
{
"partnerReferenceNo": "9a513295-31a1-4d97-b103-78b500f9ae91",
"customerNumber": "081234567890",
"amount": {
"value": "10000.00",
"currency": "IDR"
},
"additionalInfo": {
"productCode": "payout_emoney_paydia"
}
}
Response
The following part will be describe about parameter of response in this API:
Response Parameter
The following table is a list of response parameter in this API:
Body
The following table is a body of response parameter:
No | Name | Type | Length | Required | Condition | Remarks |
---|---|---|---|---|---|---|
1 | responseCode | String | Fixed, 7 max | Mandatory | - | Refer to response code list |
2 | responseMessage | String | Variable, 150 max | Mandatory | - | Refer to response code list |
3 | referenceNo | String | Variable, 64 max | Optional | - | Transaction identifier on Paydia |
4 | partnerReferenceNo | String | Variable, 64 max | Mandatory | - | Unique transaction identifier on partner system which assigned to each transaction |
5 | customerNumber | String | Variable, 64 max | Mandatory | - | Customer Account Number |
6 | customerName | String | Variable, 255 max | Mandatory | - | Customer account name |
7 | amount | Money | Variable | Optional | - | Amount. Contains two sub-fields:
|
8 | additionalInfo | JSON Object | Variable | Mandatory | - | Additional information |
9 | additionalInfo.balance | Money | Variable | Mandatory | - | Additional information of merchant's balance. Contains two sub-fields:
|
Response Sample
The following script is a response sample of this API:
{
"responseCode": "2003700",
"responseMessage": "Successful",
"referenceNo": "13fe0061-873f-44ee-8232-427ab06e699c",
"partnerReferenceNo": "9a513295-31a1-4d97-b103-78b500f9ae91",
"customerNumber": "081234567890",
"customerName": "Firman Zain",
"amount": {
"value": "10000.00",
"currency": "IDR"
},
"additionalInfo": {
"balance": {
"value": "245249325.00",
"currency": "IDR"
}
}
}
Response Code and Message
The following table is the list response code and message of Account Inquiry API:
No | Response Code | Response Message | Remarks |
---|---|---|---|
1 | 2004200 | Successful | Success to be processed |
2 | 4004201 | Invalid Field Format | Invalid format for certain field |
3 | 4004202 | Invalid Mandatory Field | Missing or invalid format on mandatory field |
4 | 4014200 | Unauthorized. [reason] | General unauthorized error |
5 | 4014201 | Invalid Token (B2B) | Invalid or Expired Access Token |
6 | 4044203 | Bank Not Supported By Switch | Bank not supported by switch |
7 | 4044211 | Invalid Account | Destination account invalid |
8 | 4094200 | Conflict | Cannot use same X-EXTERNAL-ID in same day |
9 | 4094201 | Duplicate partnerReferenceNo | Duplicate partnerReferenceNo |
10 | 5004202 | Backend system failure | 500 internal server error |