Pembayaran masuk (Pay-In · Mesir)

API pay-in wilayah Mesir (EGP). Lihat Metode pembayaran.

Permintaan

POST/v2.0/transaction/pay-in

URL permintaan:

sandbox: https://sandbox-gateway.smilepayz.com/v2.0/transaction/pay-in
production: https://gateway.smilepayz.com/v2.0/transaction/pay-in

Parameter header

Field	Wajib	Tipe	Deskripsi
Content-Type	M	String	Body JSON application/json.
X-TIMESTAMP	M	String	Format: yyyy-MM-ddTHH:mm:ss±HH:mm (contoh EET Mesir +02:00).
X-SIGNATURE	M	String	Tanda tangan body JSON (lihat dokumen produk Tanda tangan).
X-PARTNER-ID	M	String	merchantID Anda (alfanumerik).

Parameter body

Field	Wajib	Tipe	Deskripsi
orderNo	M	String(32)	Nomor order unik dari merchant, 6–32 karakter alfanumerik.
purpose	M	String(64)	Ringkasan transaksi, 1–64 karakter UTF-8.
merchant	M	Object	Berisi merchantId dan field sub-merchant opsional.
merchantId	M	String	merchantId Smilepayz untuk permintaan ini.
merchantName	O	String	Nama tampilan merchant UTF-8, opsional.
subMerchantId	O	String	ID sub-merchant, opsional.
subMerchantName	O	String	Nama UTF-8 untuk subMerchantId, opsional.
money	M	Object	Objek nominal berisi currency dan amount transaksi.
currency	M	String	Kode mata uang untuk permintaan ini.
amount	M	Number	Nominal transaksi dalam EGP, harus lebih besar dari 0.
payer	O	Object	Data payer. Jika tidak dikirim, Smilepayz mengisi informasi payer yang dibutuhkan channel.
name	O	String	Nama lengkap payer (UTF-8).
idType	O	String	Kode tipe ID payer.
idNumber	O	String	Nomor ID payer sesuai idType.
phone	O	String	Nomor telepon payer.
email	O	String	Email payer.
paymentMethod	M	String	Kode metode pembayaran (lihat dokumen Metode pembayaran).
expiryPeriod	O	Number	Masa berlaku sesi dalam detik; default 3600, maksimum 86400 kecuali disebutkan lain.
redirectUrl	O	String(256)	URL HTTPS untuk kembali setelah pembayaran, maksimal 256 karakter.
callbackUrl	O	String(256)	URL HTTPS untuk notifikasi status async, maksimal 256 karakter.

---

Contoh body – permintaan pay-in:

Content-type: application/json
X-TIMESTAMP: 2020-12-17T10:55:00+02:00
X-SIGNATURE: 7MHd9v5/m9JeqmDZVwWBZUZ5J5...7120QnFEny7Qm7uQR1G0TWCh10fsU6nVxiRoeoQ==
X-PARTNER-ID: 20001

{
    "orderNo": "20011egyptegpcash563d9094aa7d4d",
    "purpose": "Checkout ritel Cairo",
    "merchant": {
        "merchantId": "20011"
    },
    "money": {
        "currency": "EGP",
        "amount": 20000
    },
    "payer": {
        "name": "Ahmed Hassan El-Masry",
        "idType": "NID",
        "idNumber": "29001012003652",
        "phone": "201234567890",
        "email": "[email protected]"
    },
    "paymentMethod": "FAWRY",
    "redirectUrl": "https://www.example.com/success"
}

Respons

Header HTTP

Field	Wajib	Tipe	Deskripsi
Content-Type	M	String	Body JSON application/json.
X-TIMESTAMP	M	String	Format: yyyy-MM-ddTHH:mm:ss±HH:mm

Parameter body

Field	Wajib	Tipe	Deskripsi
code	M	String	00 berarti berhasil; nilai lain berarti gagal.
message	M	String	Pesan hasil UTF-8 yang dapat dibaca.
orderNo	M	String	Nomor order unik dari merchant, 6–32 karakter alfanumerik.
tradeNo	O	String	tradeNo Smilepayz untuk order ini.
merchant	M	Object	Berisi merchantId dan field sub-merchant opsional.
merchantId	M	String	merchantId Smilepayz untuk permintaan ini.
merchantName	O	String	Nama tampilan merchant UTF-8, opsional.
subMerchantId	O	String	ID sub-merchant, opsional.
subMerchantName	O	String	Nama UTF-8 untuk subMerchantId, opsional.
accountNo	O	String	accountNo settlement jika dikembalikan gateway.
money	M	Object	Objek nominal berisi currency dan amount transaksi.
currency	M	String	Kode mata uang untuk permintaan ini.
amount	M	Number	Nominal transaksi dalam EGP, harus lebih besar dari 0.
transactionTime	M	String	yyyy-MM-ddTHH:mm:ss±HH:mm (contoh EET +02:00).
channel	M	Object	Data channel, seperti paymentUrl, qrString, dan lainnya.
paymentMethod	M	String	Kode metode pembayaran (lihat dokumen Metode pembayaran).
vaNumber	O	String	Nomor referensi Fawry ketika dikembalikan channel.
paymentUrl	O	String	URL cashier Smilepayz atau checkout channel untuk pembayar.
status	O	String	Nilai enum status order atau pembayaran.

Content-type: application/json
X-TIMESTAMP: 2020-12-17T10:55:00+02:00

{
    "code": "00",
    "message": "Successful",
    "orderNo": "20011egyptegpcash563d9094aa7d4d",
    "tradeNo": "1512001125042115424463245",
    "merchant": {
        "merchantId": "20011",
        "merchantName": "Smilepayz Demo Store",
        "accountNo": "11520011202402290943"
    },
    "money": {
        "currency": "EGP",
        "amount": 20000
    },
    "transactionTime": "2025-04-21T03:42:47+02:00",
    "channel": {
        "paymentMethod": "FAWRY",
        "vaNumber": "912345678901",
        "paymentUrl": "https://gateway.smilepayz.com/cashier/#/loading?tradeNo=1512001125042115424463245"
    },
    "status": "PROCESSING"
}

Notifikasi/Callback

Header HTTP

Field	Wajib	Tipe	Deskripsi
Content-Type	M	String	Body JSON application/json.
X-TIMESTAMP	M	String	Format: yyyy-MM-ddTHH:mm:ss±HH:mm
X-SIGNATURE	M	String	Tanda tangan body callback (lihat panduan tanda tangan callback).

Parameter body

Field	Wajib	Tipe	Deskripsi
orderNo	M	String	Nomor order unik dari merchant, 6–32 karakter alfanumerik.
tradeNo	M	String	tradeNo Smilepayz untuk order ini.
merchantId	M	String	merchantId Smilepayz untuk permintaan ini.
merchantName	M	String	Nama tampilan merchant UTF-8, opsional.
subMerchantId	O	String	ID sub-merchant, opsional.
subMerchantName	O	String	Nama UTF-8 untuk subMerchantId, opsional.
paymentMethod	M	String	Kode metode pembayaran (lihat dokumen Metode pembayaran).
transactionTime	M	String	Waktu penyelesaian.
status	M	String	Nilai enum status order atau pembayaran.
money	M	Object	Objek nominal berisi currency dan amount transaksi.
currency	M	String	Kode mata uang untuk permintaan ini.
amount	M	Number	Nominal transaksi dalam EGP, harus lebih besar dari 0.
payer	O	Object	Objek payer sesuai aturan wilayah (lihat model Payer).

Respons callback

Penting

Balas hanya dengan string SUCCESS.

{
    "orderNo": "20011egyptegpcash563d9094aa7d4d",
    "tradeNo": "1512001125042115424463245",
    "merchantId": "20011",
    "merchantName": "Smilepayz Demo Store",
    "subMerchantId": "",
    "subMerchantName": "",
    "paymentMethod": "FAWRY",
    "transactionTime": "2025-04-21T03:42:47+02:00",
    "status": "SUCCESS",
    "money": {
        "currency": "EGP",
        "amount": 20000
    },
    "payer": {
        "name": "Ahmed Hassan El-Masry",
        "phone": "201234567890",
        "email": "[email protected]"
    }
}

SUCCESS