Settlement Notification

Settlement Notification adalah layanan yang digunakan oleh Espay Payment Gateway untuk menginformasikan bahwa tagihan telah dilunasi ke sistem Anda. 

Flow

Setiap kali pelunasan tagihan, Espay Payment Gateway akan mengirimkan permintaan ke server Anda melalui URL Settlement Notification yang telah Anda daftarkan pada Portal Sandbox Espay. Anda diminta untuk memberikan respons terhadap permintaan tersebut sesuai dengan format yang telah disediakan, dalam bentuk JSON.

Key Value
Method
HTTP Post
Connection
keep-alive
Content-Length
250
Content-Type
application/x-www-form-urlencoded
Accept
*/*

API URL

Keterangan URL Merchant Endpoint
HTTP
http://yourdomain.com
.../api/espay/settlementnotification
HTTP
https://yourdomain.com
.../api/espay/settlementnotification

Parameter Permintaan

Parameter Tipe Mandatory Keterangan
rq_uuid
String (64)
Y
Request identifier. ID unik yang digunakan untuk mengidentifikasi pesan.
rq_datetime
String (19)
Y
Tanggal dan waktu transaksi yang dikirim dari server Espay.

Format:
yyyy-MM-dd hh:mi:ss

Contoh:
2024-03-14 07:49:28
receiver_id
String (10)
Y
Kode komunitas merchant yang terdaftar di Espay.
password
String (20)
Y
Kata sandi merchant diatur Espay.
data
JSON
Y
   tx_id
String (20)
Y
ID transaksi dari Espay.
   payment_id
String (50)
Y
Id unik payment dari Espay.
   settlement_amount
String (19)
Y
Total settlement.

Format:
Desimal .00 (ISO 4217)

Example:
150000.00
   settlement_date
String (19)
Y
Tanggal Settlement.

Format:
yyyy-MM-dd

Contoh:
2024-03-14
   settlement_remark
String (50)
Y
Deskripsi settlement.
comm_code
String (10)
Y
Merchant code yang diberikan oleh tim Espay.

Contoh:
SGWYESSISHOP
settlement_fee
String (16.2)
Y
Biaya Settlement.

Format:
Desimal .00 (ISO 4217)

Contoh:
5000.00
bank_ref
String (32)
Y
Nomor referensi bank.
amount
String (16.2)
Y
Total Biaya Settlement.

Format:
Desimal .00 (ISO 4217)

Contoh:
5000.00
count_trx
String (16.2)
Y
Jumlah total transaksi.

Format:
Desimal .00 (ISO 4217)

signature
String (64)
Y
Kode yang digunakan untuk melakukan validasi transaksi. Pelajari signature
Y: Yes, O: Optional, C: Conditional

Parameter Respons

Parameter Tipe Mandatory Keterangan
error_code
String (4)
Y
Kode respons.

Format:
  • 0000: Proses validasi dari sisi merchant berhasil.
  • Kode lainnya: Proses validasi dari sisi merchant gagal.
error_message
String (32)
Y
Deskripsi respons.
settlement_remark
String (255)
O
Keterangan dari settlement tersebut
date_settle
String (19)
Y
Tanggal settlement di server aplikasi.

Format:
yyyy-MM-dd hh:mi:ss

Contoh:
2024-03-14 07:49:28
Y: Yes, O: Optional, C: Conditional

Pendaftaran URL

Pastikan format URL dan respons yang Anda buat sudah sesuai dengan panduan dokumentasi ini. Selanjutnya, segera daftarakan URL Settlement Notification Anda melalui portal Sandbox Espay. Baca cara menambahkan URL disini.






































Contoh Permintaan

Host: payment.daftarsekolah.com
Accept: */*
User-Agent: ESPay WebServices (Pembayaran Lintas Usaha Sukses, PT) Content-Length: 541
Content-Type: application/x-www-form-urlencoded
             
rq_uuid=9f75543e-4684-4d06-a8a2-870b9d0f8830
&rq_datetime=2021-09-28 09:30:09
&sender_id=GOWORLDPG
&receiver_id=SGWBARKAHPANGHURIANSC
&password=FHNGNYDB &data=[{"tx_id":"ESP1632751045TRBI","payment_id":"NNN0002021092700006","settl ement_amount":"50000.00","settlement_date":"2021-09- 28","settlement_remark":"SGWBA2709270921YNQ"}] &comm_code=SGWBARKAHPANGHURIANSC
&settlement_fee=7000.00 
&bank_ref=permata
&amount=50000
&count_trx=1 &signature=4b31a51eca1sbdb9d86677da522d8d0f3d882d3c0
































































Contoh Respons

{
    "error_code":"0000", 
    "error_message":"Success", 
    "settlement_remark":"notes here", 
    "date_settle":"2021-10-17 12:30:45"
}
CURL

curl --location 'https://digallery-me.xyz/api/espay/settlementnotification' \
--header 'Content-Length: 250' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'rq_uuid=9f75543e-4684-4d06-a8a2-870b9d0f8830' \
--data-urlencode 'rq_datetime=2024-03-14 07:49:28' \
--data-urlencode 'receiver_id=SGWDIGALLERY' \
--data-urlencode 'password=sgwdigallery!' \
--data-urlencode 'data=[{"tx_id":"ESP1632751045TRBI","payment_id":"NNN0002021092700006","settl ement_amount":"50000.00","settlement_date":"2021-09- 28","settlement_remark":"SGWBA2709270921YNQ"}]' \
--data-urlencode 'comm_code=FHNGNYDB' \
--data-urlencode 'settlement_fee=5000.00' \
--data-urlencode 'bank_ref=permata' \
--data-urlencode 'amount=50000.00' \
--data-urlencode 'count_trx=5' \
--data-urlencode 'signature=4b31a51eca1sbdb9d86677da522d8d0f3d882d3c0'
Scroll to Top