Essential APIs

tradePay

Collect wallet payments by redirecting the user to the hosted wallet cashier.

Overview

my.tradePay is part of the Cashier Payment flow used to collect wallet payments.

my.tradePay launches the wallet cashier so the user can confirm and complete a payment. Pass the cashier paymentUrl you obtained from the pay API response — specifically the redirectActionForm.redirectionUrl field. On completion, the API returns a status code indicating whether the payment succeeded, failed, or is still processing.

Usage Example

my.tradePay({
  paymentUrl: 'https://wallet.example.com/cashier?orderId=xxxxxxx',
  success: (res) => {
    my.alert({
      content: JSON.stringify(res)
    });
  },
  fail: (err) => {
    my.alert({
      content: JSON.stringify(err)
    });
  }
});

Parameters

Property	Type	Required	Description
`paymentUrl`	`string`	No	The redirect URL of the cashier page, obtained from the `pay` response field `redirectActionForm.redirectionUrl`. See Cashier payment flow for how to obtain it.
`success`	`Function`	No	Callback executed when the API call succeeds. Provides the payload defined in Callback payload.
`fail`	`Function`	No	Callback executed when the API call fails.
`complete`	`Function`	No	Callback executed after success or failure.

The pay API returns the cashier URL as redirectActionForm.redirectionUrl. Pass that exact value as tradePay's paymentUrl to route the user to the correct cashier.

Callback Payload

Property	Type	Required	Description
`resultCode`	`string`	Yes	Result code representing the payment outcome. See Result codes.

Success Example

{
  "resultCode": "9000"
}

Result Codes

`resultCode`	Description
`9000`	Payment successful.
`8000`	Payment processing; final status pending.
`4000`	Payment failed.
`6001`	User cancelled the payment.
`6002`	Network exception occurred.
`6004`	Unknown payment result; retry status query.

qicardSignContract

Direct users to authorize and sign a QiCard agreement for recurring payments.

getDeviceInfo

Retrieve device information and the current user's role (customer or business) to build apps for different user types.