PayIn API
About 3 min
1.Introduce
This service is tailored for PayIn transactions, allowing merchants to effortlessly initiate payment orders and presenting an array of viable payment options.This page outlines the steps for order creation, order status inquiry, and payment status notification. For comprehensive details, please consult the description below.
PayIn API involve the following 4 interfaces:
No | API name | Description |
---|---|---|
1 | Access Token API | Merchants must obtain and store a reusable token, which can be used for the duration of 900 Seconds. |
2 | PayIn API | Users create payment orders through this service |
3 | Finish Notify | The payment service notify the merchant of the final status of the order |
4 | Inquiry Status | Merchants can use this service to actively inquire about the current status of their orders. |
2.Sequence Diagram
We offer two scenarios that can be controlled by the value of PaymentMethod.
Refer to:How To Design Cashier
- when
PaymentMethod
is empty, only theCashier
provided by Smilepay can be used; - when
PaymentMethod
is not empty, you can design your ownCashier
.
2.1.Fill In PaymentMethod

No | Flow Name | Description |
---|---|---|
1 | Select bank List,Create Order | Once the customer has chosen the products and the list of banks, they initiate a transaction request, prompting the merchant to generate the order information. |
2 | Fill In PaymentMethod,Create payment Order | The merchant invokes the PayIn API with the paymentMethod to create a payment order. You need to complete KYC verification before you can use it. |
3 | Generate VA, QRIS and E-Wallet | Smilepay will submit your application to the bank to generate the required QRIS,VA or E-Wallet information. |
4 | Return To Payment Process | The bank will return the results of our request and notify us that the order is in the payment process. |
5 | Return To Payment Process | Smilepay will return the QRIS,VA or E-Wallet information you need, along with the SmilePay cash register address. |
6 | Show The QRIS or VA number | For QRIS and VA information, you can display it directly or through Smilepay checkout counter. |
7 | Redirect The User E-Wallet App | For electronic wallets, it will redirect to return a URL that redirects to the app. |
8 | Make A Payment | The user goes to the bank to initiate a payment action. |
9 | Notify Smilepay Payment Final Status | After the customer has paid successfully, the bank will inform us that the order has been payment success. |
10 | Notify Smilepay Payment Final Status | Smilepay will notify the merchant of the final status of the transaction. |
11 | Response Notification Result | For electronic wallets, it will redirect to return a URL that redirects to the app. |
12 | Show Payment Result | Show the merchant the results of a successful payment page. |
13 | Inquiry PayIn Payment Status | Merchants can actively check the order status. |
14 | Return PayIn Payment Status | Merchants can proactively check the order status. |
2.2.Without PaymentMethod

No | Flow Name | Description |
---|---|---|
1 | Create Transaction Order | Once the customer has chosen the products, they initiate a transaction request, prompting the merchant to generate the order information. |
2 | Fill In PaymentMethod,Create Payment Order | The merchant invokes the PayIn API to create a payment order.You need to complete KYC verification before you can use it. |
3 | Return Cashier Payment Url | Smilepay generates a cashier URL based on your order information. |
4 | Show Cashier Payment Url | The merchant needs to present the Smilepay cashier to the customer. |
5 | Select A Bank To Generate Payment | Smilepay checkout will display a list of all supported banks, you just have to select one. |
6 | Generate VA, QRIS And E-Wallet | Smilepay will submit your application to the bank to generate the required QRIS,VA or E-Wallet information. |
7 | Return To Payment Process | The bank will return the results of our request and notify us that the order is in the payment process. |
6 | Show The QRIS Or VA Number | For QRIS and VA information, you can display it directly or through SmilePay's checkout counter. |
7 | Redirect The User E-Wallet App | For electronic wallets, it will redirect to return a URL that redirects to the app. |
9 | Notify Smilepay Payment Final Status | After the customer has paid successfully, the bank will inform us that the order has been payment success. |
10 | Make A Payment | The user goes to the bank to initiate a payment action. |
11 | Notify Smilepay Payment Final Status | After the customer has paid successfully, the bank will inform us that the order has been payment success. |
12 | Notify SmilePay Payment Final Status | SmilePay will notify the merchant of the final status of the transaction. |
13 | Response Notification Result | For electronic wallets, it will redirect to return a URL that redirects to the app. |
14 | Show Payment Result | Show the merchant the results of a successful payment page. |
15 | Inquiry PayIn Payment Status | Merchants can actively check the order status. |
16 | Return PayIn Payment Status | Merchants can proactively check the order status. |