Query Payment
Specification
The Following tabel is spesification for this API :
| API Name | Query Payment |
|---|---|
| Function | This API is used to check payment QRIS status from app merchant |
| Service Code | 51 |
| Method | POST |
| URL | /snap/v1.0/qr/qr-mpm-query |
| Accept | application/json |
| Content Type | application/json |
| Related Service | QRIS MPM (Issuer) |
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 | Authorization-Customer | String | Variable, 64 max | Mandatory | - | Contains customer token, you've got it from Access Token B2B2C |
| 4 | 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) |
| 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) |
| 8 | 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 | originalReferenceNo | String | Variable, 64 max | Conditional | y: (originalPartnerReferenceNo = null and originalExternalId = null) | Original transaction identifier on Paydia system |
| 2 | originalPartnerReferenceNo | String | Variable, 64 max | Conditional | y: (originalReferenceNo = null and originalExternalId = null) | Original transaction identifier on partner system |
| 3 | originalExternalId | String | Variable, 32 max | Conditional | y: (originalReferenceNo = null and originalPartnerReferenceNo = null) | Original transaction identifier on Paydia system |
| 4 | 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/v1.0/qr/qr-mpm-query
Authorization-Customer: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJQYXlkaWEiLCJpYXQiOjE3MjQ5MDA0MDEsImV4cCI6MTc0MDY2ODQwMSwianRpIjoiYjYwNDdiNTBkOTRmZWQ4YzA3ZjQzZTBjOGY0NGQ1NGMwMzUzZjE0NGM2NzI4YzhlOWYyMWNhYTBkNjFjMjBmNyIsImNsaWVudF9pZCI6ImRVVT0iLCJtZXJjaGFudF9taWQiOiJja1FFUzFVREJBSUJBZ0p3UUFSSiIsInNjb3BlIjoiUFVCTElDX0lEIiwic3RhdGUiOiI0YzVjOTZiNS04ZDJmLTQ2NzEtYTQ2Yy1kNzQ3ZDU3OTkxMjgifQ.Hmj5skRUj2TtA4fCCtREXwT9PkkdI2I83W-rDZx72n0
X-TIMESTAMP: 2024-09-10T13:24:42+07:00
X-PARTNER-ID: 35d1a1127182a65e4fe0256242a40a6d
X-SIGNATURE: vnmU2xPF/gnKHM8CsSPLs8K5YLFJXiOFE9uBMUJQ3Y6D/hfm540SnWw/FLyThNww0wLIdN61POdx3szkuMEofg==
X-EXTERNAL-ID: 1725949489
CHANNEL-ID: 286
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJQYXlkaWEiLCJpYXQiOjE3MjU5NDkxMjgsImV4cCI6MTcyNjAzNTUyOCwiZGF0YSI6eyJlbnYiOiJkZXZlbG9wbWVudCJ9fQ.tqcLnoXj5BFjqarIFOx688YNATijPlzA9FzRpACGfe4
{
"originalReferenceNo": "e3201ef5c7f06db5d999867b8c220809804443bbedd76d5c43fe6217c5533645",
"originalPartnerReferenceNo": "21df2838-c9e8-4aff-8c02-274ed4390e70",
"serviceCode": "51"
}
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 | latestTransactionStatus | String | Fixed, 2 max | Mandatory | - | Category code for the status of the transaction. The values include:
|
| 8 | transactionStatusDesc | String | Variable, 50 max | Optional | - | Description status transaction |
| 9 | paidTime | String | Fixed, 25 max | Mandatory | - | Time of paid, in format YYYY-MM-DDTHH:mm:ss+07:00. Time must be in GMT+7 (Jakarta time) |
| 10 | amount | Money | Variable | Mandatory | - | Contains two sub-fields:
|
| 11 | feeAmount | Money | Variable | Mandatory | - | Contains two sub-fields:
|
Response Sample
The following script is a response sample of this API:
{
"responseCode": "2005100",
"responseMessage": "Success",
"originalReferenceNo": "e3201ef5c7f06db5d999867b8c220809804443bbedd76d5c43fe6217c5533645",
"originalPartnerReferenceNo": "21df2838-c9e8-4aff-8c02-274ed4390e70",
"originalExternalId": "1725949206",
"serviceCode": "51",
"latestTransactionStatus": "00",
"transactionStatusDesc": "Success",
"paidTime": "2024-09-10T06:20:06+07:00",
"amount": {
"value": "12000.00",
"currency": "IDR"
},
"feeAmount": {
"value": "0.00",
"currency": "IDR"
}
}
Response Code and Message
The following table is the list response code and message of Direct Debit Payment API:
| No | Response Code | Response Message | Remarks |
|---|---|---|---|
| 1 | 2005100 | Request has been processed successfully | Success |
| 2 | 4005101 | Invalid Field Format | Invalid format for certain field |
| 3 | 4005102 | Invalid Mandatory Field | Missing or invalid format on mandatory field |
| 4 | 4015100 | Unauthorized. [reason] | General unauthorized error |
| 5 | 4015101 | Invalid Token (B2B) | Invalid or Expired Access Token |
| 6 | 4045101 | Transaction Not Found | Transaction not found |
| 7 | 5005101 | Internal Server Error | Unknown Internal Server Failure, Please retry the process again |