Touch&Go
Overview
Touch&Go is a payment method that allows customers to perform purchases and payouts by using Touch&Go e-wallets. With Touch&Go, 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 | Malaysia |
Payment currencies | MYR |
Currency conversion | On the Monetix side |
Purchases | |
Payouts | |
COF payments | |
Full refunds | |
Partial refunds | |
Chargebacks | |
Special considerations |
|
Onboarding and access fee | Refer to your key account manager at Monetix. |
Interaction diagram
Payment processing by using the Touch&Go payment method requires the merchant web service, one of the Monetix interfaces, and the Monetix payment platform, as well as the provider's technical facilities.
Operations support
Interfaces | Amounts, MYR | Times | |||||
---|---|---|---|---|---|---|---|
Payment Page | Gate | Dashboard | minimum | maximum | basic | threshold | |
Purchases | 1.00 | 30,000.00 | 1 minute | 48 hours | |||
Payouts | 5.00 | 20,000.00 | 1 minute | 24 hours |
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.
Processing scenarios
In the Touch&Go method, purchases and payouts follow different processing procedures. To perform a purchase, you need to redirect the customer to the provider service, while to initiate a payout, you need to notify the customer via the merchant web service.
The sections that follow provide more information about what you need to perform payments and how you can analyze payments and operations information.
Special payment processing considerations
If the payment amount is exactly the same as the amount of one of the currently processed payments, then due to some special aspects of the provider operation, the payment platform may increase the payment amount by 0.01 to 0.99 MYR (but does not necessarily do so). This is sometimes required to distinguish between the current payment and the other ongoing payments with the same amount. The platform makes its best to avoid increasing the payment amount, if this is possible.
If number of the currently processed payments is so large that there are no more free slots in the 0,01 to 0,99 MYR range, then the payment platform declines the current request and all subsequent ones until processing of at least one of the current payments with the same amount is complete.
If the payment platform is forced to increase the payment amount, it responds to the web service with a callback with the new amount.
Here is an example of how the payment platform may behave when receiving two requests for payment with the same amount:
- The payment platform accepts the first request for payment of 15.00 MYR. This is the first request with this amount, therefore the payment platform does not change its amount and starts processing a 15,00 MYR payment.
- The payment platform accepts the second request for payment of 15.00 MYR.
- Since the payment with the amount of 15.00 MYR is already being processed, the payment platform changes the amount of the second payment to 15.01 MYR and proceeds with this amount.
Purchase by using Payment Page
General information
In the Touch&Go method, when processing a purchase by using Payment Page, the merchant web service sends a request with all the required parameters and signature to the Monetix URL and accepts the callback with the payment result from the payment platform. When opening Payment Page, you can have Payment Page opened with the Touch&Go method pre-selected. (For more information about pre-selecting payment methods, see in Preselecting payment methods.)
The full sequence of the purchase workflow is provided below.
- Customer initiates purchase on the merchant's web service.
- The web service sends the request for Payment Page opening to the Monetix URL.
- The request for opening Payment Page is redirected to the payment platform.
- The payment platform performs initial request processing that includes validation whether all 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 Touch&Go as payment method.
- The payment platform receives the purchase request for 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 payment is processed on the provider side.
- The provider service sends the result notification to the payment platform.
- The payment platform sends 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.
The sections that follow discuss in more details the request format and the Payment Page parameters to use in the Touch&Go payment method and provide the information about format of callbacks with payment results. For the general information about how to use the Payment Page API, see Payment Page API Description.
Request format
There are several things you need to consider when dealing with purchase requests in the Touch&Go method:
- You must provide values for the basic minimum of parameters. Listed below are the parameters that are mandatory for any payment method:
- project_id—project ID you obtained from Monetix
- payment_id—payment ID unique within the project
- customer_id—the unique ID of the customer within your project
- customer_email—customer email
- customer_first_name—customer first name
- customer_last_name—customer last name
- payment_currency—payment currency in ISO-4217 alpha-3 format
- payment_amount—payment amount in minor currency units without any decimal point or comma except for cases where the currency does not have any minor currency units. If the currency has no minor units (that is, the number of digits for minor currency units is zero), then you must set this parameter to the amount in the major currency units. For the information on whether the currency has any minor units, see Currency codes.
- If you need to have payment form displayed with the Touch&Go method pre-selected, set the force_payment_method parameter to the code on the
touchngo-wallet
payment method. - You can also add any other additional parameters Payment Page supports. For more information about parameters supported by Payment Page, see Payment Page invocation parameters.
- After you specify all the parameters you need, you need to generate signature for the request. For instructions on how to sign payment requests, see Signature generation and verification.
Here is an example of data from a request for Payment Page opening:
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: 'MYR', payment_amount: 50000, signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO\/RLUkDJrOcZzUCwX6R\/ekpZhkIQg==" } )
Callback format
The Touch&Go method uses the standard format for callbacks to deliver purchase results. For more information about callbacks, see Callbacks in Payment Page.
The following is an example of a callback with an information about successful 500.00 MYR
purchase in the 1234
project.
{ "project_id": 1234, "payment": { "id": "payment_47", "type": "purchase", "status": "success", "date": "2022-03-25T11:08:45+0000", "method": "Touchngo Wallet", "sum": { "amount": 50000, "currency": "MYR" }, "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": 50000, "currency": "MYR" }, "sum_converted": { "amount": 50000, "currency": "MYR" }, "code": "0", "message": "Success", "provider": { "id": 12345, "payment_id": "123abc123-321", "auth_code": "" } }, "signature": "U7HQO7ToISZhMPKdM4Xr4DSX2UuHp99rHrtaxkUKQtoYzFvoB3cs9CRd4xeYG2Q==" }
The following is the example of a callback for a declined purchase.
{ "project_id": 1234, "payment": { "id": "payment_47", "type": "purchase", "status": "decline", "date": "2022-03-25T11:20:30+0000", "method": "Touchngo Wallet", "sum": { "amount": 50000, "currency": "MYR" }, "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": 50000, "currency": "MYR" }, "sum_converted": { "amount": 50000, "currency": "MYR" }, "code": "20000", "message": "General decline", "provider": { "id": 15923, "payment_id": "0cf4215c-8978", "auth_code": "" } }, "signature": "J7W15rkqrLzTCD4HkoM4qoEnlVlfqz8155QSlXJKR4m8C4z2iFYv58P4VnHANu445/jmY+g==" }
Related topics
The following topics might be useful when implementing payments through Payment Page:
Purchase by using Gate
General information
In the Touch&Go method, the merchant web service is required to do the following when processing a purchase by using Gate:
- Send request with all the required parameters and signature to the Monetix URL.
- Redirect the customer to the provider service.
- Accept the callback with the payment result from the payment platform.
The following diagram provides the detailed picture of the payment processing procedure.
- Customer initiates purchase with Touch&Go 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 initial request processing that includes validation whether all required parameters are available and signature is correct.
- The payment platform sends the response with 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 payment is processed on the provider service side.
- 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.
The sections that follow discuss in more details the request format and the Gate parameters to use in the Touch&Go payment method and provide the information about the format of callbacks with purchase results. For the general information on how to use the Gate API, see API Description.
Request format
There are several things you need to consider when dealing with purchase requests in the Touch&Go method:
- You initiate purchase request by sending a request to the /v2/payment/wallet/touchngo/sale endpoint by using HTTP method POST. This endpoint belongs to the following group of endpoints for payments by using e-wallets: /v2/payment/wallet/{payment_method}/sale
- The following objects and parameters must be specified in any request:
- general—object with general request identification information:
- project_id—the project ID you obtained from Monetix
- payment_id—payment ID unique within the project
- signature—signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification.
- customer—object with customer information:
- id—the unique ID of the customer within your project
- ip_address—IP address of the customer's device
- email—customer email
- first_name—customer first name
- last_name—customer last name
- payment—object with purchase information:
- amount—purchase amount in minor currency units without any decimal point or comma except for cases where the currency does not have any minor currency units. If the currency has no minor units (that is, the number of digits for minor currency units is zero), then you must set this parameter to the amount in the major currency units. For the information on whether the currency has any minor units, see Currency codes.
- currency—code of purchase currency in the ISO-4217 alpha-3 format
- general—object with general request identification information:
- The following parameters with the return URLs are optional, but we strongly advise you to specify them in the request to provide your customer a better user experience. 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.
- return_url—object with the information where to redirect the customer to when the payment is completed or prematurely terminated by the customer:
- success—the URL to redirect the customer to after the payment is successfully completed
- decline—the URL to redirect the customer to after the payment is declined
- return—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.
- return_url—object with the information where to redirect the customer to when the payment is completed or prematurely terminated by the customer:
- If required, you can add any other additional (optional) parameters Gate supports.
Here is an example of data from a purchase request in the Touch&Go method.
{ "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": 50000, "currency": "MYR" }, "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": "POST", "body": { "example_parameter_1": "value_1", "example_parameter_2": "value_2" }, "encrypted": [], "url": "https://example.com/redirect" }
Callback format
The Touch&Go method uses the standard format for callbacks to deliver purchase results. For more information about callbacks, see Callbacks in Gate.
The following is an example of a callback with an information about successful 500.00 MYR
purchase in the 1234
project.
{ "project_id": 1234, "payment": { "id": "payment_47", "type": "purchase", "status": "success", "date": "2022-03-25T11:08:45+0000", "method": "Touchngo Wallet", "sum": { "amount": 50000, "currency": "MYR" }, "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": 50000, "currency": "MYR" }, "sum_converted": { "amount": 50000, "currency": "MYR" }, "code": "0", "message": "Success", "provider": { "id": 12345, "payment_id": "123abc123-321", "auth_code": "" } }, "signature": "U7HQO7ToISZhMPKdM4Xr4DSX2UuHp99rHrtaxkUKQtoYzFvoB3cs9CRd4xeYG2Q==" }
The following is the example of a callback for a declined purchase.
{ "project_id": 1234, "payment": { "id": "payment_47", "type": "purchase", "status": "decline", "date": "2022-03-25T11:20:30+0000", "method": "Touchngo Wallet", "sum": { "amount": 50000, "currency": "MYR" }, "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": 50000, "currency": "MYR" }, "sum_converted": { "amount": 50000, "currency": "MYR" }, "code": "20000", "message": "General decline", "provider": { "id": 15923, "payment_id": "0cf4215c-8978", "auth_code": "" } }, "signature": "J7W15rkqrLzTCD4HkoM4qoEnlVlfqz8155QSlXJKR4m8C4z2iFYv58P4VnHANu445/jmY+g==" }
Related topics
The following topics might be useful when implementing payments through Gate:
Payout by using Gate
General information
To perform a payout with the Touch&Go method, the merchant's web service sends a request with all the required parameters and signature to the Monetix URL, and receives a callback with the payment result.
The complete sequence of the payout process is provided below.
- The customer initiates a payout through Touch&Go.
- 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.
The sections that follow discuss in more details the request format and the Gate parameters to use in the Touch&Go payment method and provide the information on the format of callbacks with payout results. For the general information on how to use the Gate API, see API Description.
Request format
There are several things you must consider when using payout requests in the Touch&Go method:
- You initiate a payout by sending a payout request to the /v2/payment/wallet/touchngo/payout endpoint by using the HTTP method POST. This endpoint belongs to the following group of endpoints for the payouts by using e-wallets: /v2/payment/wallet/{payment_method}/payout.
- The following objects and parameters must be specified in any request:
- general—object with general request identification information:
- project_id—the project ID obtained from Monetix
- payment_id—payment ID unique within the project
- signature—signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification.
- customer—object with customer information:
- id—the unique ID of the customer within your project
- ip_address—IP address of the customer's device
- first_name—customer first name
- last_name—customer last name
- email—customer email
- account—object with customer account information:
- number—customer's e-wallet account number
- payment—object with payout information:
- amount—payout amount in minor currency units without any decimal point or comma except for cases where the currency does not have any minor currency units. If the currency has no minor units (that is, the number of digits for minor currency units is zero), then you must set this parameter to the amount in the major currency units. For the information on whether the currency has any minor units, see Currency codes.
- currency—code of payout currency in the ISO-4217 alpha-3 format
- general—object with general request identification information:
- If required, you can also add any other additional parameters Gate supports.
Here is an example of the data from a payout request in the Touch&Go method.
{ "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": "1234567890123456" }, "payment": { "amount": 50000, "currency": "MYR" } }
Callback format
The Touch&Go method uses the standard format for callbacks to deliver payout results. For more information about callbacks, see Callbacks in Gate.
The following is the example of a callback with information about a successful 500.00 MYR
payout.
{ "project_id": 1234, "payment": { "id": "payment_48", "type": "payout", "status": "success", "date": "2022-03-25T11:08:45+0000", "method": "Touchngo Wallet", "sum": { "amount": 50000, "currency": "MYR" }, "description": "" }, "customer": { "id": "customer_123" }, "account": { "number": "123456" }, "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": 50000, "currency": "MYR" }, "sum_converted": { "amount": 50000, "currency": "MYR" }, "code": "0", "message": "Success", "provider": { "id": 12345, "payment_id": "123abc123-123", "auth_code": "" } }, "signature": "U7HQO7ToISZhMPKdM4Xr4DSX2UuHp99rHrtaxkUKQtoYzFvoB3cs9CRd4xeYG2Q==" }
The following is the example of a callback for a declined payout.
{ "project_id": 1234, "payment": { "id": "payment_48", "type": "payout", "status": "decline", "date": "2022-03-25T11:20:30+0000", "method": "Touchngo Wallet", "sum": { "amount": 50000, "currency": "MYR" }, "description": "" }, "customer": { "id": "customer_123" }, "account": { "number": "123456" }, "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": 50000, "currency": "MYR" }, "sum_converted": { "amount": 50000, "currency": "MYR" }, "code": "20000", "message": "General decline", "provider": { "id": 12345, "payment_id": "123abc123-123", "auth_code": "" } }, "signature": "J7W15rkqrLzTCD4HkoM4qoEnlVlf155QSlXJKR4m8C4z2iFYv58P4VnHANu445/jmY+g==" }
Related topics
The following topics might be useful when implementing payments through Gate:
Payout by using 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 payments with the Touch&Go payment method. Test purchases are performed by using Payment Page and Gate. Test payouts are performed by using Gate
To perform test payments, you'll need the test project ID and the secret key to it. To get them, contact the technical support team at support@monetix.pro.
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 MYR
- random values may be used as the payment ID, customer's e-wallet number 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:
- decline—when using
40000
or40400
amount - success—when using any amount other than those mentioned above
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
touchngo-wallet
value in the request, you won't have to choose the payment method. - Click the Success or Decline button (the relevant button will be displayed depending on the amount sent in the request).
- 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 Touch&Go 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 redirection data.
- Go to the received URL and click the Success or Decline button (the relevant button will be displayed depending on the amount sent in the request).
- Make sure that the test purchase confirmation page is displayed to you.
- Accept a callback with information about the test payment result.
See the detailed information about purchase processing through Gate in the Touch&Go payment method in the Purchase by using Gate section.
Testing payouts by using Gate
To perform a test payout by using Gate:
- Send a request for performing a test payout to the payment platform.
- Accept a callback with information about the test payout result.
See the detailed information about payout processing through Gate in the Touch&Go payment method in the Payout 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.