PayDeals

Last updated: 2025-11-13 20:46:15

PayDeals

Last updated: 2025-11-13 20:46:15

1. API Description

Domain name for API request: billing.intl.tencentcloudapi.com.

This API is used to pay for an order.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: PayDeals.
Version	Yes	String	Common Params. The value used for this API: 2018-07-09.
Region	No	String	Common Params. This parameter is not required for this API.
OrderIds.N	No	Array of String	Specifies one or more Sub-order No. that need to pay. must pass either this parameter or the BigDealIds field, but not both.
AutoVoucher	No	Integer	Whether to automatically use a voucher. valid values: 1 (yes), 0 (no). default: 0.
VoucherIds.N	No	Array of String	Voucher ID list. currently only supports specifying one voucher.
BigDealIds.N	No	Array of String	Specifies one or more Order No. that need to pay. must pass either this parameter or the OrderIds field.
AgentPay	No	Integer	0 self pay, 3 group agent, 4 reseller places a product-level payment order for customers. default 0.
CpsUin	No	String	Disregard it.

3. Output Parameters

Parameter Name	Type	Description
OrderIds	Array of String	Specifies the array of Sub-order No. with payment successful.
ResourceIds	Array of String	Specifies the Id array of resources with payment successful.
BigDealIds	Array of String	Specifies the array of Order No. with payment successful.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Payment Order Example

Input Example

https://billing.intl.tencentcloudapi.com/?Action=PayDeals
&OrderIds.0=2020111161300016142141
&AutoVoucher=1
&<Common request parameters>

Output Example

{
    "Response": {
        "OrderIds": [
            "2020111161300016142141"
        ],
        "BigDealIds": [
            "2020111161300016142108"
        ],
        "ResourceIds": [
            "ins-abc",
            "ins-xxx"
        ],
        "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
FailedOperation	Operation failed.
FailedOperation.AgentPayDealCannotDown	The proxy payment device cannot be downgraded.
FailedOperation.BalanceInsufficient	The account balance is insufficient.
FailedOperation.InvalidDeal	Order status error. Only unpaid orders support payment.
FailedOperation.InvalidVoucher	Vouchers are not available.
FailedOperation.NeedPayTogeter	Orders purchased together must be paid simultaneously.
FailedOperation.NeedPayTogether	Package orders must be purchased together.
FailedOperation.PayPriceError	Payment failed. Please contact Tencent Cloud to resolve this issue.
FailedOperation.PaySuccDeliverFailed	Payment succeeded but shipment failed. Please contact the cloud platform staff for handling.
InvalidParameter	Invalid parameter.
InvalidParameterValue	Invalid parameter value.
UnauthorizedOperation.CamNoAuth	The account does not have CAM permission.
UnauthorizedOperation.CertificationNeedUpgrade	Due to account security upgrade, purchase cloud resources requires complete real-name information.
UnauthorizedOperation.NotCertification	The account has not been real-name authenticated, and payment failed.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud