Transaction Status Inquiry v1.0.0 (Deprecated)
Specification
The Following tabel is spesification for this API :
API Name | Transaction Status Inquiry |
---|---|
Function | This API is used to inquiry payment status and information generated qr from merchant’s platform to Paydia |
Service Code | 53 |
Method | POST |
URL | /snap/v1.0/qr/qr-mpm-status |
Accept | application/json |
Content Type | application/json |
Related Service | QRIS MPM (Acquirer) |
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 | originalPartnerReferenceNo | String | Variable, 64 max | Conditional | y: (originalReferenceNo = null) | Original transaction identifier on partner system |
2 | serviceCode | String | Variable, 2 max | Mandatory | - | Transaction type indicator (service code of the original transaction) |
3 | merchantId | String | Variable, 64 max | Mandatory | - | Merchant identifier that is unique per each merchant |
Request Sample
The following script is a request sample of this API:
POST .../snap/v1.0/qr/qr-mpm-status
X-TIMESTAMP: 2022-09-29T10:30:00+07:00
X-PARTNER-ID: 7c357677e7e02547ef33fafca165a574
X-SIGNATURE: e3J/E/x7/n/V3T9t4CmCPyw5feN8Y1ZEosooMxhib/nipUoQQGr9Sne6+kRdkZe66w9n8mod6yCYOwf4nxnTfbdPDcx4zMGfd5ygmzHAXJKlDoNdF5wEMprMtg8gpQjQq383CASDnA0HYfXLFNTvQWQXQbII3DlDEcFwE6JAPRts+Jvp6bZK2S6iaD6ayod/VkEdQYbKNKhugJ5SfLgdmADCvNJ5MWWenwoObfdKV9QdAPLObqNTXy5XcPWPjM0XQTgCvz0qwwswU1NoO31gXVBH1EE9fhZ5L8UlWg1d1uMSCm5VyZ2cH8/eCdRFg+xd3iJNiBqtkaedZwDfAEF0jQ==
X-EXTERNAL-ID: 1664421799
CHANNEL-ID: 12345
Authorization: Bearer 91612be197a76c7e86addd86df3e877feff93d7b758fc60123a54ba7762d015b
Content-Type: application/json
{
"originalPartnerReferenceNo": "2020102900000000000028",
"serviceCode": "47",
"merchantId": "220901002000000"
}
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 | originalPartnerReferenceNo | String | Variable, 64 max | Optional | - | Original transaction identifier on partner system |
4 | originalReferenceNo | String | Variable, 64 max | Conditional | If it is success, then this value will be filled | Original transaction identifier on Paydia system |
5 | originalExternalId | String | Variable, 32 max | Optional | - | 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 | Fixed, 25 max | Optional | - | Transaction date: ISO8601, in format YYYY-MM-DDTHH:mm:ss+07:00. Time must be in GMT+7 (Jakarta time) |
8 | latestTransactionStatus | String | Fixed, 2 max | Mandatory | - | Category code for the status of the transaction. The values include:
|
9 | transactionStatusDesc | String | Variable, 50 max | Optional | - | Description status transaction |
10 | paidTime | String | Fixed, 25 max | Conditional | If the transaction is paid | Time of paid, in format YYYY-MM-DDTHH:mm:ss+07:00. Time must be in GMT+7 (Jakarta time) |
11 | amount | Money | Variable | Mandatory | - | Contains two sub-fields:
|
12 | additionalInfo | JSON Object | Variable | Optional | - | Additional Information |
Response Sample
The following script is a response sample of this API:
{
"responseCode": "2005300",
"responseMessage": "Successful",
"originalPartnerReferenceNo": "2020102900000000000028",
"originalReferenceNo": "220929000002",
"originalExternalId": "1664421619",
"serviceCode": 53,
"transactionDate": "2022-09-29T10:19:43+07:00",
"latestTransactionStatus": "00",
"transactionStatusDesc": "Success",
"paidTime": "2022-09-29T10:19:51+07:00",
"amount": {
"value": "10000.00",
"currency": "IDR"
},
"additionalInfo": {
"callback": "https://callback.site/",
"responseCallback": "\"\"",
"transactionDate": "2022-09-29T10:19:51+07:00",
"customerData": "John Doe",
"customerPan": "936008180000000308",
"merchantPan": "936008180220901002",
"acquirerId": "93600818",
"issuerName": "Paydia",
"rrn": "220929000003",
"mdr": {
"value": "70.00",
"currency": "IDR"
},
"layanan": {
"value": "0.00",
"currency": "IDR"
},
"nominalPaid": {
"value": "10000.00",
"currency": "IDR"
},
"totalPaid": {
"value": "10000.00",
"currency": "IDR"
},
"totalReceive": {
"value": "9930.00",
"currency": "IDR"
}
}
}
Response Code and Message
The following table is the list response code and message of Transaction Status Inquiry API:
No | Response Code | Response Message | Remarks |
---|---|---|---|
1 | 2005300 | Successful | Success to be processed |
2 | 4005301 | Invalid Field Format | Invalid format for certain field |
3 | 4005302 | Invalid Mandatory Field | Missing or invalid format on mandatory field |
4 | 4015300 | Unauthorized [reason] | General unauthorized error |
5 | 4015301 | Invalid Token (B2B) | Authorization token are invalid, perhaps due to token expiry for B2B |
6 | 4045301 | Transaction Not Found | Transaction / Order is not found |
7 | 5005302 | Backend system failure | 500 internal server error |