Skip to main content

Api Payin

smilepayz teamsAbout 2 min

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

QRPAY
bank transfer

Request Path:

{Base URL}/v2.0/transaction/pay-in

Header Parameters

FieldAttributeTypeDescription
Content-TypeMStringapplication/json
X-TIMESTAMPMStringyyyy-MM-ddTHH:mm:ss[zoneOffset] eg: 2020-12-17T10:55:00+07:00
X-SIGNATUREMStringFocus:How to signature
X-PARTNER-IDMStringmerchant ID

Body Parameters

FieldAttributeTypeDescription
orderNoMString(32)unique no. Focus OrderNumber Rule
purposeMString(64)purpose
merchantMObjectModel Object Merchant
moneyMObjectModel Object Money
payerMObjectModel Object Payer
areaMNumberFixed Value: 11
paymentMethodOStringModel Object PaymentMethod
productDetailOString(128)production description
expiryPeriodONumberexpiryPeriod (second); default:3600
redirectUrlOString(256)Redirect to customer url
callbackUrlOString(256)notify address
  1. If paymentMethod not pass. smilepayz will return a transaction page
  2. If paymentMethod is not null. you can pass the payer name, payer account number and the payer bank name
  3. Bank name redirect to Payment Method List.

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

Response

HTTP Request

FieldAttributeTypeDescription
Content-TypeMStringapplication/json
X-TIMESTAMPMStringyyyy-MM-ddTHH:mm:ss[zoneOffset] eg: 2020-12-17T10:55:00+07:00

Body Parameters

FieldAttributeTypeDescription
codeMStringsuccess = "00"
messageMStringresponse message
orderNoMStringtransaction unique no
merchantMObjectModel Object Merchant
transactionTimeMStringyyyy-MM-ddTHH:mm:ss+07:00 eg: 2020-12-17T10:55:00+07:00
moneyMObjectModel Object Money
channelMObjectchannel information Channel
tradeNoOStringsmilepayz orderNo
statusOStringModel Object Status
Content-type: application/json
X-TIMESTAMP: 2020-12-17T10:55:00+07:00

Notification

HTTP Request

FieldAttributeTypeDescription
Content-TypeMStringapplication/json
X-TIMESTAMPMStringyyyy-MM-ddTHH:mm:ss[zoneOffset] eg: 2020-12-17T10:55:00+07:00
X-SIGNATUREMStringhow to check this value

Body Parameters

FieldAttributeTypeDescription
orderNoMStringmerchant transaction unique no
tradeNoMStringsmilepayz trade no.
merchantIdMStringmerchant id
merchantNameMStringmerchant name
subMerchantIdOStringsub merchant id
subMerchantNameOStringsub merchant name
paymentMethodMStringpayment method. eg:SPEI
transactionTimeMStringyyyy-MM-ddTHH:mm:ss
statusMStringModel Object Status
moneyMObjectModel Object Money
payerMStringModel Object Payer

Return

Important

Notification please return only string SUCCESS

{
  "merchantId": "20001",
  "merchantName": "test",
  "money": {
    "amount": 150,
    "currency": "THB"
  },
  "orderNo": "20001f7d65167e8b1419896f2dfb",
  "payer": {
    "name": "payerName"
  },
  "paymentMethod": "QRPAY",
  "status": "SUCCESS",
  "tradeNo": "111200012412151710505955",
  "transactionTime": "2024-12-15T17:10:51"
}
Last update: