Pay-in collection

Collect payments in the Philippines (PHP): GCASH, MAYA, GCASH_WAP, MAYA_WAP; see Payment methods. paymentMethod is optional on the request.

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
X-TIMESTAMP	M	String	Format: yyyy-MM-ddTHH:mm:ss±HH:mm (e.g. PHT +08:00).
X-SIGNATURE	M	String	Request signature; Signature Generation.
X-PARTNER-ID	M	String	merchantID (alphanumeric).

Body Parameters

Field	Required	Type	Description
orderNo	M	String(32)	6–32 alphanumeric; unique per merchant.
purpose	M	String(64)	UTF-8; length 1–64.
merchant	M	Object	Merchant routing and settlement.
merchantId	M	String	Platform merchant ID.
merchantName	O	String	UTF-8 display name (cashier / records).
subMerchantId	O	String	Sub-merchant ID (multi-level).
subMerchantName	O	String	Sub-merchant name (UTF-8).
money	M	Object	Amount and currency.
currency	M	String	PHP only.
amount	M	Number	Integer minor units (e.g. 20000 = PHP 20000.00).
paymentMethod	O	String	e.g. GCASH, MAYA, GCASH_WAP, MAYA_WAP; Payment methods.
expiryPeriod	O	Number	Session TTL (seconds); default 3600; max 86400.
redirectUrl	O	String(256)	Post-pay redirect URL; HTTP(S); max 256.
callbackUrl	O	String(256)	Status webhook URL; HTTP(S); max 256.

---

Example Body – Transaction Request:

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

{
    "orderNo": "200110edbb466abb04682968b40",
    "purpose": "Payment for online purchase",
    "merchant": {
        "merchantId": "20011"
    },
    "money": {
        "currency": "PHP",
        "amount": 20000
    },
    "paymentMethod": "GCASH",
    "redirectUrl": "https://www.example.com/success"
}

Responses

HTTP Request

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

Body Parameters

Field	Required	Type	Description
code	M	String	00 = success; other codes = error.
message	M	String	Result text (UTF-8).
tradeNo	O	String	Platform trade ID.
orderNo	M	String	Echo of orderNo.
merchant	M	Object	Merchant Model.
merchantId	M	String	Merchant ID.
merchantName	O	String	Display name.
subMerchantId	O	String	Sub-merchant ID.
subMerchantName	O	String	Sub-merchant name.
money	M	Object	Money Model.
currency	M	String	PHP.
amount	M	Number	Integer minors.
transactionTime	M	String	yyyy-MM-ddTHH:mm:ss±HH:mm
channel	M	Object	Channel Model.
paymentMethod	O	String	Channel code (e.g. GCASH, MAYA).
paymentUrl	M	String	Cashier URL.
status	O	String	Status Model.

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

{
    "code": "00",
    "message": "Successful",
    "tradeNo": "1812001125042115424463245",
    "orderNo": "20011563d9094aa7d4d9e9b933bb",
    "merchant": {
        "merchantId": "20011",
        "merchantName": "bradytest123www",
        "accountNo": "11820011202403071031"
    },
    "money": {
        "currency": "PHP",
        "amount": 20000
    },
    "transactionTime": "2025-06-19T10:31:33+08:00",
    "channel": {
        "paymentMethod": "GCASH",
        "paymentUrl": "https://gateway.smilepayz.com/cashier/#/loading?tradeNo=1812003025061909313195096"
    },
    "status": "PROCESSING"
}

Notification/Callback

HTTP Request

Field	Required	Type	Description
Content-Type	M	String	application/json
X-TIMESTAMP	M	String	Format: yyyy-MM-ddTHH:mm:ss±HH:mm
X-SIGNATURE	M	String	Callback signature; verify.

Body Parameters

Field	Required	Type	Description
orderNo	M	String	Same orderNo as pay-in.
tradeNo	M	String	Platform tradeNo.
merchantId	M	String	Merchant ID.
merchantName	M	String	Display name.
subMerchantId	O	String	Sub-merchant ID.
subMerchantName	O	String	Sub-merchant name.
paymentMethod	M	String	Settled channel (e.g. GCASH, MAYA).
transactionTime	M	String	Completion time (yyyy-MM-ddTHH:mm:ss±HH:mm).
status	M	String	Status Model.
money	M	Object	Final amount; Money Model.
currency	M	String	PHP.
amount	M	Number	Integer minors.

Return

Important

Respond with the string SUCCESS only.

{
  "orderNo": "2000102900000000000001",
  "tradeNo": "181200012410241325417215",
  "merchantId": "20001",
  "merchantName": "test",
  "subMerchantId": "",
  "subMerchantName": "",
  "paymentMethod": "GCASH",
  "transactionTime": "2024-12-17T10:55:00",
  "money": {
    "currency": "PHP",
    "amount": 100000
  },
  "status": "SUCCESS"
}

SUCCESS