Transaction Status Inquiry v2.0.0
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/v2.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 | originalReferenceNo | String | Variable, 64 max | Conditional | y: (originalPartnerReferenceNo = null) | Original transaction identifier on Paydia system |
3 | serviceCode | String | Variable, 2 max | Mandatory | - | Transaction type indicator (service code of the original transaction) |
Request Sample
The following script is a request sample of this API:
POST /snap/v2.0/qr/qr-mpm-status
X-TIMESTAMP: 2024-07-30T10:56:34+07:00
X-PARTNER-ID: 4abbcb6ce30229994c76169006e0dc9c
X-SIGNATURE: gJOowZ1OXTXieV87CHJsZ6Q5oQTdXdXoAPw+bZrFTp3nZueO7mEm2pkL3N4v5ZcGQ5h5FHFAavXpxpnXxLPt1g==
X-EXTERNAL-ID: 1722311798
CHANNEL-ID: 12345
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJQYXlkaWEiLCJpYXQiOjE3MjIzMTA3MzEsImV4cCI6MTcyMjM5NzEzMX0.eicPgCh7TMJzx74hyNFGOI4_0XeIE3OkHhY-WkGJvFk
{
"originalPartnerReferenceNo": "64e3c0d5-e671-4a62-8c47-21f4f2f601af",
"originalReferenceNo": "966077d2679e45c39d7c0c8f1",
"serviceCode": "47"
}
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 | amount | Money | Variable | Mandatory | - | Contains two sub-fields:
|
11 | additionalInfo | JSON Object | Variable | Optional | - | Additional Information |
Response Sample
The following script is a response sample of this API:
{
"responseCode": "2005300",
"responseMessage": "Successful",
"originalPartnerReferenceNo": "64e3c0d5-e671-4a62-8c47-21f4f2f601af",
"originalReferenceNo": "966077d2679e45c39d7c0c8f1",
"originalExternalId": "1722310904",
"serviceCode": "47",
"transactionDate": "2024-07-30T10:41:44+07:00",
"latestTransactionStatus": "00",
"transactionStatusDesc": "Success",
"amount": {
"value": "10000.00",
"currency": "IDR"
},
"additionalInfo": {
"paidTime": "2024-07-30T10:56:03+07:00",
"callback": "https://webhook.site/0b33c210-236d-4b68-8bdd-76ede4313e5e",
"responseCallback": "success",
"customerData": "Firman Zain",
"customerPan": "936008180000000055",
"merchantPan": "936008180240327001",
"acquirerId": "93600818",
"acquirerName": "PT Datacell Infomedia (Paydia)",
"issuerId": "93600818",
"issuerName": "Paydia",
"referenceNumber": "240730000004",
"terminalId": "Device 1",
"amountDetail": {
"amount": {
"value": "10000.00",
"currency": "IDR"
},
"mdrAmount": {
"value": "60.00",
"currency": "IDR"
},
"receiveAmount": {
"value": "9940.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) | Invalid or Expired Access Token |
6 | 4045301 | Transaction Not Found | Transaction / Order is not found |
7 | 4095300 | Conflict | Cannot use same X-EXTERNAL-ID in same day |
8 | 4095301 | Duplicate partnerReferenceNo | Duplicate partnerReferenceNo |
9 | 5005302 | Backend system failure | 500 internal server error |