QuickPay Transaction API*
Seamless and hassle free checkout experience process
* Only available for Online Merchant Partners with ISO 27001/27701 Certification
This section will show you how you can tokenize the user and make the payment more seamless with Indodana. With this QuickPay checkout integration, Indodana user can enjoy the easy & fast checkout experience on your platform. Contrast to normal checkout, user with QuickPay checkout activated won't have to input credentials / sign-in to Indodana platform on every transaction. The user will directly proceed to checkout your transaction if we don't detect any suspicious behavior after you redirect the user to our checkout page.
This section only covers the specific QuickPay API integration, so we recommend you to read the Direct API Integration first for general integration information.
User Tokenization Options
This section will guide you on how to get the Indodana QuickPay user token. The Indodana QuickPay user token is a long live unique token per-user that you can store in your system. You need to pass this Indodana QuickPay user token when checkout to enable seamless transaction experience without user sign-in process.
Indodana provides two tokenization flows :
Explicit user tokenization from merchant's platform menu The explicit user tokenization is a flow when user explicitly says that he/she wants to tokenize Indodana account on your platform menu. Upon successful authorization, your system will get the Indodana QuickPay user token via callback request.
User tokenization on checkout User tokenization on checkout is a flow when user does tokenization while he/she checkouts transactions on your platform using Indodana. Upon successful transaction, your system will get Indodana QuickPay user token via callback request.
API Method References
Indodana Connect Account
POST
https://{baseUrl}/v1/connect
Use this API to initiate user tokenization. After calling this API, you will get a redirection URL for the user to authorize your tokenization request. You need to redirect the user to the redirection URL and upon successful authorization, you will get the Indodana QuickPay user token from the callback.
*
means the parameter is required
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | The generated authentication signature with format
|
Request Body
Name | Type | Description |
---|---|---|
merchantUserKey* | string | User identifier in merchant's platform. Indodana will send the Indodana QuickPay token alongside this information so you know the owner of token. |
phoneNumber* | string | Phone number of user in merchant's platform. |
backToStoreUrl* | string | Url to be redirected by Indodana to user after the connect process is complete. |
metadata | object | Key value pair of additional information of user / transaction. |
When you initiate checkout with null
/ invalid Indodana QuickPay user token, it will give the signed-in user an option to do tokenization on Indodana checkout page. With this method, you don't need to create a dedicated menu for connecting Indodana account to your platform.
Please refer to checkout using QuickPay for the API specification.
Get Payment Calculation
POST
https://{baseUrl}/v3/payment_calculation
Once the user is tokenized, you can use this API to know installment options available for the current user based on his/her limit balance.
If you pass a valid Indodana QuickPay user token to call this API, this API will respond with additional properties currentAvailableLimitBalance
and isEligible
. When the user's current limit balance is insufficient on the particular tenure option, the property isEligible
will be false, so you can gray out the payment option based on your platform UI/UX design.
*
means the parameter is required
Headers
Name | Type | Description |
---|---|---|
X-User-Token* | string | Indodana QuickPay user token |
Authorization* | string | The generated authentication signature with format
|
Request Body
Name | Type | Description |
---|---|---|
items* | array | Array of <Item>. Details of shopping items in the transaction. |
amount* | number | Total amount of the transaction. Should be equal to the sum of all the <Item>'s costs. |
Purchase Transaction Checkout
POST
https://{baseUrl}/v3/checkout_url
This checkout API v3 enables QuickPay integration. You need to pass valid x-user-token
on the header so user can enjoy the easy & fast checkout experience.
Don't worry if you don't have the Indodana QuickPay user token for current checkout user in the first place, our checkout page already handle the flow and you need to store the token every time Indodana sends the token via callback to your system and use this token for subsequent transaction.
*
means the parameter is required
Headers
Name | Type | Description |
---|---|---|
X-User-Token* | string | Indodana QuickPay user token. You can pass |
Authorization* | string | The generated authentication signature with format
|
Request Body
Name | Type | Description |
---|---|---|
merchantUserKey* | string | User identifier in merchant's platform. Indodana will send the Indodana QuickPay user token alongside this information so you know the owner of the token. |
transactionDetails* | object | <Transaction> - Detail of the transaction. |
customerDetails* | object | <Customer> - Detail of the customer. |
sellers* | array | Array of <Seller> - Detail of the sellers involved in the transaction. May contain more than 1 seller. |
billingAddress* | object | <Address> - Billing address of the customer for the transaction. |
shippingAddress* | string | (Required only for goods, for service / digital product is not required) <Address> - Shipping address of the customer for the transaction. |
paymentType* | string | (Required for active Indodana QuickPay user token) Installment options / payment terms chosen by the customer. Possible values: |
approvedNotificationUrl* | string | The URL that will be called by Indodana when the transaction is approved and successful. |
cancellationRedirectUrl* | string | The URL for user to be redirected if transaction's cancelled in Indodana's checkout page. |
backToStoreUrl* | string | The URL for user to be redirected after completes the checkout process. |
expirationAt | string | Timestamp when the transaction expired on merchant's platform. |
metadata | object | Key value pair contains additional information of transaction. |
couponCodes | Array of String | Coupon Code |
Object Type References
For object specification of Transaction, Customer, Seller, Address, and Metadata can refer to this API reference.
QuickPay User Token Revocation
POST
https://{baseUrl}/v1/revoke_user_token
You can revoke the Indodana QuickPay user token from your platform permanently. When token is revoked, the token will be invalid and system will trigger tokenization again on next user checkout from your platform. The token itself can be revoked from your side and Indodana side. So for the integration, we expect you to always save the token from our callback to your system with the purpose to always have the valid token of the user.
*
means the parameter is required
Headers
Name | Type | Description |
---|---|---|
X-User-Token* | string | Indodana QuickPay user token to be revoked |
Authorization* | string | The generated authentication signature with format
|
Object Type References
For object specification of Item, can refer to this API reference.
User QuickPay Eligibility
GET
https://{baseUr}/v1/users/check_eligibility
This API is used to check whether a user is eligible to connect QuickPay or not. Eligible means the user has active PayLater Limit
Headers
Name | Type | Description |
---|---|---|
Authorization* | String | The generated authentication signature with the format
|
Request Body
Name | Type | Description |
---|---|---|
phoneNumber* | String | User Registered Phone Number |
User Credit Details
GET
https://{base_url}/v1/user_details
Once user is tokenized, you can use this API to know about user information details including account status and remaining credit limit.
*
means the parameter is required
Headers
Name | Type | Description |
---|---|---|
X-User-Token* | string | Indodana QuickPay user token |
Authorization* | string | The generated authentication signaturee with format |
Sample API Request and Response
Indodana Connect Account
Purchase Transaction Checkout
Handling Transaction Confirmation Notification
Note that for this section, the API Request would be the payload that the merchant receives in their endpoint, and the API Response would be the payload that the merchant expected to send to Indodana as acknowledgement.
Get Payment Calculation
Callback User Token
This step is used to retrieve the Indodana QuickPay user token from callback after the authorization from user already completed.
You need to inform us the URL to be registered on Indodana side. After successful store token in your system, you need to response with status code 200 like defined in the response example tab below to acknowledge the token.
Last updated