Transaction Status Inquiry
Spesifikasi
Tabel berikut adalah spesifikasi dari API ini :
API Name | Permintaan Status Transaksi |
---|---|
Function | API ini digunakan untuk menanyakan status pembayaran dan informasi dari platform merchant ke 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
Bagian berikut akan menjelaskan tentang Parameter Permintaan dari API ini :
Request Params
Tabel berikut meruapakan list Parameter Permintaan dari API ini:
Header
Tabel berikut adalah Header dari Parameter Permintaan :
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 | Conditional | If the signature option is asymmetric approach | 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-SIGNATURE | String | Variable | Mandatory | - | Signature will be generated automatically with symmetricSignature or asymmetricSignature method |
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) |
Body
Tabel berikut adalah isi dari Parameter Permintaan:
No | Name | Type | Length | Required | Condition | Remarks |
---|---|---|---|---|---|---|
1 | Content-Type | String | Variable, maks. 127 karakter | Mandatory | - | Jenis konten, nilai selalu application/json |
2 | Authorization | String | Variable | Opsional | Jika opsi tanda tangan adalah pendekatan asimetris | Berisi Token B2B Bearer JWT, Anda mendapatkannya dari Access Token B2B |
3 | X-TIMESTAMP | String | Fixed, maks. 25 karakter | Mandatory | - | Tanggal dan waktu transaksi, dalam format YYYY-MM-DDTHH:mm:ss+07:00. Waktu harus dalam GMT+7 (Waktu Jakarta) |
4 | X-SIGNATURE | String | Variable | Mandatory | - | Tanda tangan akan dihasilkan secara otomatis dengan metode symmetricSignature atau asymmetricSignature |
5 | X-PARTNER-ID | String | Variable, maks. 36 karakter | Mandatory | - | ID untuk mitra yang dihasilkan oleh Paydia. ID unik untuk mitra |
6 | X-EXTERNAL-ID | String | Variable, maks. 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 | Variable, maks. 5 karakter | Mandatory | - | Identifikasi perangkat di mana layanan API saat ini diakses oleh pengguna akhir (pelanggan) |
Contoh Request
Skrip berikut adalah contoh permintaan dari API ini:
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"
}
Respon
Bagian berikut ini akan menjelaskan tentang parameter respon API ini:
Respon Parameter
Tabel berikut ini adalah list dari respon parameter pada API ini:
Body
Tabel berikut adalah isi Parameter Body Respon:
No | Name | Type | Length | Required | Condition | Remarks |
---|---|---|---|---|---|---|
1 | responseCode | String | Fixed, maks. 7 karakter | Mandatory | - | Lihat daftar kode respons |
2 | responseMessage | String | Variable, maks. 150 karakter | Mandatory | - | Lihat daftar kode respons |
3 | originalPartnerReferenceNo | String | Variable, maks. 64 karakter | Opsional | - | Identifier transaksi asli pada sistem mitra |
4 | originalReferenceNo | String | Variable, maks. 64 karakter | Opsional | Jika berhasil, maka nilai ini akan diisi | Identifier transaksi asli pada sistem Paydia |
5 | originalExternalId | String | Variable, maks. 32 karakter | Opsional | - | Original external ID pada pesan header |
6 | serviceCode | String | Variable, maks. 2 karakter | Mandatory | - | Indikator tipe transaksi (service code dari permintaan transaksi asli) |
7 | transactionDate | String | Fixed, maks. 25 karakter | Opsional | - | Tanggal transaksi: ISO8601, dalam format YYYY-MM-DDTHH:mm:ss+07:00. Waktu harus dalam GMT+7 (Waktu Jakarta) |
8 | latestTransactionStatus | String | Fixed, maks. 2 karakter | Mandatory | - | Kode kategori untuk status transaksi. Nilainya termasuk:
|
9 | transactionStatusDesc | String | Variable, maks. 50 karakter | Opsional | - | Deskripsi status transaksi |
10 | paidTime | String | Fixed, maks. 25 karakter | Opsional | Jika transaksi sudah dibayar | Waktu pembayaran, dalam format YYYY-MM-DDTHH:mm:ss+07:00. Waktu harus dalam GMT+7 (Waktu Jakarta) |
11 | amount | Money | Variable | Mandatory | - | Berisi dua sub-field:
|
12 | additionalInfo | JSON Object | Variable | Opsional | - | Informasi tambahan |
Contoh Response
Skrip berikut adalah contoh respon dari API ini:
{
"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 dan Response Message
Tabel berikut adalah list kode respon dan pesan dari API history transaksi:
No | Response Code | Response Message | Remarks |
---|---|---|---|
1 | 2005300 | Successful | Berhasil diproses |
2 | 4005301 | Invalid Field Format | Format tidak valid untuk beberapa field tertentu |
3 | 4005302 | Invalid Mandatory Field | Field wajib kosong atau memiliki format tidak valid |
4 | 4015300 | Unauthorized {reason} | Kesalahan otorisasi umum |
5 | 4015301 | Invalid Token (B2B) | Token otorisasi tidak valid, mungkin karena kedaluwarsa untuk B2B |
6 | 4045301 | Transaction Not Found | Transaksi / Pesanan tidak ditemukan |
7 | 5005302 | Backend system failure | Gagal server internal 500 |