Customer Topup - Inquiry Status
Specification
The Following tabel is spesification for this API :
API Name | Inquiry Status |
---|---|
Function | This API is used for merchant to do inquiry status topup customer account via Paydia Bisnis |
Service Code | 39 |
Method | POST |
URL | /snap/v1.0/emoney/topup-status |
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 | Conditional | If the signature option is asymmetric approach | 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-SIGNATURE | String | Variable | Mandatory | - | Signature will be generated automatically with symmetricSignature or asymmetricSignature method |
5 | X-PARTNER-ID | String | Variable, 36 max | Mandatory | - | ID for partner was generated by Paydia. Unique ID for a partner |
6 | 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 |
7 | CHANNEL-ID | String | Variable, 5 max | Mandatory | - | Device identification on which the API services is currently being accessed by the end user (customer) |
Body
The following table is a body of request parameter:
No | Name | Type | Length | Required | Condition | Remarks |
---|---|---|---|---|---|---|
1 | originalPartnerReferenceNo | String | Variable, 64 max | Mandatory | - | Original transaction identifier on service consumer system |
2 | originalReferenceNo | String | Variable, 64 max | Mandatory | - | Original transaction identifier on service consumer system |
3 | originalExternalId | String | Variable, 32 max | Mandatory | - | Original External-ID on header message |
4 | serviceCode | String | Variable, 2 max | Mandatory | - | Transaction type indicator (service code of the original transaction request) |
Request Sample
The following script is a request sample of this API:
POST /snap/v1.0/emoney/topup-status HTTP/1.1
X-TIMESTAMP: 2024-07-23T11:52:39+07:00
X-PARTNER-ID: 35d1a1127182a65e4fe0256242a40a6d
X-SIGNATURE: JLGYAz+QPf4be8RbS4yR5XuuHESIssb8Anfgm510U+n2Ara2W8Xj0oRD2IepHtaLW/3/lRiwwlCM2HiJIgDCmQ==
X-EXTERNAL-ID: 1721710449
CHANNEL-ID: 877
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJQYXlkaWEiLCJpYXQiOjE3MjE3MDk1MzYsImV4cCI6MTcyMTc5NTkzNn0.hZMxh6uD1n3wpOQWc1K6hAT0e-1Hz3Yb44rdXcMkJnQ
Content-Length: 168
{
"originalPartnerReferenceNo": "c6a303c3-dc72-4027-b43a-3d1840885cff",
"originalReferenceNo": "36316a5c-ff94-4b8b-ae51-a4af031288db",
"serviceCode": "38"
}
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 | originalReferenceNo | String | Variable, 64 max | Optional | - | Transaction identifier on Paydia system |
4 | originalPartnerReferenceNo | String | Variable, 64 max | Mandatory | - | Transaction identifier on partner system |
5 | originalExternalId | String | Variable, 32 max | Mandatory | - | Original External-ID on header message |
6 | serviceCode | String | Variable, 2 max | Mandatory | - | Transaction type indicator (service code of the original transaction request) |
7 | transactionDate | String | Variable, 25 max | Mandatory | - | Transaction date, in format YYYY-MM-DDTHH:mm:ss+07:00. Time must be in GMT+7 (Jakarta time) |
8 | amount | Money | Variable | Mandatory | - | Amount. Contains two sub-fields:
|
9 | latestTransactionStatus | String | Fixed, 2 max | Mandatory | - | Transaction status. Contains values:
|
10 | transactionStatusDesc | String | Variable, 32 max | Mandatory | - | Transaction status description. Contains values:
|
11 | additionalInfo | JSON Object | Variable | Mandatory | - | Additional information |
Response Sample
The following script is a response sample of this API:
{
"responseCode": "2003900",
"responseMessage": "Successful",
"originalReferenceNo": "36316a5c-ff94-4b8b-ae51-a4af031288db",
"originalPartnerReferenceNo": "c6a303c3-dc72-4027-b43a-3d1840885cff",
"originalExternalId": "1721709567",
"serviceCode": "38",
"transactionDate": "2024-07-23T11:39:27+07:00",
"amount": {
"value": "1000000.00",
"currency": "IDR"
},
"latestTransactionStatus": "00",
"transactionStatusDesc": "Success",
"additionalInfo": []
}
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 | Unauthorized [Invalid Authorization] | Access token expiry |
6 | 4014201 | Invalid Token | Token found in request is invalid (Access Token Not Exist, Access Token Expiry) |
7 | 4044203 | Bank Not Supported By Switch | Bank not supported by switch |
8 | 4044211 | Invalid Account | Destination account number |
9 | 4094200 | Conflict | Cannot use same X-EXTERNAL-ID in same day |
10 | 4094201 | Duplicate partnerReferenceNo | Duplicate partnerReferenceNo |
11 | 5004202 | Backend system failure | 500 internal server error |