Refund Payment

Spesifikasi

Tabel berikut adalah spesifikasi dari API ini :

API Name	Refund Payment
Function	API ini digunakan untuk mengembalikan pesanan dari platform pedagang ke Paydia
Service Code	78
Method	POST
URL	/snap/v1.0/qr/qr-mpm-refund
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	Mandatory	-	Jenis konten, selalu bernilai application/json
2	Authorization	String	Variabel	Opsional	Jika opsi Signature adalah pendekatan asimetris	Mengandung Token JWT B2B Bearer, Anda mendapatkannya dari Token Akses B2B
3	X-TIMESTAMP	String	Tetap, maksimal 25	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 dibuat secara otomatis dengan metode symmetricSignature atau asymmetricSignature
5	X-PARTNER-ID	String	Variabel, maksimal 36	Mandatory	-	ID untuk mitra yang dibuat oleh Paydia. ID unik untuk mitra
6	X-EXTERNAL-ID	String	Variabel, maksimal 36	Mandatory	-	ID referensi pesan unik yang dibuat oleh pedagang. Angka String. Nomor referensi yang harus unik pada hari yang sama
7	CHANNEL-ID	String	Variabel, maksimal 5	Mandatory	-	Identifikasi perangkat di mana layanan API sedang diakses oleh pengguna akhir (pelanggan)

Header

Tabel berikut adalah isi dari Parameter Permintaan:

No	Name	Type	Length	Required	Condition	Remarks
1	merchantid	String	Variabel, maksimal 64	Mandatory	-	Pengidentifikasi pedagang yang unik untuk setiap pedagang
2	originalPartnerReferenceNo	String	Variabel, maksimal 64	Mandatory	-	Identifikasi transaksi asli pada sistem mitra
3	originalReferenceNo	String	Variabel, maksimal 64	Opsional	-	Identifikasi transaksi asli pada sistem Paydia. Harus diisi setelah transaksi sukses
4	partnerRefundNo	String	Variabel, maksimal 64	Mandatory	-	Nomor referensi dari pedagang untuk pengembalian
5	refundAmount	Money	Variabel	Mandatory	-	Berisi dua sub-bidang: Nilai: Jumlah transaksi, termasuk sen Mata Uang: Kode mata uang berdasarkan ISO
6	additionalInfo	Objek JSON	Variabel	Opsional	-	Informasi Tambahan
7	additional.callback	String	Variabel	Opsional	-	URL untuk menerima pemberitahuan pembayaran setelah pembayaran dilakukan oleh pelanggan

Contoh Request

Skrip berikut adalah contoh permintaan dari API ini:

POST .../snap/v1.0/qr/qr-mpm-refund
X-TIMESTAMP: 2022-09-29T10:30:00+07:00
X-PARTNER-ID: 7c357677e7e02547ef33fafca165a574
X-SIGNATURE: BT5WSwbLzq3kOngSDrvIqV9crVe3lwi0OF5CoG6Z5j0ItfmBSPJ/H1l/3nWefbHp/EcnGpEiYY+f3Sh40cR4RyWn3TST3Qk3u154ZA3Nn/gWgZYePjIvqCuzIwrkoSP4pVPK5QbWiPRDhyB9VzCFT4vYM806ULyI41Hn/RzBaFtujLKlTGZNSH3cLsV72HUKyC3SP35S4wGha+RnzzxRRV1Ma5lg4S1teUjnO3d41Cy9m4EW7gzoAuxfwknBCTF3f8yABs8kGAnUWqelIKxsyQ65OxUvY4u2G6fM/Tx1mDboBbY1d9P6ZODCtaT+a2s8StAju68hvOPTBUJAI1uBlw==
X-EXTERNAL-ID: 1664420431
CHANNEL-ID: 12345
Authorization: Bearer d3b40492d71df7b7e75ed656b1ff3ee46a5b358c26853178d4bef28771b63019
Content-Type: application/json
{
    "merchantId": "220901002000000",
    "originalPartnerReferenceNo": "2020102900000000000026",
    "originalReferenceNo": "220928000007",
    "partnerRefundNo": "REF2022092800000000000005",
    "refundAmount": {
        "value": "2500.00",
        "currency": "IDR"
    },
    "additionalInfo": {
        "callback": "https://callback.site/"
    }
}

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	Mandatory	-	Lihat daftar kode tanggapan
2	responseMessage	String	Variabel, maksimal 150	Mandatory	-	Lihat daftar kode tanggapan
3	originalReferenceNo	String	Variabel, maksimal 64	Opsional	Harus diisi setelah transaksi sukses	Identifikasi transaksi asli pada sistem Paydia. Harus diisi setelah transaksi sukses
4	originalPartnerReferenceNo	String	Variabel, maksimal 64	Mandatory	-	Identifikasi transaksi asli pada sistem mitra
5	originalExternalId	String	Variabel, maksimal 36	Opsional	-	ID eksternal asli pada pesan header
6	refundNo	String	Variabel, maksimal 64	Mandatory	-	Nomor pengidentifikasi pengembalian pada nomor referensi sistem penyedia layanan
7	partnerRefundNo	String	Variabel, maksimal 64	Mandatory	-	Nomor referensi dari pedagang untuk pengembalian
8	refundAmount	Money	Variabel	Mandatory	-	Berisi dua sub-bidang: Nilai: Jumlah transaksi, termasuk sen Mata Uang: Kode mata uang berdasarkan ISO
9	refundTime	String	Tetap, maksimal 25	Mandatory	-	Waktu pengembalian. ISO 8601, dalam format YYYY-MM-DDTHH:mm:ss+07:00. Waktu harus dalam GMT+7 (Waktu Jakarta)
10	additionalInfo	Objek JSON	Variabel	Opsional	-	Informasi Tambahan

Contoh Tanggapan

Skrip berikut adalah contoh tanggapan dari API ini:

{
    "responseCode": "2007800",
    "responseMessage": "Successful",
    "originalReferenceNo": "220928000007",
    "originalPartnerReferenceNo": "2020102900000000000026",
    "originalExternalId": "1664418745",
    "refundNo": "",
    "partnerRefundNo": "REF2022092800000000000005",
    "refundAmount": {
        "value": "2500.00",
        "currency": "IDR"
    },
    "refundTime": "2022-09-29T09:31:49+07:00",
    "additionalInfo": {
        "callback": "https://callback.site"
    }
}

Response Code dan Response Message

Tabel berikut adalah daftar kode tanggapan dan pesan dari API Refund Payment:

No	Response Code	Response Message	Remarks
1	2007800	Successful	Berhasil diproses
2	2027800	Request In Progress	Transaksi masih dalam proses
3	4007801	Invalid Field Format	Format tidak valid untuk beberapa bidang tertentu
4	4007802	Invalid Mandatory Field	Bidang Mandatory hilang atau formatnya tidak valid
5	4017800	Unauthorized {reason}	Kesalahan tidak diizinkan secara umum
6	4017801	Invalid Token (B2B)	Token otorisasi tidak valid, mungkin karena kadaluarsa untuk B2B
7	4037802	Exceeds Transaction Amount Limit	Melebihi batas jumlah transaksi
8	4037814	Insufficient Funds	Dana tidak mencukupi untuk melakukan pengembalian
9	4047800	Invalid Transaction Status	Status transaksi tidak valid
10	4047808	Invalid Merchant	Pedagang tidak ada atau statusnya tidak normal
11	4047812	Invalid Bill	Tagihan tidak ditemukan
12	4047813	Invalid Amount	Jumlah pengembalian tidak valid
13	4097801	Duplicate partnerRefundNo	Duplikat partnerRefundNo
14	5007802	Backend system failure	Kesalahan server internal 500