Payment Notify v1.0.0 (Deprecated)
Specification
The Following tabel is spesification for this API :
API Name | Payment Notify |
---|---|
Function | This API is used to notify payment status and information from Paydia to merchant’s platform |
Service Code | 52 |
Method | POST |
URL | /snap/v1.0/qr/qr-mpm-notify |
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 | 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) |
3 | X-PARTNER-ID | String | Variable, 36 max | Mandatory | - | ID for partner was generated by Paydia. Unique ID for a partner |
4 | 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 |
5 | CHANNEL-ID | String | Variable, 5 max | Mandatory | - | Device identification on which the API services is currently being accessed by the end user (customer) |
6 | X-SIGNATURE | String | Variable | Mandatory | - | Signature need to be validate with Asymmetric 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 | Mandatory | - | Original transaction identifier on partner system |
2 | originalReferenceNo | String | Variable, 64 max | Mandatory | - | Original transaction identifier on Paydia system. Must be filled upon successful transaction |
3 | merchantid | String | Variable, 64 max | Mandatory | - | Merchant identifier that is unique per each merchant |
4 | amount | Money | Variable | Mandatory | - | Contains two sub-fields:
|
5 | latestTransactionStatus | String | Fixed, 2 max | Mandatory | - | Category code for the status of the transaction. The values include:
|
6 | createdTime | String | Fixed, 25 max | Mandatory | - | Transaction created time, in format YYYY-MM-DDTHH:mm:ss+07:00. Time must be in GMT+7 (Jakarta time) |
7 | finishedTime | String | Fixed, 25 max | Mandatory | - | Transaction created time, in format YYYY-MM-DDTHH:mm:ss+07:00. Time must be in GMT+7 (Jakarta time) |
8 | additionalInfo | JSON Object | Variable | Optional | - | Additional Information |
Request Sample
The following script is a request sample of this API:
POST /v1.0/qr/qr-mpm-notify
X-TIMESTAMP: 2022-09-28T16:28:36+07:00
X-PARTNER-ID: 7c357677e7e02547ef33fafca165a574
X-SIGNATURE: I+dY/VYNhIT0+uJH+448GORGVSEG3LA43J9+U1JCxOcPxBPNxNoeXsFTN/oxnGxuEJfNC3J3aU2R3ZXHG/MT8pZM/uxSoR3TV1OUf2GdrNAeyT3zPQdNbIYTxcRmAJJUTGcr8vf132HhX+XLgi5pGyricngz11a5hlQOSprErlnGjnPvscEvhdhGku2hEo3zELEjIIxufU0jeOZlFVov6xZkrnCR03KR7R4h3erygTvQ1UhDspTDPYK/9w38d3uTCd1Siafol0HU9KcMkehu0IL2MiZDRnWtY6GPbDSHgHUkDrWt7RHV1yC0ZeGa1G4Kg/dk6hkzgk65Jlbo2vaTZg==
X-EXTERNAL-ID: 1663836108
CHANNEL-ID: 12345
Content-Type: application/json
{
"originalPartnerReferenceNo": "2020102900000000000026",
"originalReferenceNo": "220928000007",
"merchantId": "220901002000000",
"originalExternalId": "1664357352",
"externalStoreId": "12345",
"latestTransactionStatus": "00",
"transactionStatusDesc": "Success",
"createdTime": "2022-09-28T16:28:36+07:00",
"finishedTime": "2022-09-28T16:28:45+07:00",
"amount": {
"value": "10000.00",
"currency": "IDR"
},
"additionalInfo": {
"transactionDate": "2022-09-28T16:28:44+07:00",
"customerData": "John Doe",
"customerPan": "936008180000000308",
"merchantPan": "936008180220901002",
"acquirerId": "93600818",
"issuerName": "Paydia",
"rrn": "220928000004",
"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
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 |
Response Sample
The following script is a response sample of this API:
{
"responseCode": "2005200",
"responseMessage": "Successful"
}
Response Code and Message
The following table is the list response code and message of Payment Notify API:
No | Response Code | Response Message | Remarks |
---|---|---|---|
1 | 2005200 | Successful | Success to be processed |
2 | 5005202 | Backend system failure | 500 internal server error |