Api Payin

Request

The term refers to an application programming interface (API) that facilitates "pay-in" transactions.
This can include a variety of payment methods sources such as

SPEI

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	Attribute	Type	Description
Content-Type	M	String	application/json
X-TIMESTAMP	M	String	yyyy-MM-ddTHH:mm:ss[zoneOffset] eg: 2020-12-17T10:55:00+07:00
X-SIGNATURE	M	String	Focus：How to signature
X-PARTNER-ID	M	String	merchant ID

Body Parameters

Field	Attribute	Type	Description
orderNo	M	String(32)	unique no. Focus OrderNumber Rule
purpose	M	String(64)	purpose
merchant	M	Object	Model Object Merchant
money	M	Object	Model Object Money
area	M	Number	Fixed Value: 14
paymentMethod	O	String	Model Object PaymentMethod
productDetail	O	String(128)	production description
payer	O	Object	Model Object Payer
expiryPeriod	O	Number	expiryPeriod (second); default:3600
redirectUrl	O	String(256)	Redirect to customer url
callbackUrl	O	String(256)	notify address

1. If paymentMethod not pass. smilepayz will return a checkout page

---

Example Body – Transaction Request:

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

{
    "area": 14,
    "merchant": {
        "merchantId": "20001"
    },
    "money": {
        "amount": 200,
        "currency": "MXN"
    },
    "orderNo": "200012c4c2ad5334dfwj3",// Attention! format
    "paymentMethod": "SPEI",
    "purpose": "Purpose For Transaction from Java SDK"
}

Response

HTTP Request

Field	Attribute	Type	Description
Content-Type	M	String	application/json
X-TIMESTAMP	M	String	yyyy-MM-ddTHH:mm:ss[zoneOffset] eg: 2020-12-17T10:55:00+07:00

Body Parameters

Field	Attribute	Type	Description
code	M	String	success = "00"
message	M	String	response message
orderNo	M	String	transaction unique no
merchant	M	Object	Model Object Merchant
transactionTime	M	String	yyyy-MM-ddTHH:mm:ss-06:00 eg: 2020-12-17T10:55:00-06:00
money	M	Object	Model Object Money
channel	M	Object	channel information Channel
tradeNo	O	String	smilepayz orderNo
status	O	String	Model Object Status

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

{
    "channel": {
        "additionalInfo": {},
        "paymentMethod": "SPEI",
        "paymentUrl": "https://gateway.smilepayz.com/cashier/#/loading?tradeNo=141200112412131711531135",
        "receiverBankName": "OPM",
        "vaNumber": "684180167000008210"
    },
    "code": "00",
    "merchant": {
        "accountNo": "11420011202402290943",
        "merchantId": "20001",
        "merchantName": "bradytest123www"
    },
    "message": "Successful",
    "money": {
        "amount": 20,
        "currency": "MXN"
    },
    "orderNo": "20001394eeb7b44c2460b892f767",
    "status": "PROCESSING",
    "tradeNo": "141200012412131711531135",
    "transactionTime": "2024-12-13T04:11:54-06:00"
}

Notification

HTTP Request

Field	Attribute	Type	Description
Content-Type	M	String	application/json
X-TIMESTAMP	M	String	yyyy-MM-ddTHH:mm:ss[zoneOffset] eg: 2020-12-17T10:55:00+07:00
X-SIGNATURE	M	String	how to check this value

Body Parameters

Field	Attribute	Type	Description
orderNo	M	String	merchant transaction unique no
tradeNo	M	String	smilepayz trade no.
merchantId	M	String	merchant id
merchantName	M	String	merchant name
subMerchantId	O	String	sub merchant id
subMerchantName	O	String	sub merchant name
paymentMethod	M	String	payment method. eg:SPEI
transactionTime	M	String	yyyy-MM-ddTHH:mm:ss
status	M	String	Model Object Status
money	M	Object	Model Object Money
payer	O	String	Model Object Payer

Return

Important

Notification please return only string SUCCESS

{
  "merchantId": "20001",
  "merchantName": "test",
  "money": {
    "amount": 2000,
    "currency": "MXN"
  },
  "orderNo": "20001qXTL6qYuXTkxPDPdTXJc",
  "payer": {
    "name": "test"
  },
  "paymentMethod": "SPEI",
  "status": "SUCCESS",
  "tradeNo": "141200012412110650535520",
  "transactionTime": "2024-12-10T17:50:54"
}

SUCCESS