WorldFirst DocsWorldFirst Docs

Query the budget accountSignature required

POST / amsin/api/v1/business/worldcard/queryBudgetAccountInfo

Call this API to query the budget account information.

Structure

A message consists of a header and body. For details, see the following sections.

Request header

Field

Required

Sample

Description

Client-Id

Yes

Client-Id: *****

For more information about these request header fields, see Request header.

Signature

Yes

Signature: algorithm=RSA256, keyVersion=2, signature=*****

Content-Type

Yes

Content-Type: application/json; charset=UTF-8

Request-Time

Yes

Request-Time: 2019-04-04T12:08:56+08:00

Connected-CustomerId

Conditional

Connected-CustomerId: *****

Attention

Required when a partner manages a customer's account.

Access-Token

Conditional

Access-Token: ******

Attention

Required for OAUTH authorization.


Request parameters

No request parameters.

Response parameters

result Result  REQUIRED

Indicates the result of the API call.

Show child parameters

availableAccountCount Integer  REQUIRED

The remaining number of budget accounts that can be created.

createdAccountCount Integer  REQUIRED

The number of budget accounts that have been created.

budgetAccountList Array<BudgetAccount>  REQUIRED

The details of the created budget accounts.

Show child parameters

contractStatus String  REQUIRED

The status of the budget account contract. Valid values:

  • ​NOT_SIGN​: The contract is not signed.
  • ​SIGNED​: The contract is signed.

contractInfoList Array<ContractInfo>  

The details of the budget account contract.

This parameter is only returned when contractStatus is ​NOT_SIGN​.

Show child parameters
API Explorer

Request

URL
Request Body

Response

Response Body

Result processing logic

After calling the API, a response is returned. The possible responses for result.resultStatus are:

Result status

Description

S

This indicates the API call succeeded.

F

This indicates the API call failed.

For more information on why the call failed, see result.resultCode tables.

U

This indicates the API call result is unknown. The partner can call this API again.

result.resultCode

CodeValueMessageFurther action
SUCCESSSSuccess
SYSTEM_ERRORFSystem error.

Do not retry, and contact our Technical Support Team for more details.

PARAM_ILLEGALFIllegal parameters exist. For example, a non-numeric input, or an invalid date.

Check and verify whether the request fields, including the header fields and body fields, are correct and valid.

For details on the fields of each API, see the specific API Structure section.

CONTRACT_NOT_EXISTFThe contract check has failed.

Contact our Technical Support Team to check the status of your API contract. Make sure it is still valid and try again.

USER_NOT_EXISTFThe user does not exist.

Retry with the correct user information.

ACCESS_TOKEN_EXPIREDFThe access token expired.

Refresh token to get a new access token or contact out Technical Support Team to address it.

AUTHORIZATION_NOT_EXISTFThe authorization does not exist.

Make sure that the input is correct. If the issue persists, contact our Technical Support Team to verify the authorization status.

SERVICE_NOT_ALLOWEDFService not allowed.

Retry with the correct information. If the issue persists, contact our Technical Support Team.