Payment Notify
Spesifikasi
Tabel berikut adalah spesifikasi dari API ini :
API Name | Payment Notify |
---|---|
Function | API ini digunakan untuk memberitahukan status pembayaran dan informasi dari Paydia ke platform pedagang |
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
Bagian berikut akan menjelaskan tentang parameter permintaan dalam API ini:
Request Params
Tabel berikut adalah daftar parameter permintaan dalam API ini:
Header
Tabel berikut adalah Header dari Parameter Permintaan :
No | Name | Type | Length | Required | Condition | Remarks |
---|---|---|---|---|---|---|
1 | Content-Type | String | Variabel, maksimal 127 karakter | Mandatory | - | Jenis konten, nilai selalu application/json |
2 | Authorization | String | Variabel | Opsional | Jika pilihan Signature menggunakan pendekatan asimetris | Mengandung B2B Bearer JWT Token, Anda mendapatkannya dari Access Token B2B |
3 | X-TIMESTAMP | String | Tetap, maksimal 25 karakter | Mandatory | - | Waktu tanggal transaksi, dalam format YYYY MM-DDTHH:mm:ss+07:00. Waktu harus dalam GMT+7 (waktu Jakarta) |
4 | X-SIGNATURE | String | Variabel | Mandatory | - | Signature akan dihasilkan secara otomatis dengan metode symmetricSignature atau asymmetricSignature |
5 | X-PARTNER-ID | String | Variabel, maksimal 36 karakter | Mandatory | - | ID untuk mitra yang dihasilkan oleh Paydia. ID unik untuk seorang mitra |
6 | X-EXTERNAL-ID | String | Variabel, maksimal 36 karakter | Mandatory | - | ID referensi pesan unik yang dihasilkan oleh pedagang. String numerik. Nomor referensi yang harus unik dalam satu hari yang sama |
7 | CHANNEL-ID | String | Variabel, maksimal 5 karakter | Mandatory | - | Identifikasi perangkat yang saat ini digunakan oleh pengguna akhir (pelanggan) untuk mengakses layanan API |
Header
Tabel berikut adalah isi dari Parameter Permintaan:
No | Name | Type | Length | Required | Condition | Remarks |
---|---|---|---|---|---|---|
1 | originalPartnerReferenceNo | String | Variabel, maksimal 64 karakter | Mandatory | - | Identifikasi transaksi asli pada sistem mitra |
2 | originalReferenceNo | String | Variabel, maksimal 64 karakter | Mandatory | - | Identifikasi transaksi asli pada sistem Paydia. Harus diisi setelah transaksi berhasil |
3 | merchantid | String | Variabel, maksimal 64 karakter | Mandatory | - | Identifikasi pedagang yang unik untuk setiap pedagang |
4 | amount | Uang | Variabel | Mandatory | - | Mengandung dua sub-field:
|
5 | latestTransactionStatus | String | Tetap, maksimal 2 karakter | Mandatory | - | Kode kategori untuk status transaksi. Nilainya termasuk:
|
6 | createdTime | String | Tetap, maksimal 25 karakter | Mandatory | - | Waktu pembuatan transaksi, dalam format YYYY-MM-DDTHH:mm:ss+07:00. Waktu harus dalam GMT+7 (waktu Jakarta) |
7 | finishedTime | String | Tetap, maksimal 25 karakter | Mandatory | - | Waktu pembuatan transaksi, dalam format YYYY-MM-DDTHH:mm:ss+07:00. Waktu harus dalam GMT+7 (waktu Jakarta) |
8 | additionalInfo | Objek JSON | Variabel | Opsional | - | Informasi Tambahan |
Contoh Request
Script berikut adalah contoh permintaan dari API ini:
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
Bagian berikut akan menjelaskan tentang parameter tanggapan dalam API ini:
Response Params
Tabel berikut adalah daftar parameter tanggapan dalam API ini:
Header
Tabel berikut adalah isi Parameter Body Respon:
No | Name | Type | Length | Required | Condition | Remarks |
---|---|---|---|---|---|---|
1 | responseCode | String | Tetap, maksimal 7 karakter | Mandatory | - | Lihat daftar kode tanggapan |
2 | responseMessage | String | Variabel, maksimal 150 karakter | Mandatory | - | Lihat daftar kode tanggapan |
Contoh Tanggapan
Script berikut adalah contoh tanggapan dari API ini:
{
"responseCode": "2005200",
"responseMessage": "Successful"
}
Response Code dan Response Message
Tabel berikut adalah daftar kode tanggapan dan pesan dari API Payment Notify:
No | Response Code | Response Message | Remarks |
---|---|---|---|
1 | 2005200 | Successful | Berhasil diproses |
2 | 5005202 | Backend system failure | Kesalahan server internal 500 |