TrueMoney

Overview

Introduction

TrueMoney is a payment method which allows you to process payments in Thai bahts by using bank accounts in Thailand. This method supports purchases.

This article provides information about working with the TrueMoney method: general insights are presented in the Overview section, while information about the actions required to process payments and perform other actions is presented in the sections that follow.

General information

Payment method type QR code payments
Payment instruments bank accounts
Countries and regions TH
Payment currencies THB
Currency conversion –
One-time purchases +
Credential-on-file purchases –
Full refunds –
Partial refunds –
Payouts –
Chargebacks –
Notes –
Onboarding and access fee refer to your ecommpay account manager

Interaction diagram

Payment processing by using the TrueMoney method involves the merchant's web service, one of ecommpay interfaces, the ecommpay payment platform, and technical facilities of the TrueMoney service.



Operations support

Various platform interfaces can be used to process payments and perform operations using the TrueMoney method. Purchases can be processed by using Payment Page, Gate, and Dashboard (using payment links). At the same time, regardless of the interfaces used, the following properties and limitations are applicable.

The following properties and limitations apply to the TrueMoney method.

Amounts, THB ¹
minimum maximum
Purchases 100.00 500,000.00
Note:
  1. For more information refer to your ecommpay key account manager.

Processing scenarios

To perform a purchase by using the TrueMoney method, you need to redirect the customer to the TrueMoney service. When additional features (such as payment links) are used, scenarios for performing operations correspond to the specifics of those features.

The customer payment scenario via Payment Page (in the basic case where the customer chooses the method and is redirected from the final page of the payment form to the web service) looks like this.

Figure 1. Proceeding to payment


Figure 2. Selecting method


Figure 3. Receiving instructions


Figure 4. Paying according to instructions


Figure 5. Redirecting to the payment form


Figure 6. Redirecting to the web service


General scenarios of processing purchases can be presented as follows.

Figure 7. Purchase by using Payment Page


Figure 8. Purchase by using Gate


Purchases by using Payment Page

General information

To process a purchase through Payment Page by using the TrueMoney method, the merchant's web service is required to send a request with all required parameters and signature to the ecommpay URL and receive a callback with the result. The full sequence and special aspects of purchase processing are provided below.



Figure 9. Purchase processing by using Payment Page: step-by-step description
  1. A customer initiates a purchase in the web service.
  2. The web service sends the request for Payment Page opening to the specified ecommpay URL.
  3. The request for opening Payment Page is sent to the payment platform.
  4. The payment platform receives the request and validates the required parameters and signature.
  5. Payment Page is generated based on the project and request parameters.
  6. Payment Page is displayed to the customer.
  7. The customer selects the TrueMoney method.
  8. The payment platform receives the request for processing the payment by using the TrueMoney method.
  9. The payment platform processes the request.
  10. The data for redirecting the customer is sent from the payment platform to Payment Page.
  11. The customer is redirected to the TrueMoney service.
  12. The customer completes all required payment steps.
  13. The purchase is processed in the TrueMoney service.
  14. The customer is redirected to Payment Page.
  15. The TrueMoney service sends a notification about the result to the payment platform.
  16. The payment platform sends the payment result callback to the web service.
  17. The payment platform sends the result information to Payment Page.
  18. The result information is displayed to the customer on Payment Page.

Information about the formats of requests and callbacks used for processing payments by using the TrueMoney method via Payment Page is presented further in this section; general information about working with the Payment Page API is presented in Interaction concepts.

Request format

There are several things you need to consider when sending purchase requests by using the TrueMoney method:

  1. The following parameters required for any payment must be specified:
    • project_id—the project identifier obtained from ecommpay
    • payment_id—payment identifier unique within the project
    • payment_currency—payment currency code in the ISO-4217 alpha-3 format
    • payment_amount—payment amount in the smallest currency unit
    • customer_id—customer identifier unique within the project

    Depending on the payment processing provider, other parameters may be required in the purchase requests.

  2. The following parameters required for any payment must be specified: project_id, payment_id, payment_currency, payment_amount, customer_id.

    Depending on the payment processing provider, other parameters may be required in the purchase requests.

  3. The currency of the payment can only be THB.
  4. If you need to have the payment form displayed with the TrueMoney method selected, set the force_payment_method parameter to true-money.
  5. Additionally, any other parameters available for working with Payment Page can be used (details).
  6. After all target parameters are specified, generate a signature (details).

Thus, a correct request for opening the payment form using the TrueMoney method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer identifier and the signature.

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 10000,
   "payment_currency": "THB",
   "customer_id": "customer1",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}
Figure 10. Example of sufficient data in a purchase request
{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 10000,
   "payment_currency": "THB",
   "customer_id": "customer1",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

Callback format

The TrueMoney method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks.

The following is the example of a callback with information about a 100.00 THB purchase made in the 12345 project.

Figure 11. Example of callback data indicating that the purchase has been processed
 {
        "customer": {
            "id": "customer1"
        },
        "project_id": 12345,
        "payment": {
            "id": "payment1234",
            "type": "purchase",
            "status": "success",
            "date": "2021-10-12T08:16:05+0000",
            "method": "true-money",
            "sum": {
                "amount": 10000,
                "currency": "THB"
            },
            "description": ""
        },
        "operation": {
            "id": 5054705010079872,
            "type": "sale",
            "status": "success",
            "date": "2021-10-12T08:16:05+0000",
            "created_date": "2021-10-12T08:14:01+0000",
            "request_id": "a41fcbe99835e5fbc69770344bce...379c2da5-05054706",
            "sum_initial": {
                "amount": 10000,
                "currency": "THB"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "THB"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 8792,
                "payment_id": "2021101203031281",
                "auth_code": ""
            }
        },
        "signature": "EIrbFLdIqieeX/Oi2Xl/3xADlmidzSRqKsFzwKVXTkpC2CNA=="
    }

The following is the example of a callback with information about a declined purchase.

Figure 12. Example of callback data indicating that the purchase has been declined
{
        "customer": {
            "id": "1"
        },
        "project_id": 67890,
        "payment": {
            "id": "payment5678",
            "type": "purchase",
            "status": "decline",
            "date": "2021-10-13T08:10:17+0000",
            "method": "true-money",
            "sum": {
                "amount": 10000,
                "currency": "THB"
            },
            "description": ""
        },
        "operation": {
            "id": 5000375010078322,
            "type": "sale",
            "status": "decline",
            "date": "2021-10-13T08:10:17+0000",
            "created_date": "2021-10-12T08:10:11+0000",
            "request_id": "6d2129131a347e8107b6bc2e324...a483c36017-05000376",
            "sum_initial": {
                "amount": 10000,
                "currency": "THB"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "THB"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 8792,
                "payment_id": "",
                "auth_code": ""
            }
        },
        "signature": "bRj3VHm1qT1/RRrWrqW9LwxM5C9bTpoTx7mz2GxIdEyAeC4oA8w=="
    }

Useful links

The following articles can be useful when implementing purchases via Payment Page:

Purchases by using Gate

General information

To process a purchase through Gate by using the TrueMoney method, the merchant's web service is required to do the following:

  1. Send a request with all the required parameters and signature to the ecommpay URL.
  2. Receive an intermediate callback from the payment platform and redirect the customer to the TrueMoney service.
  3. Receive the final callback from the payment platform.

The full sequence and special aspects of purchase processing are provided below.



Figure 13. Purchase processing by using Gate: step-by-step description
  1. A customer initiates a purchase by using the TrueMoney method in the web service.
  2. The web service sends the request for processing the purchase by using Gate to the specified ecommpay URL.
  3. The payment platform receives the request.
  4. The payment platform validates the required parameters and signature in the request.
  5. The payment platform sends the response to the web service with information about the receipt of the request and its validity (details).
  6. The payment platform performs further processing of the request (with parameter consistency check) and generates the redirection data.
  7. The payment platform sends the callback with the redirection data in the redirect_data object to the web service.
  8. The customer is redirected to the TrueMoney service.
  9. The customer completes all required payment steps.
  10. The purchase is processed in the TrueMoney service.
  11. The customer is redirected to the web service.
  12. The TrueMoney service sends the payment result notification to the payment platform.
  13. The payment platform sends the payment result callback to the web service.
  14. The customer receives the payment result information from the web service.

Information about the formats of requests and callbacks used for processing payments by using the TrueMoney method via Gate is presented further in this section. General information about working with the Gate API is presented in Interaction concepts.

Request format

There are several things you need to consider when sending purchase requests by using the TrueMoney method:

  1. To initiate each purchase, send a separate POST request to the /v2/payment/wallet/true-money/sale endpoint. This endpoint belongs to the group /v2/payment/wallet/{payment_method}/sale.
  2. Each request must include the following objects and parameters:
    • Object general—general purchase information:
      • project_id—project identifier obtained from ecommpay during integration
      • payment_id—payment identifier unique within the project
      • signature—request signature generated after all required parameters are specified (details—in the Signature generation and verification) (details)
    • Object payment—payment information:
      • amount—payment amount in the smallest currency unit
      • currency—payment currency code in the ISO-4217 alpha-3 format
    • Object customer—customer information:
      • id—customer identifier unique within the project
      • ip_address—customer IP address relevant for the initiated payment
    • Object return_url—the URLs to which customer is redirected while or after payment processing:
      • success—URL to redirect the customer to the web service after the customer completes all the required actions on the TrueMoney service side
      • decline—URL to redirect the customer to the web service after the customer doesn't complete all the required actions on the TrueMoney service side

    Depending on the payment processing provider, other parameters may be required in the purchase requests.

  3. The currency of the payment can only be THB.
  4. Additionally, any other parameters included in the specification can be used.

Thus, a correct purchase request by using the TrueMoney method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer identifier and IP address, URLs for redirection as well as signature.

{
  "general": {
    "project_id": 210,
    "payment_id": "test_payment",
    "signature": "PJkV8ej\/UG0Di8hTng6JvipTv+AWoXW\/9MTO8yJA=="
  },
  "payment": {
    "amount": 10000,
    "currency": "THB"
  },
  "customer": {
    "id": "customer123",
    "ip_address": "192.0.2.0"
  },
    "return_url":{
      "success" : "http://example.com",
      "decline" : "http://anotherexample.com"
  }
}
Figure 14. Example of sufficient data in a purchase request
{
  "general": {
    "project_id": 210,
    "payment_id": "test_payment",
    "signature": "PJkV8ej\/UG0Di8hTng6JvipTv+AWoXW\/9MTO8yJA=="
  },
  "payment": {
    "amount": 10000,
    "currency": "THB"
  },
  "customer": {
    "id": "customer123",
    "ip_address": "192.0.2.0"
  },
    "return_url":{
      "success" : "http://example.com",
      "decline" : "http://anotherexample.com"
  }
}

Formats of intermediate callbacks for customer redirection

Each payment made with the TrueMoney method requires redirection of customers from the merchant's web service to the TrueMoney service. To redirect a customer it is necessary to receive an intermediate callback from the payment platform and use the information included in the redirect_data object. The format of such callbacks is standard (details), and the following objects and parameters are included in the redirect_data object:

  • body—object with data to be sent in the request body
  • method—parameter specifying the HTTP method for sending the request (GET or POST)
  • url—parameter containing a link for redirection
Figure 15. redirect_data example
    "redirect_data": {
        "body": {
            "Data": "4dg65h72G63k68g61J6eK74I49h44i3dj41H454J4dK42I2eh46i54j",
            "Remarks": "",
            "EncryptText": "8F4AC9ED17D1579A7DE5121B16A45B4F"
        },
        "method": "POST",
        "url": "https://www.example.com/pay"
    }

Final callback format

The TrueMoney method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks.

The following is the example of a callback with information about a 100.00 THB purchase made in the 12345 project.

Figure 16. Example of callback data indicating that the purchase has been processed
 {
        "customer": {
            "id": "customer1"
        },
        "project_id": 12345,
        "payment": {
            "id": "payment1234",
            "type": "purchase",
            "status": "success",
            "date": "2021-10-12T08:16:05+0000",
            "method": "true-money",
            "sum": {
                "amount": 10000,
                "currency": "THB"
            },
            "description": ""
        },
        "operation": {
            "id": 5054705010079872,
            "type": "sale",
            "status": "success",
            "date": "2021-10-12T08:16:05+0000",
            "created_date": "2021-10-12T08:14:01+0000",
            "request_id": "a41fcbe99835e5fbc6977004083379379c2da5-05054706",
            "sum_initial": {
                "amount": 10000,
                "currency": "THB"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "THB"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 8792,
                "payment_id": "2021101203031281",
                "auth_code": ""
            }
        },
        "signature": "EIrbFLdIqieeX/Oi2Xl/3xADlmidzwKVXTkpC2CNA=="
    }

The following is the example of a callback with information about a declined purchase.

Figure 17. Example of callback data indicating that the purchase has been declined
{
        "customer": {
            "id": "1"
        },
        "project_id": 67890,
        "payment": {
            "id": "payment5678",
            "type": "purchase",
            "status": "decline",
            "date": "2021-10-13T08:10:17+0000",
            "method": "true-money",
            "sum": {
                "amount": 10000,
                "currency": "THB"
            },
            "description": ""
        },
        "operation": {
            "id": 5000375010078322,
            "type": "sale",
            "status": "decline",
            "date": "2021-10-13T08:10:17+0000",
            "created_date": "2021-10-12T08:10:11+0000",
            "request_id": "6d2129131a347e8107b6bc2e483c36017-05000376",
            "sum_initial": {
                "amount": 10000,
                "currency": "THB"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "THB"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 8792,
                "payment_id": "",
                "auth_code": ""
            }
        },
        "signature": "bRj3VHm1qT1/RRrWrqW9LwxM5CxIdEyAeC4oA8w=="
    }

Useful links

The following articles can be useful when implementing purchases via Gate:

Analysis of payment results

To analyse information about payments made with the TrueMoney method and other methods, you can use:

  • Dashboard interface toolkit with various lists and analytic panels.
  • Reports in CSV file format, available via the Reports section (one-time and periodically).
  • Data in JSON format, sent by program requests to a specified URL available by using the Data API interface.

If you have any questions, refer to the documentation (Dashboard and Using Data API) and ecommpay technical support.