E-Money
E-Money Refund
Panduan lengkap untuk melakukan refund E-Money menggunakan API Paylabs.
Request URL
URL: ${ROOT_URL}/payment/v2.3/ewallet/refund
HTTPMethod: POST
EndpointUrl: /payment/v2.3/ewallet/refund
Refund Supported Channel
| Channel | Support |
|---|---|
| DANA | Y |
| Shopee | Y |
| Linkaja | Y |
| OVO | N |
| Gopay | Y |
E-Money Refund Request Parameters
Header
| Field Name | Type | Value | Required |
|---|---|---|---|
| Content-Type | String(30) | Isi dengan nilai "application/json;charset=utf-8" | Yes |
| X-TIMESTAMP | String(29) | Waktu saat ini, dengan format 2022-09-16T16:58:47.964+07:00 | Yes |
| X-SIGNATURE | String(64) | Signature. Untuk selengkapnya cek | Yes |
| X-PARTNER-ID | String(20) | Merchant ID | Yes |
| X-REQUEST-ID | String(64) | ID unik merepresentasikan setiap request yang dikirim | Yes |
Body
| Parameter | Type | Required | Remarks |
|---|---|---|---|
| requestId | String(64) | Yes | Kode unik untuk setiap request |
| merchantId | String(20) | Yes | ID unik yang disediakan oleh payment gateway ke merchant |
| storeId | String(30) | No | Jika Merchant memiliki cabang dan ingin membuat order dengan ID cabang |
| merchantTradeNo | String(32) | Yes | Kode unik yang dibuat oleh Merchant untuk setiap transaksi |
| paymentType | String(20) | Yes | Nama tipe pembayaran, cek tabel Tipe Pembayaran |
| amount | Decimal(12,2) | Yes | Nominal dalam Rupiah Indonesia, dengan dua angka belakang koma |
| refundAmount | Decimal(12,2) | Yes | Refund Nominal dalam Rupiah Indonesia, dengan dua angka belakang komaBiaya Layanan dihitung secara otomatis ketika jumlahnya adalah Request Amount dan jenisnya adalah OUR |
| platformRefundNo | String(32) | Yes | Nomor order Paylab yang ingin di-refund |
| merchantRefundNo | String(32) | Yes | Nomor order Merchant yang ingin di-refund |
| notifyUrl | String(200) | No | URL notifikasi setelah refund selesai, untuk parameter mohon cek E-Money Inquiry Status |
| reason | String(200) | No | Alasan melakukan refund |
| transFeeRate | Decimal(6,6) | No | Rate Transaksi, mendukung enam angka belakang koma |
| transFeeAmount | Decimal(12,2) | No | Biaya, mendukung dua angka belakang koma |
| totalTransFee | Decimal(12,2) | No | Total rate biaya layanan transaksi (tidak termasuk vatFee), mendukung dua angka belakang koma |
| vatFee | Decimal(12,2) | No | Pajak, mendukung dua angka belakang koma |
E-Money Refund Response Parameters
Header
| Field Name | Type | Value | Required |
|---|---|---|---|
| Content-Type | String(30) | Isi dengan nilai "application/json;charset=utf-8" | Yes |
| X-TIMESTAMP | String(29) | Waktu saat ini, dengan format 2022-09-16T16:58:47.964+07:00 | Yes |
| X-SIGNATURE | String(64) | Signature. Untuk selengkapnya cek | Yes |
| X-PARTNER-ID | String(20) | Merchant ID | Yes |
| X-REQUEST-ID | String(64) | ID unik merepresentasikan setiap request yang dikirim | Yes |
Body
| Parameter | Type | Required | Remarks |
|---|---|---|---|
| requestId | String(64) | Yes | Kode unik untuk setiap request |
| errCode | String(32) | Yes | 0 adalah sukses, untuk lainnya bisa lihat tabel |
| errCodeDes | String(128) | No | Deskripsi terkait error |
| merchantId | String(20) | Yes | ID unik yang disediakan oleh payment gateway ke merchant |
| storeId | String(30) | No | Jika Merchant memiliki cabang dan ingin membuat order dengan ID cabang |
| paymentType | String(20) | Yes | Nama tipe pembayaran, cek tabel Tipe Pembayaran |
| amount | Decimal(12,2) | Yes | Nominal dalam Rupiah Indonesia, with 2 decimal places |
| requestAmount | decimal(12,2) | No | |
| merchantRefundNo | String(32) | Yes | Nomor Refund |
| merchantTradeNo | String(32) | Yes | Kode unik yang dibuat oleh Merchant untuk setiap transaksi |
| platformTradeNo | String(32) | No | Nomor Transaksi Paylabs |
| createTime | String(16) | No | yyyyMMddHHmmss |
| successTime | String(16) | No | yyyyMMddHHmmss |
| status | String(2) | No | 02：Refund sukses, 03：Refund dalam proses, 05：Refund gagal |
Example
Request
POST /payment/v2.3/ewallet/refund
# HTTP Header
Content-Type: application/json;charset=utf-8
X-TIMESTAMP: 2022-09-16T16:58:47.964+07:00
X-SIGNATURE: xxxxxxxxx
X-PARTNER-ID: 010001
X-REQUEST-ID: xxxxxxxxxxxxxxxxxxxxxxxx
# HTTP Body
{
"merchantId":"0010001",
"merchantTradeNo":"100100011650869509422",
"requestId":"200100011650869509422",
"paymentType":"DANABALANCE",
"amount":"10000.00",
"refundAmount":"10000.00",
"merchantRefundNo":"100100011650869509423",
"platformRefundNo":"100100011650869509423",
"reason":"test",
"transFeeRate":"0",
"transFeeAmount":"0",
"totalTransFee":"0",
"vatFee":"0"
}Response
POST /payment/v2.3/ewallet/refund
# HTTP Header
Content-Type: application/json;charset=utf-8
X-TIMESTAMP: 2022-09-16T16:58:47.964+07:00
X-SIGNATURE: xxxxxxxxx
X-PARTNER-ID: 010001
X-REQUEST-ID: xxxxxxxxxxxxxxxxxxxxxxxx
# HTTP Body
{
"errCode":0,
"merchantId":"0010001",
"merchantTradeNo":"100100011650869509422",
"requestId":"200100011650869509422",
"paymentType":"DANABALANCE",
"amount":"10000.00",
"merchantRefundNo":"100100011650869509423",
"status":"05"
}