TrueMoney for Payment Setup API

Last updated: April 30, 2026

To accept TrueMoney payments, you must:

Create a payment setup.
Confirm the payment.
Redirect the customer to TrueMoney.

Call the Create a payment setup endpoint.

Information

Your base URL's {prefix} value is unique to your account and environment. To learn how to retrieve your base URLs for the sandbox and production environments, see API endpoints.

post

https://{prefix}.api.checkout.com/payments/setups


1{
2  "amount": 1100,
3  "currency": "THB",
4  "reference": "ORD-5023-4E89",
5  "customer": {
6    "name": "Hannah Bret"
7  },
8  "order": {
9    "items": [
10      {
11        "name": "Wireless headphones",
12        "quantity": 1,
13        "unit_price": 1100
14      }
15    ]
16  },
17  "payment_methods": {
18    "truemoney": {
19      "terminal_type": "app",
20      "os_type": "ios"
21    }
22  },
23  "settings": {
24    "success_url": "https://example.com/payments/success",
25    "failure_url": "https://example.com/payments/failure"
26  }
27}

In the request body, provide the following:

Field Description

Field	Description
`amount` number	The payment amount, in the minor currency unit. Minimum: 1 Required
`currency` string	Three-letter ISO 4217 currency code. Supported value: `THB` Required
`customer.name` string	The customer's full name. Required
`order.items` array	The list of items in the order. Minimum items: 1 Required
`order.items[].name` string	The name of the item. Required
`order.items[].quantity` number	The quantity of the item. Minimum: 1 Required
`order.items[].unit_price` number	The unit price of the item. Minimum: 0 Required
`payment_methods.truemoney.os_type` string	The operating system of the customer's device. Required if `terminal_type` is `wap` or `app`. Supported values: `android` `ios`
`payment_methods.truemoney.terminal_type` string	Supported values: `web` `wap` `app` Required
`settings.failure_url` string	The URL to redirect the customer to if the payment fails. Format: URI Max length: 1024 Required
`settings.success_url` string	The URL to redirect the customer to if the payment is successful. Format: URI Max length: 1024 Required
`billing` object	The customer's billing details.
`billing.address` object	The customer's billing address. Required if `billing` is provided.
`billing.address.address_line1` string	The first line of the billing address. Required if `billing` is provided.
`billing.address.city` string	The city of the billing address. Required if `billing` is provided.
`billing.address.country` string	The country of the billing address. Required if `billing` is provided.
`description` string	A description of the payment. Max length: 100
`order.items[].reference` string	A reference for the item.
`reference` string	A reference you can use to identify the payment. Max length: 80

amount

number

The payment amount, in the minor currency unit.
Minimum: 1
Required

currency

string

Three-letter ISO 4217 currency code.
Supported value: THB
Required

customer.name

string

The customer's full name.
Required

order.items

array

The list of items in the order.
Minimum items: 1
Required

order.items[].name

string

The name of the item.
Required

order.items[].quantity

number

The quantity of the item.
Minimum: 1
Required

order.items[].unit_price

number

The unit price of the item.
Minimum: 0
Required

payment_methods.truemoney.os_type

string

The operating system of the customer's device.
Required if terminal_type is wap or app.
Supported values:

android
ios

payment_methods.truemoney.terminal_type

string

Supported values:

web
wap
app
Required

settings.failure_url

string

The URL to redirect the customer to if the payment fails.
Format: URI
Max length: 1024
Required

settings.success_url

string

The URL to redirect the customer to if the payment is successful.
Format: URI
Max length: 1024
Required

billing

object

The customer's billing details.

billing.address

object

The customer's billing address.
Required if billing is provided.

billing.address.address_line1

string

The first line of the billing address.
Required if billing is provided.

billing.address.city

string

The city of the billing address.
Required if billing is provided.

billing.address.country

string

The country of the billing address.
Required if billing is provided.

description

string

A description of the payment.
Max length: 100

order.items[].reference

string

A reference for the item.

reference

string

A reference you can use to identify the payment.
Max length: 80


1{
2  "id": "set_rcmepwrchqab2wsergcafvijfy",
3  "processing_channel_id": "pc_wzjki6hw5puepb5fnvqlizj2e4",
4  "amount": 1100,
5  "currency": "THB",
6  "payment_type": "Regular",
7  "reference": "ORD-5023-4E89",
8  "description": "TrueMoney payment",
9  "payment_methods": {
10    "truemoney": {
11      "status": "ready",
12      "flags": []
13    }
14  },
15  "available_payment_methods": [
16    "truemoney"
17  ],
18  "settings": {
19    "success_url": "https://example.com/payments/success",
20    "failure_url": "https://example.com/payments/failure"
21  }
22}

The response returns a payment_methods object, which contains the payment methods enabled on your account.

When all required fields are present, the payment_methods.truemoney object shows a ready status.

Checkout.com processes the payment when you confirm the payment setup. Confirm the payment by calling the Confirm a payment setup endpoint and provide:

The payment setup id as the {id} path parameter.
truemoney as the {payment_method_name} path parameter.

post

https://{prefix}.api.checkout.com/payments/setups/{id}/confirm/truemoney

If you receive a 202 Success response with a payment id and a status field set to Pending, your request was successful.


1{
2  "id": "pay_sxzrgliy2w3e5gpnby3chlswwq",
3  "status": "Pending",
4  "reference": "ORD-5023-4E89",
5  "customer": {
6    "id": "cus_2g4ehcpm6phexgkzahlwxvbgne",
7    "email": "hannah.bret@example.com",
8    "name": "Hannah Bret"
9  },
10  "_links": {
11    "self": {
12      "href": "https://{prefix}.api.checkout.com/payments/pay_sxzrgliy2w3e5gpnby3chlswwq"
13    },
14    "redirect": {
15      "href": "https://psp.ac.alipay.com/page/simulation-wallet/acwallet/alipayconnectcode.html?code=281666040095AHvh5AIKT0a3kv8X6Zzv3kiv&pspName=TRUEMONEY&loadMode=2"
16    }
17  }
18}

Redirect the customer to the redirect.href URL from the response. The customer completes the payment on the TrueMoney page and is then redirected back to your settings.success_url or settings.failure_url.

When accepting TrueMoney payments, you must display the Alipay+ and TrueMoney logos on your payment interface. To ensure that the logos meet Alipay brand guidelines, refer to their Brand display guidelines for online payments and Brand display guidelines for cashier payments.

TrueMoney for Payment Setup API

Create a payment setup

Information

Request example

Response example

Confirm the payment

Request example

Response example

Redirect the customer