espay logo

VOID

Web Service untuk melakukan Void ke Aplikasi Pembayaran

Alur Pesan

Merchant → Espay

Metode

HTTP Post

API URL

Endpoint Development: https://sandbox-api.espay.id/rest/digitalpay/void
Endpoint Production: https://api.espay.id/rest/digitalpay/void


Parameter Request:
Nama Field Attribute Mandatory Keterangan
rq_uuid 64 Ya Pengidentifikasi request. ID unik untuk mengidentifikasi pesan-pesan tersebut dengan pesan yang lain
rq_datetime 19 Ya Tanggal dan waktu di server aplikasi Espay ketika pesan dikirim
comm_code 32 Ya Kode penjual yang terdaftar di aplikasi Espay
order_id 20 Ya Nomor transaksi / ID faktur / ID unik yang mengidentifikasi pesanan / tagihan / faktur
trx_id 20 Ya Nomor transaksi ID generate dari Espay
product_code 10 Ya Kode Produk yang diinginkan.
  1. OVO
  2. JENIUS
  3. GOPAY
  4. LINKAJA
signature 64 Ya Signature diperlukan untuk validasi oleh penjual
amount 17 Ya Jumlah yang dibayarkan oleh pelanggan.
Format : 100000

Parameter Response:
Nama Field Attribute Mandatory Keterangan
error_code 4 Ya Jika error_code sama dengan 0000 = Sukses
Jika error_code tidak sama dengan 0000 = Gagal call request ke Aplikasi Pembayaran
error_message 32 Ya Jika error_code sama dengan 0000 = Sukses
Jika error_code tidak sama dengan 0000 = Gagal call request ke Aplikasi Pembayaran
order_id 20 Ya Nomor transaksi / ID faktur / ID unik yang mengidentifikasikan pesanan / tagihan / faktur
trx_id 32 Ya Transaksi ID dari Espay
trx_status 2 Ya Status transaksi

Langkah:

Setiap request harus dilengkapi signature untuk divalidasi. Client akan diberikan Secret Key di dokumentasi terpisah dari document ini. Key tersebut akan diolah untuk menjadi signature dengan langkah-langkah sebagai berikut :

  • Langkah 1

    • Gabungkan parameter-parameter yang digunakan dengan urutan sebagai berikut :
    ##rq_uuid##comm_code##product_code##order_id##amount##mode##key##
    Contoh :
    rq_uuid : 123ABC-DEF456
    comm_code : MYCOMMCODE
    product_code : OVO
    order_id : ORDER001
    amount : 10000
    key : S3cr317kEY
    mode : PUSHTOPAY
    Sehingga akan menjadi rangkaian string sebagai berikut :
    Result = ##123ABC-DEF456##MYCOMMCODE##OVO##ORDER001##10000##VOID##S3cr317kEY##

  • Langkah 2

    • Hasil huruf besar dari Langkah 1:
    ##123ABC-DEF456##MYCOMMCODE##OVO##ORDER001##10000##VOID##S3CR317KEY##

  • Langkah 3

    • Hasil hash dari Langkah 2 menggunakan metode sha256:
    hash = hash(“sha256”, ##123ABC-DEF456##MYCOMMCODE##OVO##ORDER001##10000##VOID##S3CR317KEY##)
    Hasil: aa19e37e1bf6d5cfb23d59988d397f9ba6e79cf6853606e45a6809e0ca9a7b5d
    Gunakan hasil dari Langkah 3 sebagai value signature.

    

        
Contoh Request:

        
POST /rest/digitalpay/void HTTP/1.1
Content-Length: 282
Content-Type: application/x-www-form-urlencoded
Accept: */*
Host: sandbox-api.espay.id
Authorization: Basic U0dXUEFJREJBUTAyOkhOUlFLSENI

rq_uuid=88996d80-e466-48f8-8b4b-be2334e0f0dc
&rq_datetime=2019-08-28 11:44:58
&comm_code=SGWYESSISHOP
&product_code=OVO
&order_id=SGWYESSIOVO000040
&trx_id=ESP1566967156ALDY
&amount=10000
&signature=e3aa2465caa0b6300fca424aa5309a817697b7b5a3c3b76b4fbef1fc3c061b8f
        
    
    
    
    
Contoh Response:

        
    {
        "rq_uuid": "88996d80-e466-48f8-8b4b-be2334e0f0dc",
        "rs_datetime": "2019-08-28 11:44:58",
        "error_code": "0000",
        "error_message": "",
        "order_id": "SGWYESSIOVO000040",
        "trx_id": "ESP1566967156ALDY",
        "trx_status": "V"
    }