Pay-in collection

Egypt region pay-in API (EGP). See Payment methods.

Request

POST/v2.0/transaction/pay-in

Request Path:

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

Header Parameters

Field	Required	Type	Description
Content-Type	M	String	application/json request body.
X-TIMESTAMP	M	String	Format: yyyy-MM-ddTHH:mm:ss±HH:mm (e.g. Egypt EET +02:00).
X-SIGNATURE	M	String	Signature of JSON body (see product Signature doc).
X-PARTNER-ID	M	String	Your merchantID (alphanumeric).

Body Parameters

Field	Required	Type	Description
orderNo	M	String(32)	Merchant-unique id, 6–32 alphanumeric.
purpose	M	String(64)	Memo to payer, 1–64 UTF-8 chars.
merchant	M	Object	Wraps merchantId and optional sub-merchant fields.
merchantId	M	String	Smilepayz merchantId for this call.
merchantName	O	String	Optional UTF-8 merchant display name.
subMerchantId	O	String	Optional sub-merchant id.
subMerchantName	O	String	Optional UTF-8 name for subMerchantId.
money	M	Object	currency plus amount for this transaction.
currency	M	String	ISO currency code for this call.
amount	M	Number	Transaction amount in EGP, numeric value greater than 0.
payer	O	Object	Payer object. If omitted, Smilepayz fills channel-required payer information.
name	O	String	Payer full name (UTF-8).
idType	O	String	ID type code for payer.
idNumber	O	String	ID number matching idType.
phone	O	String	Payer phone in local format.
email	O	String	Payer email.
paymentMethod	M	String	Code (see Payment methods doc).
expiryPeriod	O	Number	Session TTL seconds, default 3600, max 86400 unless noted.
redirectUrl	O	String(256)	HTTPS post-pay return URL, max 256 chars.
callbackUrl	O	String(256)	HTTPS async status URL, max 256 chars.

---

Example Body – Transaction Request:

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": "Retail checkout — Cairo",
    "merchant": {
        "merchantId": "20011"
    },
    "money": {
        "currency": "EGP",
        "amount": 20000
    },
    "payer": {
        "name": "Ahmed Hassan El-Masry",
        "idType": "NID",
        "idNumber": "48982488",
        "phone": "201234567890",
        "email": "[email protected]"
    },
    "paymentMethod": "FAWRY",
    "redirectUrl": "https://www.example.com/success"
}

Responses

HTTP Request

Field	Required	Type	Description
Content-Type	M	String	application/json request body.
X-TIMESTAMP	M	String	Format: yyyy-MM-ddTHH:mm:ss±HH:mm

Body Parameters

Field	Required	Type	Description
code	M	String	00 success, other values error.
message	M	String	UTF-8 human-readable result line.
orderNo	M	String	Merchant-unique id, 6–32 alphanumeric.
tradeNo	O	String	Smilepayz tradeNo for this order.
merchant	M	Object	Wraps merchantId and optional sub-merchant fields.
merchantId	M	String	Smilepayz merchantId for this call.
merchantName	O	String	Optional UTF-8 merchant display name.
subMerchantId	O	String	Optional sub-merchant id.
subMerchantName	O	String	Optional UTF-8 name for subMerchantId.
accountNo	O	String	Settlement accountNo if gateway returns it.
money	M	Object	currency plus amount for this transaction.
currency	M	String	ISO currency code for this call.
amount	M	Number	Transaction amount in EGP, numeric value greater than 0.
transactionTime	M	String	yyyy-MM-ddTHH:mm:ss±HH:mm (e.g. EET +02:00).
channel	M	Object	Channel payload (paymentUrl, qrString, …).
paymentMethod	M	String	Code (see Payment methods doc).
vaNumber	O	String	Fawry reference number when returned by the channel.
paymentUrl	O	String	Smilepayz cashier URL or channel checkout URL to open for the payer.
status	O	String	Order or payment status enum value.

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"
}

Notification/Callback

HTTP Request

Field	Required	Type	Description
Content-Type	M	String	application/json request body.
X-TIMESTAMP	M	String	Format: yyyy-MM-ddTHH:mm:ss±HH:mm
X-SIGNATURE	M	String	Callback body signature (see Callback signature guide).

Body Parameters

Field	Required	Type	Description
orderNo	M	String	Merchant-unique id, 6–32 alphanumeric.
tradeNo	M	String	Smilepayz tradeNo for this order.
merchantId	M	String	Smilepayz merchantId for this call.
merchantName	M	String	Optional UTF-8 merchant display name.
subMerchantId	O	String	Optional sub-merchant id.
subMerchantName	O	String	Optional UTF-8 name for subMerchantId.
paymentMethod	M	String	Code (see Payment methods doc).
transactionTime	M	String	Completion time.
status	M	String	Order or payment status enum value.
money	M	Object	currency plus amount for this transaction.
currency	M	String	ISO currency code for this call.
amount	M	Number	Transaction amount in EGP, numeric value greater than 0.
payer	O	Object	Payer object per region rules (see Payer model).

Return

Important

Respond with the string SUCCESS only.

{
    "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