Refund QR

Refund QR merupakan layanan opsional yang disediakan untuk Anda yang akan melakukan pengembalian dana (refund) untuk transaksi yang sudah berhasil. Layanan ini dapat Anda gunakan untuk pengembalian dana (refund) dengan metode pembayaran QR.

Tipe Value
Kode Layanan
78
Nama
API Refund Payment
HTTP Method
POST

Flow

Anda melakukan permintaan dengan mengirimkan parameter yang dibutuhkan, dan Espay Payment Gateway akan memberikan respons dalam bentuk JSON.

API URL

Environment URL
Sandbox
Port of HTTPS (443)
https://sandbox-api.espay.id/apimerchant/v1.0/debit/refund
Production
Port of HTTPS (443)
https://api.espay.id/apimerchant/v1.0/debit/refund
Nama Tipe Mandatory Keterangan
Content-Type
String
Y
Isi konten permintaan Anda.

Contoh:
application/json
X-TIMESTAMP
String (25)
Y
Tanggal dan waktu lokal customer saat ini.

Format:
yyyy-MM-ddThh:mi:ssTZD (ISO 8601)

Contoh:
2024-03-14T07:49:28+07:00
X-SIGNATURE
String (255)
Y
Kode yang digunakan untuk melakukan validasi transaksi. Pelajari Signature Asymmetric
X-EXTERNAL-ID
String (32)
Y
String Numerik. Kode referensi yang bersifat unik pada hari yang sama.
X-PARTNER-ID
String (50)
Y
Merchant code yang diberikan oleh tim Espay.
CHANNEL-ID
String (5)
Y
Kode channel.

Value:
ESPAY
Authorization-Customer
String (150)
C
Kode token B2B2C. Khusus Espay -> Bank.
Y: Yes, O: Optional, C: Conditional

Parameter Permintaan

Parameter Tipe Mandatory Keterangan
originalPartnerReferenceNo
String (64)
Y
Kode referensi merchant yang unik.
originalReferenceNo
String (64)
Y
Nomor referensi dari Espay.
partnerRefundNo
String (64)
Y
Id refund.
refundAmount
Object
  value
String (16.2)
Y
Jumlah refund.

Format:
Decimal .00 (ISO 4217)

Contoh:
150000.00
  currency
String (3)
Y
Kode mata uang transaksi.

Format:
  • Rupiah: IDR
reason
String (64)
Y
Alasan refund.
additionalInfo
Object
  productCode
String (16)
Y
Kode produk. Klik disini
Y: Yes, O: Optional, C: Conditional

Parameter Respons

Parameter Tipe Mandatory Keterangan
responseCode
String (7)
Y
Kode respon.

Format:
Kode HTTP+ Kode Layanan + Kode Error.

Contoh:
200+78+00 = 2007800
responseMessage
String (150)
Y
Deskripsi respon.
referenceNo
String (64)
Y
Kode referensi dari Espay.
partnerRefundNo
String (64)
Y
Id refund.
refundTime
String (25)
Y
Tanggal dan waktu refund.

Format:
yyyy-MM-ddThh:mi:ssTZD (ISO 8601)

Contoh:
2024-03-14T07:49:28+07:00
refundAmount
Object
  value
Srting (16.2)
Y
Jumlah refund.

Format:
Decimal .00 (ISO 4217)

Contoh:
150000.00
  currency
String (3)
Y
Kode mata uang transaksi.

Format:
  • Rupiah: IDR
addtionalInfo
Object
O
Y: Yes, O: Optional, C: Conditional

Try It!

Anda bisa coba masukkan data sesuai dengan input yang telah disediakan. Setelah itu Anda submit dan lihat hasilnya!

































Contoh Header

content-type: application/jsonn
X-TIMESTAMP:2024-03-14T07:49:28+07:00
X-SIGNATURE:jaCUbDOSIjFcDaZ1rO0aCczJrWSfV0wAXVi/zOLlOLOIVH00gucOSOnHpKTARwpnn6qB08Vi8VJviNhIQh1q6zVJAwdhxnHRlwNFa28IVFTtSmD4nXPWT3LsuYuFPNDGJ59/MgKMVjwIofYvq2dwOHoDi9rnyT3nPl7N2bRdIQceQlD6sITcqdEbRUlm+zTFB2MxNy4vFaEZz1LU8fsENp+giMNqxR26DsNcRj1K8JBXO6nY8q2m3jmTmiduXK5VZXxt/5v6bp+OlYCwJhn3hmdZD1zwC3Hu6qZcCIhO6IVe0ThSCfsaCdye9o/Ew6VdMWbTtQUoR983mq6MubLmzg==
X-EXTERNAL-ID:d3be5aec-155b-4b46-bfee-3fd55363d0f4
X-PARTNER-ID:SGWYESSISHOP
CHANNEL-ID:ESPAY



























Contoh Permintaan

{
    "originalPartnerReferenceNo": "20221011000086",
    "originalReferenceNo": "ESP1667981349ZVAM",
    "partnerRefundNo": "RFIDESP1667981349ZVAM",
    "refundAmount": {
        "value": "10001.00",
        "currency": "IDR"
    },
    "reason": "Customer complain",
    "additionalInfo": {
        "productCode": "SHOPEEQRPAY"
    }
}





















Contoh Respons Positif

{
    "responseCode": "2007800",
    "responseMessage": "Successful",
    "referenceNo": "ESP1667981349ZVAM",
    "partnerRefundNo": "RFIDESP1667981349ZVAM",
    "refundTime": "2022-11-09T15:10:21+07:00",
    "refundAmount": {
        "value": "10001.00",
        "currency": "IDR"
    },
    "additionalInfo": {} 
}


Contoh Respons Negatif

    
{
  "responseCode": "4017800",
  "responseMessage": "Unauthorized. Invalid Signature from Client"
}





CURL


curl --location --request DELETE 'https://sandbox-api.espay.id/apimerchant/v1.0/transfer-va/delete-va' \
--header 'X-TIMESTAMP: 2024-03-14T07:49:28+07:00' \
--header 'X-SIGNATURE: jaCUbDOSIjFcDaZ1rO0aCczJrWSfV0wAXVi/zOLlOLOIVH00gucOSOnHpKTARwpnn6qB08Vi8VJviNhIQh1q6zVJAwdhxnHRlwNFa28IVFTtSmD4nXPWT3LsuYuFPNDGJ59/MgKMVjwIofYvq2dwOHoDi9rnyT3nPl7N2bRdIQceQlD6sITcqdEbRUlm+zTFB2MxNy4vFaEZz1LU8fsENp+giMNqxR26DsNcRj1K8JBXO6nY8q2m3jmTmiduXK5VZXxt/5v6bp+OlYCwJhn3hmdZD1zwC3Hu6qZcCIhO6IVe0ThSCfsaCdye9o/Ew6VdMWbTtQUoR983mq6MubLmzg==' \
--header 'X-EXTERNAL-ID: a9555192-2fcc-4003-93dd-714715cdd0dd' \
--header 'X-PARTNER-ID: SGWYESSISHOP' \
--header 'CHANNEL-ID: ESPAY' \
--header 'Content-Type: application/json' \
--data '{
    "partnerServiceId": " ESPAY", 
    "customerNo": "SGWYESSISHOP", 
    "virtualAccountNo": "DIGORDER000001"
}'





Scroll to Top