LinkAja

Overview


LinkAja is a payment method that allows customers to perform purchases and payouts by using LinkAja e-wallets in Indonesia. With LinkAja, you can perform purchases by using Payment Page and Gate, and payouts by using Gate and Dashboard. Download the logo in vector format here.


Payment method type	Payments by using e-wallets
Countries and regions	Indonesia
Payment currencies	IDR
Currency conversion	On the Monetix side
Purchases
Payouts
COF payments
Full refunds
Partial refunds
Chargebacks
Special considerations	Customers can complete the payment by using only the LinkAja mobile app. When using not mobile devices, customers will be offered to go to the LinkAja mobile application after completing the necessary steps.
Onboarding and access fee	Refer to your key account manager at Monetix.

Operations support


	Interfaces			Amounts, IDR		Times
	Payment Page	Gate	Dashboard	minimum	maximum	basic	threshold
Purchases				10,000.00	5,000,000.00	1 minute	24 hours
Payouts				10,000.00	50,000,000.00	3 minutes	36 days

You can check the payment amount limits in your project by using Dashboard. To check your payment amount limits, go to Dashboard, select the Projects section and click the Payment methods tab.

Purchase by using Payment Page

General information

To perform a purchase by using Payment Page with the LinkAja payment method:

Send a request with all the required parameters and signature to the Monetix URL.
Accept the callback with the purchase result from the payment platform.

The following figure shows the complete purchase processing flow in the LinkAja payment method.

Figure 1. Purchase processing steps for a purchase by using Payment Page

The customer initiates a purchase on the merchant's web service.
The web service sends the request for the Payment Page opening to the Monetix URL.
The request for opening Payment Page is redirected to the payment platform.
The payment platform performs the initial request processing that includes validation whether all the required parameters are available and signature is correct.
The requested Payment Page is generated by the Monetix payment platform as specified in the project settings and request parameters.
Payment Page is displayed to the customer.
The customer selects LinkAja as the payment method.
The payment platform receives the purchase request for the payment processing from Payment Page.
The payment platform processes the request and generates the redirection data.
The payment platform sends the customer redirection data to Payment Page.
The customer is redirected to the provider website.
The customer completes all the steps required to complete the payment.
The provider service processes the payment.
The result is displayed to the customer on the provider website.
The customer is redirected to Payment Page.
The provider service sends the result notification to the payment platform.
The payment platform sends a callback with the payment result to the web service.
The payment platform sends the result to Payment Page.
The page with the payment result information is displayed to the customer on Payment Page.

Request

The following table lists the parameters that you need to include in the request for purchase through Payment Page with the LinkAja payment method.

strictly required—the parameter must be in the initial request.

optional—the parameter is optional but adding it to the request either makes the payment process more customer-friendly or helps to increase the percentage of successful payments.

Parameter Description

project_id
integer
strictly required

Project ID you obtained from Monetix when integrating.

Example: 123

payment_id
string
strictly required

Payment ID unique within your project.

Example: payment_47

customer_id
string
strictly required

Unique ID of the customer within your project.

Example: customer_123

customer_first_name
string
strictly required

Customer's first name.

Example: John

customer_last_name
string
strictly required

Customer's last name.

Example: Doe

customer_email
string
strictly required

Customer's email.

Example: johndoe@example.com

payment_currency
string
strictly required

Code of the purchase currency in the ISO-4217 alpha-3 format.

Example: IDR

payment_amount
integer
strictly required

Purchase amount in minor currency units without any decimal point or comma except for the cases when the currency doesn't have any minor currency units. If the currency has minor units (i.e. the number of digits for minor currency units is not zero), set this parameter to the amount in the minor currency units without any decimal point or comma. To check whether the currency has any minor units, see Currency codes.

Example: 30,000.00 IDR must be sent as 3000000

signature
string
strictly required

Signature created after you've specified all the request parameters. For more information about signature generation, see Signature generation and verification.

force_payment_method
string
optional

Parameter that allows you to enforce the LinkAja payment method for your customer and skip the page with payment method selections.

To enforce the LinkAja payment method and skip the page with payment method selection, add the force_payment_method parameter to the request and set its value to linkaja. For more information about enforcing payment methods, see Preselecting payment methods.

Example: force_payment_method: 'linkaja'

You can also add any other optional parameters to the request, if necessary. For the list of all the parameters possible in requests to Payment Page, see Payment Page invocation parameters.

Here is an example of the data from a request to open the checkout page by using EPayWidget:

EPayWidget.run(
    {
        project_id: 1234,
        payment_id: 'payment_47',
        customer_id: 'customer_123',
        customer_first_name: 'John',
        customer_last_name: 'Doe',
        customer_email: 'johndoe@example.com',
        payment_currency: 'IDR',
        payment_amount: 3000000,
        force_payment_method: 'linkaja',    
        signature: 'kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO\/RLUkDJrOcZzUCwX6R\/ekpZhkIQg=='
    }
)

Callback

In the LinkAja payment method, the payment platform returns the purchase result in a callback. For the information about the callback structure, see Callbacks in Payment Page.

The following is an example of a callback body with information about a successfully completed purchase.

Figure 2. Example of the data from a successful purchase callback

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "success",
        "date": "2022-03-25T11:08:45+0000",
        "method": "linkaja",
        "sum": {
            "amount": 3000000,
            "currency": "IDR"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 28,
        "type": "sale",
        "status": "success",
        "date": "2022-03-25T11:08:45+0000",
        "created_date": "2022-03-25T11:08:05+0000",
        "request_id": "9e32835fb27907e0b08569d7d150e387a16a80e336c5117242b5cf60a4e17839",
        "sum_initial": {
            "amount": 3000000,
            "currency": "IDR"
        },
        "sum_converted": {
            "amount": 3000000,
            "currency": "IDR"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-321",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4Xr4DSX2UuHp99rHrtaxkUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

The following is an example of a callback for a declined purchase.

Figure 3. Example of the data from a declined purchase callback

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "decline",
        "date": "2022-03-25T11:20:30+0000",
        "method": "linkaja",
        "sum": {
            "amount": 3000000,
            "currency": "IDR"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 31,
        "type": "sale",
        "status": "decline",
        "date": "2022-03-25T11:20:30+0000",
        "created_date": "2022-03-25T11:19:53+0000",
        "request_id": "fff3d5f8d5d31bc460b68b57dc63f4b482e906eb",
        "sum_initial": {
            "amount": 3000000,
            "currency": "IDR"
        },
        "sum_converted": {
            "amount": 3000000,
            "currency": "IDR"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 15923,
            "payment_id": "0cf4215c-8978",
            "auth_code": ""
        }
    },
    "signature": "J7W15rkqrLzTCD4HkoM4qoEnlVlfqz8155QSlXJKR4m8C4z2iFYv58P4VnHANu445/jmY+g=="
}

Purchase by using Gate

General information

To perform a purchase by using Gate with the LinkAja payment method:

Send the request with all the required parameters and signature to the Monetix URL.
Redirect the customer to the provider service.
Accept the callback with the purchase result from the payment platform.

The following figure provides the details of the purchase processing flow in the LinkAja payment method.

Figure 4. Purchase processing flow when performing a purchase by using Gate

The customer initiates a purchase with LinkAja on the merchant's web service side.
The web service sends a request for processing the purchase by using Gate to the Monetix URL.
The payment platform receives the request for processing the purchase from Gate.
The payment platform performs the initial request processing that includes validation whether all the required parameters are available and signature is correct.
The payment platform sends the response with the request receipt confirmation and validation result to the web service. For more information about the response format, see Response structure.
The payment platform processes the request and generates the redirection data.
The payment platform sends the callback with the redirection data inside the redirect_data object to the web service.
The customer is redirected from the web service to the provider service.
The customer completes all the payment steps required.
The provider service processes the payment.
The result is displayed to the customer.
The customer is redirected to the merchant web service.
The provider service sends the payment result notification to the payment platform.
The payment platform sends the callback with the payment result to the web service.
The web service sends the payment result to the customer.

Request

This section provides the instructions on how to build the request for purchase with the LinkAja payment method.


HTTP request method	POST
Request body format	JSON
API endpoint	/v2/payment/wallet/linkaja/sale
Full API endpoint specification	/v2/payment/wallet/{payment_method}/sale

strictly required—the parameter must be in the initial request.

optional—the parameter is optional but adding it to the request either makes the payment process more customer-friendly or helps to increase the percentage of successful payments.

Object Parameter Description

general
object
strictly required

project_id
integer
strictly required

Project ID you obtained from Monetix when integrating.

Example: 123

payment_id
string
strictly required

Payment ID unique within your project.

Example: payment_47

signature
string
strictly required

Signature created after you've specified all the request parameters. For more information about signature generation, see Signature generation and verification.

customer
object
strictly required

id
string
strictly required

Unique ID of the customer within your project.

Example: customer_123

ip_address
string
strictly required

IP address of the customer's device.

Example: 198.51.100.47

first_name
string
strictly required

Customer's first name.

Example: John

last_name
string
strictly required

Customer's last name.

Example: Doe

email
string
strictly required

Customer's email.

Example: johndoe@example.com

payment
object
strictly required

amount
integer
strictly required

Example: 30,000.00 IDR must be sent as 3000000

currency
string
strictly required

Code of the purchase currency in the ISO-4217 alpha-3 format.

Example: IDR

return_url
object
optional

return
string
optional

The URL to redirect the customer to when they prematurely terminate the payment. This URL is also used if the success and decline parameters are not specified in the request. If you don't specify any parameters of the return_url object in the request, by default Gate will redirect the customer to the URL specified in your project in Monetix.

Example: https://example.com/return/

success
string
optional

The URL to redirect the customer to after the payment is successfully completed.

Example: https://example.com/success/

decline
string
optional

The URL to redirect the customer to after the payment is declined.

Example: https://example.com/decline/

You can also add any other optional parameters to the purchase request, if necessary. For the list of all the parameters available in Gate, see API Reference.

Here is an example of the data from a request to initiate a purchase with the LinkAja payment method.

Figure 5. Example of the data from a purchase request

{
    "general": {
        "project_id": 1234,
        "payment_id": "payment_47",
        "signature": "PJkV8ej\/UG0Di8hTng6JvC7vQsaC6tajQVVfBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "customer": {
        "id": "customer_123",
        "ip_address": "198.51.100.47",
        "first_name": "John",
        "last_name": "Doe",
        "email": "johndoe@example.com"
    },
    "payment": {
        "amount": 3000000,
        "currency": "IDR"
    },
    "return_url": {
        "success": "https://example.com/success/",
        "decline": "https://example.com/decline/",
        "return": "https://example.com/return/"
    } 
}

Format of customer redirection data

After receiving and processing your purchase request, the payment platform sends a callback to your web service containing the data to redirect the customer to the provider service.

To redirect the customer, use the values of the following parameters in the redirect_data object:

url—the URL to redirect the customer to
body—the data to be sent in the request body
method—the HTTP method to get an HTML page of the website (for example, POST or GET)
encrypted—this is the service parameter. Ignore the data it contains.

Here is an example of a piece of callback containing the data to redirect the customer.

"redirect_data": {
    "method": "GET",
    "body": [],
    "encrypted": [],
    "url": "https://example.com/redirect"
}

Callback

In the LinkAja payment method, the payment platform returns the purchase result in a callback. For the information about the callback structure, see Callbacks in Gate.

The following is an example of a callback body with the information about a successfully completed purchase.

Figure 6. Example of the data from a successful purchase callback

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "success",
        "date": "2022-03-25T11:08:45+0000",
        "method": "linkaja",
        "sum": {
            "amount": 3000000,
            "currency": "IDR"
        },
        "description": ""
    },
    "account": {
        "number": "1234567890"
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 28,
        "type": "sale",
        "status": "success",
        "date": "2022-03-25T11:08:45+0000",
        "created_date": "2022-03-25T11:08:05+0000",
        "request_id": "9e32835fb27907e0b08569d7d150e387a16a80e336c5117242b5cf60a4e17839",
        "sum_initial": {
            "amount": 3000000,
            "currency": "IDR"
        },
        "sum_converted": {
            "amount": 3000000,
            "currency": "IDR"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-321",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4Xr4DSX2UuHp99rHrtaxkUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

The following is an example of a callback for a declined purchase.

Figure 7. Example of the data from a declined purchase callback

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "decline",
        "date": "2022-03-25T11:20:30+0000",
        "method": "linkaja",
        "sum": {
            "amount": 3000000,
            "currency": "IDR"
        },
        "description": ""
    },
    "account": {
        "number": "1234567890"
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 31,
        "type": "sale",
        "status": "decline",
        "date": "2022-03-25T11:20:30+0000",
        "created_date": "2022-03-25T11:19:53+0000",
        "request_id": "fff3d5f8d5d31bc460b68b57dc63f4b482e906eb",
        "sum_initial": {
            "amount": 3000000,
            "currency": "IDR"
        },
        "sum_converted": {
            "amount": 3000000,
            "currency": "IDR"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 15923,
            "payment_id": "0cf4215c-8978",
            "auth_code": ""
        }
    },
    "signature": "J7W15rkqrLzTCD4HkoM4qoEnlVlfqz8155QSlXJKR4m8C4z2iFYv58P4VnHANu445/jmY+g=="
}

Payout by using Gate

General information

To perform a payout by using Gate with the LinkAja payment method:

Send a request with all the required parameters and signature to the Monetix URL.
Accept a callback with the payout result from the payment platform.

The following picture provides the details of the payout processing flow in the LinkAja payment method.

Figure 8. Payout processing flow when performing a payout by using Gate

The customer initiates a payout through LinkAja.
The merchant's web service sends the request for processing the payout by using Gate to the Monetix URL.
Gate redirects the request to the Monetix payment platform.
The payment platform performs the initial request processing that includes validation whether all the required parameters are available and signature is correct.
The payment platform sends the response with the request receipt confirmation and validation result to the web service. For more information about the response format, see Response structure.
The payment platform redirects the payout request to the provider service.
The provider service processes the payout.
The provider service sends the result notification to the payment platform.
The payment platform sends a callback with the payment result to the web service.
The web service sends the payment result to the customer.

Request

This section provides the instructions on how to build the payout request through Gate by using the LinkAja payment method.


HTTP request method	POST
Request body format	JSON
API endpoint	/v2/payment/wallet/linkaja/payout
Full API endpoint specification	/v2/payment/wallet/{payment_method}/payout

strictly required—the parameter must be in the initial request.

Object Parameter Description

general
object
strictly required

project_id
integer
strictly required

Project ID you obtained from Monetix when integrating.

Example: 123

payment_id
string
strictly required

Payment ID unique within your project.

Example: payment_47

signature
string
strictly required

Signature created after you've specified all the request parameters. To learn about signature generation, see Signature generation and verification.

customer
object
strictly required

id
string
strictly required

Unique ID of the customer within your project.

Example: customer_123

ip_address
string
strictly required

IP address of the customer's device.

Example: 198.51.100.47

first_name
string
strictly required

Customer's first name.

Example: John

last_name
string
strictly required

Customer's last name.

Example: Doe

email
string
strictly required

Customer's email.

Example: johndoe@example.com

payment
object
strictly required

amount
integer
strictly required

Payout amount in minor currency units without any decimal point or comma except for the cases when the currency doesn't have any minor currency units. If the currency has minor units (i.e. the number of digits for minor currency units is not zero), set this parameter to the amount in the minor currency units without any decimal point or comma. To check whether the currency has any minor units, see Currency codes.

Example: 30,000.00 IDR must be sent as 3000000

currency
string
strictly required

Code of the payout currency in the ISO-4217 alpha-3 format.

Example: IDR

account
object
strictly required

number
string
strictly required

Customer's account number.

Example: 1234567890

You can also add any other optional parameters to the payout request, if necessary. For the list of all the parameters available in Gate, see API Reference.

Here is an example of the data from a request to initiate a payout with the LinkAja payment method.

Figure 9. Example of payout request body

{
    "general": {
        "project_id": 1234,
        "payment_id": "payment_47",
        "signature": "PJkV8ej\/UG0Di8hTng6JvC7vQsaC6tajQVVfBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "customer": {
        "id": "customer_123",
        "ip_address": "198.51.100.47",
        "first_name": "John",
        "last_name": "Doe",
        "email": "johndoe@example.com"
    },
    "account": {
        "number": "1234567890"
    },
    "payment": {
        "amount": 3000000,
        "currency": "IDR"
    }
}

Callback

In the LinkAja payment method, the payment platform returns the payout result in a callback. For the information about the callback structure, see Callbacks in Gate.

The following is an example of a callback body with the information about a successfully completed payout.

Figure 10. Example of the data from a successful payout callback

{
    "project_id": 1234,
    "payment": {
        "id": "payment_48",
        "type": "payout",
        "status": "success",
        "date": "2022-03-25T11:08:45+0000",
        "method": "linkaja",
        "sum": {
            "amount": 3000000,
            "currency": "IDR"
        },
        "description": ""
    },
    "account": {
        "number": "1234567890"
    },
    "operation": {
        "id": 29,
        "type": "payout",
        "status": "success",
        "date": "2022-03-25T11:08:45+0000",
        "created_date": "2022-03-25T11:08:05+0000",
        "request_id": "9e32835fb27907e0b08569d7d150e387a16a80e336c5117242b5cf60a4e17839",
        "sum_initial": {
            "amount": 3000000,
            "currency": "IDR"
        },
        "sum_converted": {
            "amount": 3000000,
            "currency": "IDR"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4Xr4DSX2UuHp99rHrtaxkUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

The following is an example of a callback for a declined payout.

Figure 11. Example of the data from a declined payout callback

{
    "project_id": 1234,
    "payment": {
        "id": "payment_48",
        "type": "payout",
        "status": "decline",
        "date": "2022-03-25T11:20:30+0000",
        "method": "linkaja",
        "sum": {
            "amount": 3000000,
            "currency": "IDR"
        },
        "description": ""
    },
    "account": {
        "number": "1234567890"
    },
    "operation": {
        "id": 29,
        "type": "payout",
        "status": "decline",
        "date": "2022-03-25T11:20:30+0000",
        "created_date": "2022-03-25T11:19:53+0000",
        "request_id": "fff3d5f8d5d31bc460b68b57dc63f4b482e906eb",
        "sum_initial": {
            "amount": 3000000,
            "currency": "IDR"
        },
        "sum_converted": {
            "amount": 3000000,
            "currency": "IDR"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "J7W15rkqrLzTCD4HkoM4qoEnlVlf155QSlXJKR4m8C4z2iFYv58P4VnHANu445/jmY+g=="
}

Payout by using Dashboard

To make a payout through Dashboard, the merchant sends a request and receives a notification with the request processing result. There are two ways to initiate payouts through Dashboard:

single payout—you specify the currency and amount for a payout available for this method and fill in all the fields required for the selected payment method on the Dashboard pages.
as a part of a mass payment—all the parameters are specified in a CSV file. Refer to the Payouts by using Gate section for the parameters required by your payment method.

Information about completed payouts is available for viewing in the Payments and Manual Payments sections of Dashboard.

For more information about payout processing by using Dashboard, see Performing payouts.

Testing

General information

You can perform test purchases with the LinkAja payment method by using Payment Page and Gate.

To perform test purchases, you'll need the test project ID and the secret key to it. To get them, please contact the technical support team at support@monetix.pro and then contact your Monetix key account manager to set up a test environment to work with the LinkAja payment method.

When performing test payments, keep in mind that:

your requests must contain the test project ID
the payment currency that you send in requests can be only IDR
random values may be used as the payment ID and in the parameters with customer information
the interface of the test checkout page may be different from the production one.

Test payments statuses

To receive one of the following statuses in the callback with the test purchase result, use a particular value for the purchase amount in the request:

40000 and 40400—to receive a callback with the decline status
any other value—to receive a callback with the success status

Testing purchase by using Payment Page

To perform a test purchase by using Payment Page:

Send a request for purchase through Payment Page to the payment platform.
Choose a payment method on the test checkout page. If you've passed the force_payment_method parameter with the linkaja value in the request, you won't have to choose the payment method.
Specify a random first name and last name in the data entry fields. The payment instructions will be displayed to you after.
Accept a callback with information about the test purchase result.
Wait a few seconds until the result of the test purchase is displayed to you on the test checkout page.

See the detailed information about purchase processing through Payment Page in the LinkAja payment method in the Purchase by using Payment Page section.

Testing purchase by using Gate

To perform a test purchase by using Gate:

Send a request for performing a test purchase to the payment platform.
Accept a callback with the data for displaying payment instructions. Your system will display the payment instructions to you after.
Accept a callback with information about the test payment result.
Wait a few seconds until your system shows you the result of the test purchase.

See the detailed information about purchase processing through Gate in the LinkAja payment method in the Purchase by using Gate section.

Analysis of payments results

As with other payment methods Monetix offers, when using this method, you have several options to analyze the information about payments and operations.

You can load and analyze all the necessary information in Dashboard (dash-light.trxhost.com), for instance you can use the analytic panels in the Analytics section for this purpose.

Also, you can export the information for further analysis by using third party analytical tools. The following options are available:

Dashboard allows you to download reports in CSV format by using the tools in the Reports section. You can perform export as a one-time or regular download of data to your local computer.
Data API allows you to have payment information exported in JSON format and delivered to a URL you specify. The payment information is exported by means of sending requests to the /operations/get endpoint.

If you have any further questions regarding payment data analysis, contact Monetix technical support.

LinkAja

Overview

Operations support

Purchase by using Payment Page

General information

Request

Callback

Related topics

Purchase by using Gate

General information

Request

Format of customer redirection data

Callback

Related topics

Payout by using Gate

General information

Request

Callback

Related topics

Payout by using Dashboard

Testing

General information

Test payments statuses

Testing purchase by using Payment Page

Testing purchase by using Gate

Analysis of payments results