1. Interface Description
Interface request domain name: bill.api3.convergecloud.com.
Queries payment account information of a user. The NextDueDelay parameter is returned only if SubAcctid=CREDIT_FIXED.
Default interface request rate limit: 20 times per second.
Interface update time: 2020-09-04 20:40:45.
The interface is both signature verification and authentication.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: DescribeUserAccountGateway |
| Version | Yes | No | String | Public parameter, The value of this interface: 2018-10-25 |
| Region | No | No | String | Public parameter,Regional information This interface does not need to pass this parameter. |
| AcctId | Yes | No | String | The unique identifier of the account. Example: 1001 |
| SubAcctid | Yes | No | String | The identifier of the credit-fixed sub-account. CREDIT_FIXED Example: CREDIT_FIXED |
| Device | Yes | No | Int64 | The type of the device that sends the request. 0: PC. 1: mobile phone. Example: 1 |
| Ts | Yes | No | Int64 | The UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC. Example: 1730702488 |
| MemberUin | No | No | String | Member account UIN Example: 1000102441223 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| Status | String | The status of the account. 0: non-opened or closed. 1: in use. Other values indicate that the account is in an abnormal state. You can know the status of the account based on the value of this parameter. Example: 1 |
| Balance | String | The account balance available for postpaid products, including cash balance. Example: 4000000 |
| AllIn | String | The total payment amount. Example: 0 |
| AllOut | String | The total paid amount. Example: 26177810000000 |
| Exptime | String | The expiration time. If the service use the pay-as-you-go billing method, the value of this parameter is 0. Otherwise, a UNIX timestamp is returned. Example: 0 |
| ExpireinfoExtend | String | The expired order. Example: "" |
| Dplimit | String | The total credit amount. Example: 4000000 |
| Dpbalance | String | The remaining available amount, including cash. Example: 4000000 |
| Debt | String | The used credit amount, including transferred amount and pre-authorized amount. Example: 26177810000000 |
| Cash | String | The balance of the account, including cash balance and credit amount, that can be used to pay bills. Example: 4000000 |
| BillingDate | String | The statement closing date. Valid values: 1 - 28. Indicates the day of a month on which bills are generated. Example: 12 |
| DueDate | String | The payment due date. Valid values: 1 - 28. Indicates the day of a month is due date for payment. Example: 12 |
| MerchantType | String | The merchant type. 1: agent. 2: sub-customer 3: direct customer Example: 1 |
| RelatedMerchant | String | The related merchant. If the value of the MerchantType parameter is 1 or 3, the value of this parameter is empty. If the value of the MerchantType parameter is 2, the value of this parameter is the information about the agent. Example: "" |
| DueDelayType | String | The unit of the payment delay period.1: months. 2: days. Example: 1 |
| DueDelay | String | The payment delay period. If the value of the DueDelayType parameter is 1, the value of this parameter indicates the corresponding number of months. If the DueDelayType parameter is 2, the value of this parameter indicates the corresponding number of days. Example: 1 |
| NextDueDelay | String | The new payment delay period that will take effect on the next statement closing date. Example: "" |
| RecoverImmediately | String | Indicate whether to restore the credit amount if bills are not paid off till the payment due date. 0: The system does not restore the credit amount. 1: The system restores the credit amount. Default value: 0. Example: 1 |
| RefundSequence | String | Indicates whether to repay bills in sequence. 0: sequenced. 1: non-sequenced. Default value: 0. Example: 1 |
| CashRecoverImmediately | String | Indicates whether to restore the credit amount immediately after bills are prepaid before the statement closing date. 0: The system does not immediately restore the credit amount. 1: The system immediately restores the credit amount. Default value: 0. Example: 1 |
| BillingCycleType | String | The billing cycle type. 1: monthly. The value is 1. Example: 1 |
| BillingCycle | String | The billing cycle. Unit: months. Example: 1 |
| DayOut | String | The total payment amount of the current day. Example: 500 |
| SubDplimit | String | The level-2 credit amount. If this field is not specified, the returned value is -1. Example: -1 |
| UsableLimit | Uint64 | The available credit amount. Example: 90000000 |
| Fixedlimit | String | The total credit amount. Example: 99999999900000000 |
| CashBalance | Uint64 | The cash balance. Example: 0 |
| UsedLimit | Uint64 | The used credit amount. Example: 4000000 |
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| FailedOperation | Operation failed. |
| InvalidParameter | Parameter error. |