consult (Cashier Payment)

Use the consult API to initiate a payment consultation request to Alipay. This request is returned to the merchant with information on the different payment methods and its corresponding amount, country, currency, rules, and configuration.

byAlipay Global Merchant Portal

100+calls

N/Alatency

Updated: Oct 27, 2026, 12:40 AM

Continue setup in your AI

Only public catalog IDs and a safe return path are handed to the Plugins page. This does not run the tool or confirm current availability, authorization, price, limits, or upstream status; those conditions are checked again before execution.

Selected tool: alipay_api.payments.consult.create.v1.0f644cda
Provider scope: Alipay Global Merchant Portal
Catalog updated: 2026-10-27T00:40:01.989419+00:00
Business task: Pending verification

Continue setupYou can return to this tool page if the selection is incomplete or expires.

Run on this page: Execute is the in-site test path. Continue setup is for adding the public selection to an external AI; the two paths are tracked and validated separately.

Discover -> Inspect -> Call

Call setup

Tool IDalipay_api.payments.consult.create.v1.0f644cda

Request parametersJSON

Before this Call

1 credit / call

The final charge is settled from actual provider usage and will appear in Usage.

Field reference

envobjectRequired

Information about the environment where the order is placed, such as the device information.

userRegionstringOptional

The 2-letter country or region code. For more information, see ISO 3166 Country Codes standard. The payment methods will be sorted based on payment method relevance for the given user's region. Maximum length: 2 characters

productCodestringRequired

Represents the payment product that is being used. The payment product that can be used is stipulated in the contract. The fixed value is CASHIER_PAYMENT: Indicates that this API is used for the Cashier Payment scenario. Maximum length: 3 characters

paymentAmountstringRequired

The payment amount that the merchant requests to receive in the order currency.

merchantRegionstringOptional

The country or region where the merchant operates the business. The parameter is a 2-letter country or region code that follows ISO 3166 Country Codes standard. Some possible values are US, SG, HK, PK, JP, CN, BR, AU, and MY. This parameter is required when you use the Global Acquirer Gateway (GAGW) product. Maximum length: 2 characters

settlementStrategyobjectOptional

The settlement strategy.

allowedPaymentMethodRegionsarrayOptional

A list of region codes that represent the countries or regions of payment methods. The value of this parameter is a 2-letter ISO country code or GLOBAL. Specify this parameter if you want available payment methods from specific regions to be returned. For example, if you pass in GLOBAL, global cards Visa and Mastercard are returned. Maximum length: 6 characters

consult (Cashier Payment)

100+calls

N/Alatency

Updated: Oct 27, 2026, 12:40 AM

Continue setup in your AI

Selected tool

alipay_api.payments.consult.create.v1.0f644cda

Provider scope

Alipay Global Merchant Portal

Catalog updated

2026-10-27T00:40:01.989419+00:00

Business task

Pending verification

Continue setupYou can return to this tool page if the selection is incomplete or expires.