ST Pay Merchant APIST Pay Merchant API
Guide
API
Error codes
Back office
AI-assisted integration
  • 繁體中文
  • 简体中文
  • English
Guide
API
Error codes
Back office
AI-assisted integration
  • 繁體中文
  • 简体中文
  • English
  • Getting started

    • Overview
    • Request and response format
    • Authentication and IP whitelist
    • Signature
    • Merchant back office
    • AI-assisted integration
  • API

    • Create a collection order
    • Create a payout order
    • Order query
    • Callback notifications
  • Reference

    • Order status and amounts
    • Duplicate requests and confirming results
    • Error codes
    • Bank codes
    • Go-live checklist

Merchant back office

In addition to the API, ST Pay provides a merchant back office where you can query orders, reconcile your balance, and manage staff accounts. You cannot create orders or export data in the back office; orders are always created through the API.

Logging in

ItemDetails
URLProvided by your ST Pay integration contact (a different domain from the API). The test and production environments use different domains; the production domain is provided after you complete the integration in the test environment. Accounts in the two environments are separate.
CredentialsUsername, password, and a 4-digit image verification code. If you can't read the code, click the image to get a new one.
Source IPYou can log in only from IPs on the back office login whitelist that ST Pay sets up for you (a separate list from the API whitelist). If the whitelist is empty, nobody can log in. To add or change IPs, contact your ST Pay integration contact.
First accountST Pay creates your merchant supervisor account and delivers its initial password.
PasswordAt least 6 characters, including letters and digits, and different from the username. Initial and reset passwords must be changed at first login; this cannot be skipped, and nothing else is available until you change it. The new password must differ from the current one. Afterwards, use "Change password" in the account menu at the top right.
LockoutAfter 5 consecutive wrong passwords, the account is locked (wrong verification codes do not count; a wrong old password when changing your password also counts). Merchant staff are unlocked by the merchant supervisor; merchant supervisors should contact ST Pay.
Forgotten passwordThere is no self-service reset. Merchant staff passwords are reset by the merchant supervisor; merchant supervisors should contact ST Pay.
Automatic logoutAfter 30 minutes of inactivity, 12 hours after login, or immediately when the account is disabled or the source IP is no longer on the back-office login whitelist (removed, or you switched to an IP outside it).
LanguageSwitch between 繁體中文, 简体中文, and English at the top right.

If ST Pay disables your merchant, you can no longer create orders, but you can still log in to the back office and query orders through the API.

Roles and pages

PageMerchant supervisorMerchant staffContent
Order queryYesYesYour merchant's collection and payout orders
Balance ledgerYesNoCurrent available balance and every balance change
Staff accountsYesNoCreate and manage merchant staff accounts

The merchant supervisor can also turn off individual pages or the "Show full account number" permission for each staff member (see Staff accounts).

Order query

  • There are two tabs, "Collection orders" and "Payout orders". The newest orders come first, and up to the latest 500 orders are listed at a time.
  • Filter by status, creation time, order number (full), merchant order number, and channel type. Creation time defaults to today (00:00:00 to 23:59:59); you can change or clear it, and "Reset" returns it to today. The page does not refresh automatically; click "Refresh" or "Search".
  • Only orders within the retention period (6 months) are listed.
  • Status labels map to the API status as follows (see also Order status):
statusBack office label
pendingPending
successSuccess
rejectedRejected
late_creditedLate credited
paidPaid
  • Field names match the API: payable amount payable_amount, original amount amount, received amount received_amount, fee fee, settlement amount settlement_amount, payout amount amount, total deducted total_deducted.
  • The payer name is shown only in the back office; neither the query API nor the Callback returns it.
  • Account numbers are masked by default (only the last 4 digits are shown). For collection orders, double-click the receiving account to show the full number; only one is shown at a time, and ST Pay keeps a record. Payee account numbers of payout orders are always masked in the merchant back office.
  • Click "Details" to see the rejection reason and the Callback history: the time, result (success or failure), and trigger (automatic or manual) of each send. Failed deliveries are not retried automatically; contact ST Pay if you need a resend (see Callback).

Balance ledger

The current available balance is shown at the top. Below it, every balance change is listed from newest to oldest, up to the latest 1000 entries at a time; filter by time and entry type (time defaults to today). Ledger entries cannot be edited or deleted.

Entry typeWhen it is createdDirection
Collection creditA collection order is credited (success); the amount is the settlement amountIncrease
Late creditA collection order changes to late_credited; the amount is the settlement amount. No Callback is sent in this case, so use this to reconcileIncrease
Payout debitA payout order is paid out (paid); the amount is the total deductedDecrease
Manual increase, Manual decreaseST Pay adjusts the balance manually; the "Reason / Remark" column is ST Pay's explanationIncrease or decrease

Each entry shows the balance before and after, and the related order number, so you can reconcile it line by line with your own records.

Staff accounts

The merchant supervisor can manage merchant staff accounts of their own merchant:

ActionDetails
Create accountEnter a username and an initial password (same rules as above). The staff member must change the password at first login. Usernames may contain only letters, digits, and . _ -, must start with a letter or digit, and can be up to 64 characters.
DisableThe account can no longer log in, and any active session ends immediately. It cannot be set back to active.
UnlockUse this when a staff account is locked after 5 consecutive wrong passwords.
Reset passwordEnter a new initial password. The old password stops working immediately, and the staff member must change it at the next login.
PermissionsTurn off the "Order query" page or the "Show full account number" action for that staff member. Takes effect as soon as you save.

Merchant supervisor accounts are created, disabled, unlocked, and reset by ST Pay. For accounts created by ST Pay, the list shows "ST Pay" as the creator.

Prev
Signature
Next
AI-assisted integration