Api Payin
December 26, 2024About 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
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 |
network | M | String | the network for digital currency |
area | M | Number | Supported Value: 30/32/33/34/35 |
productDetail | O | String(128) | production description |
paymentMethod | O | String | Model Object PaymentMethod |
payer | 0 | 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 |
- If paymentMethod not pass. smilepayz will return a transaction 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": 30,
"network": "TRC20",
"merchant": {
"merchantId": "20001"
},
"money": {
"amount": 10000,
"currency": "USDT"
},
"orderNo": "20001e9d98b01-0db2-44c9-9d45-7c",// Attention! format
"paymentMethod": "USDT",
"purpose": "Purpose For Transaction from Java SDK",
"redirectUrl": "https://docs.smilepayz.com/en/"
}
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+07:00 eg: 2020-12-17T10:55:00+07:00 |
money | M | Object | Model Object Money |
channel | M | Object | channel information |
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": "USDT",
"paymentUrl": "https://gateway.smilepayz.com/cashier/#/loading?tradeNo=111200572411191251468673",
},
"merchant": {
"accountNo": "11120001202406101410",
"merchantId": "20001",
"merchantName": "test"
},
"money": {
"amount": 300,
"currency": "USDT"
},
"orderNo": "878d95fe75ef4c49b11d266afa8dd849",
"status": "PROCESSING",
"tradeNo": "111200012411191251468673",
"transactionTime": "2024-11-19T12:51:47+07: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 | M | String | Model Object Payer |
Return
Important
Notification please return only string SUCCESS
{
"merchantId": "20001",
"merchantName": "test",
"money": {
"amount": 150,
"currency": "USDT"
},
"orderNo": "20001f7d65167e8b1419896f2dfb",
"payer": {
"name": "payerName"
},
"paymentMethod": "USDT",
"status": "SUCCESS",
"tradeNo": "111200012412151710505955",
"transactionTime": "2024-12-15T17:10:51"
}
SUCCESS