August changes the request and response shape of both Thai Baht methods, adds MWK and TZS to the v2 API and Payment Gateway 3, introduces failure redirects, and ships two new v2 endpoints.
This site replaced the previous Hello Clever documentation this month and is now available in Japanese through the language switcher. Legacy pages remain at legacy-docs.helloclever.co, and common legacy URLs redirect to their new location.

Breaking changes

Thai Baht QR Pay Payins (th_qrpay_thb)

The payin_method_params for th_qrpay_thb have been replaced with a new set of mandatory fields. The pay_code object in the Payin response has also changed. payment_url is no longer returned. Render the QR from qr_string, or show the bank details for a manual transfer:
pay_code (new)
Action required: update your request builder, and replace any redirect to pay_code.payment_url with a QR render of pay_code.qr_string.

Thai Baht bank transfer payouts (th_bank_thb)

The payout_method_params for th_bank_thb now identify the recipient bank by SWIFT code instead of bank code. account_number and description are still mandatory. Amount limits are unchanged at 300 to 2,000,000 THB. Action required: map your stored bank codes to SWIFT codes and add account_name and type to every th_bank_thb payout. Docs: v2 Payin guide · Get Payout Required Fields

Merchant Portal

API

Get Balance History V2

GET /v2/balances/history returns every movement on your balance over a date range: payments, payouts, settlements, refunds, top-ups, withdrawals, disputes, dispute fees, cashback payouts, and transfers in and out. Each record carries id (Balance ID), amount (net), request_type (money_in or money_out), transaction_type, status (waiting, done, or failed), reference_id, and a balance_detail breakdown of outgoing, fees, and total. The envelope returns account_type (aggregated or dedicated), next_cursor, and has_more. Docs: Get Balance History V2

Resend Contact Verification

POST /v2/contacts/resend_verification re-sends the identity verification link to an existing contact. Use it when the original link expired or was not received.
resend_to is email or phone (SMS to the contact’s registered number). The contact must already exist on your account. Docs: Resend Contact Verification

MWK and TZS payment methods

The supported MWK mobile money networks are listed in Create a Payin. Docs: v2 introduction · Get Payin Methods

Failure redirects (failure_callback_url)

Redirect-based v2 Payin methods, such as kh_pay_khr and us_pay_usd, accept failure_callback_url in payin_method_params alongside callback_url. The customer is sent there after a failed payment.
For kh_pay_khr and us_pay_usd, never use query parameters on either redirect to set payment status. Final status comes only from webhooks.
Docs: Create a Payin

PayID metadata

Create One-Time PayID (POST /v1/merchants/create_payment) accepts an optional metadata object of arbitrary key-value pairs, for your own reference data. It is returned on the PayID object in the response and in the status-change callback.

Simulate Deposit (sandbox)

POST /v1/simulate_deposit credits a simulated inbound bank transfer to a Treasury Account in sandbox, updating its Incoming and Available balances. Required: account_number, amount (whole yen for JPY). Optional: remitter_name, remitter_bank_name, remitter_branch_name, remarks. For JPY, send remitter fields in half-width katakana to match Zengin formatting. Docs: Simulate Deposit

API reference updates

  • Sidebar regrouped into v1 (AUD), v2 (Multi-Currency), Card, Cashback, and Reporting.
  • Webhooks aligned with the legacy documentation.

Reporting

No changes this month.

Payment Gateway

Failure redirect on Payment Gateway 3

Payment Gateway 3 now accepts an optional failure URL next to success in redirect_url, used when a payment fails, is declined, or expires. Without it, the customer stays on the Hello Clever checkout page with no route back to your checkout. The hc_payment_event message posted to your page carries redirect_url.failure when page_state is failed:

MWK and TZS on Payment Gateway 3

MWK bank transfer (mw_bank_mwk, minimum 2,000 MWK) and TZS bank transfer are available on Payment Gateway 3.

Hosted checkout guide

The new Multi-Currency hosted checkout guide shows what customers see on the hosted page for card, bank transfer, QR, and mobile money flows, so you can support them when they get stuck. Docs: Payment Gateway 3