Api Payin
About 3 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
bank transfers
qris
e-wallets
credit card payments
other digital
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: 10 |
payer | C | Object | Model Object Payer |
paymentMethod | O | String | Model Object PaymentMethod |
productDetail | O | String(128) | production description |
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 checkout page
- If paymentMethod is OVO. you can pass the payer phone.
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
{
"orderNo": "2000102900000000000001", // Attention! format
"purpose": "transaction for business bla bla",
"paymentMethod": "QRIS",
"money": {
"currency": "IDR",
"amount": 10000
},
"merchant": {
"merchantId": "20001"
},
"area": 10
}
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 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": "QRIS",
"paymentUrl": "https://gateway.smilepayz.com/cashier/#/loading?tradeNo=101200112410241325417215",
"qrString": "00020101021226570011ID.DANA.WWW011893600915069533479502096953347950303UME51440014ID.CO.QRIS.WWW0215ID20243302250440303UME5204739953033605405100005802ID5919DP Mega Jaya Makmur6015Kota Jakarta Se61051221062750118pay_JXlS1MtBUk931660490011ID.DANA.WWW0425MER202110293394047135422905011630451D5"
},
"code": "00",
"merchant": {
"accountNo": "1102000000000000",
"merchantId": "20001",
"merchantName": "test"
},
"message": "Successful",
"money": {
"amount": 10000,
"currency": "IDR"
},
"orderNo": "2000102900000000000001",
"status": "PROCESSING",
"tradeNo": "101200012410241325417215",
"transactionTime": "2020-12-17T10:55:00+07:00"
}
{
"channel": {
"additionalInfo": {},
"paymentMethod": "QRIS",
"paymentUrl": "https://gateway.smilepayz.com/cashier/#/loading?tradeNo=101200112410241325417215",
"qrString": "https://gatatway.smilepayz.com/imge/MER202110293394047135422905011630451D5.img"
},
"code": "00",
"merchant": {
"accountNo": "1102000000000000",
"merchantId": "20001",
"merchantName": "test"
},
"message": "Successful",
"money": {
"amount": 10000,
"currency": "IDR"
},
"orderNo": "2000102900000000000001",
"status": "PROCESSING",
"tradeNo": "101200012410241325417215",
"transactionTime": "2020-12-17T10:55:00+07:00"
}
{
"channel": {
"additionalInfo": {
"paymentUrl": "https://link.dana.id/pay?bizNo=20250102111212800110166129632333240×tamp=1735797716250&originSourcePlatform=IPG&mid=216620000383553341323&did=216650001014253563327&sid=216660001014426055320&sign=rzccMXnlSPX6WAyJRC1kAjSPOphhnctVDAIN5zSSn9ByT9cEuiYNZFhDhbHSfPjFq9NqeMURMk5xc%2F8W8zC4BDk1L5dm6QkXs3kDg5HFBtgOtgHmXesxhcRYPUXNwiLff6zuDpjVSi1jNXGoMR82S4l6KKpJIKKvsLXgHET%2B66Dxy%2FGQlH5tAKX5KXVqfMC%2FELRGOLq3WWToId%2B2ayYgnjBpOxCUF%2Fm%2FL9Nn8L%2BdUEPWpLTD%2FwBMN1tRrrsiIvOyHjl7AK3MB3zE7WrDfdHhq9s1z7cgoHpJkjnMXjGoMpMm0AD9IU2qoxkqQhGJQfCYcn4tA8930VR%2BggxOHPDhZg%3D%3D&forceToH5=false"
},
"paymentMethod": "W_DANA",
"paymentUrl": "https://gateway.smilepayz.com/cashier/#/loading?tradeNo=101200192501021315010115"
},
"code": "00",
"merchant": {
"accountNo": "1102000000000000",
"merchantId": "20001",
"merchantName": "test"
},
"message": "Successful",
"money": {
"amount": 10000,
"currency": "IDR"
},
"orderNo": "2000102900000000000001",
"status": "PROCESSING",
"tradeNo": "101200012410241325417215",
"transactionTime": "2020-12-17T10:55:00+07:00"
}
{
"channel": {
"additionalInfo": {},
"paymentMethod": "CIMB",
"paymentUrl": "https://gateway.smilepayz.com/cashier/#/loading?tradeNo=101200112501021320331776",
"vaNumber": "1419001332911089"
},
"code": "00",
"merchant": {
"accountNo": "11020011202402290943",
"merchantId": "20011",
"merchantName": "bradytest123www"
},
"message": "Successful",
"money": {
"amount": 20000,
"currency": "IDR"
},
"orderNo": "200110437c4152cbe45cebcacd25",
"status": "PROCESSING",
"tradeNo": "101200112501021320331776",
"transactionTime": "2025-01-02T13:20:34+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:BCA |
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": 100000,
"currency": "IDR"
},
"orderNo": "2000102900000000000001",
"status": "SUCCESS",
"tradeNo": "101200012410241325417215",
"transactionTime": "2020-12-17T10:55:00+07:00"
}
SUCCESS