inquiryRaDetailSignature required

2022-04-29 12:00

POST /aps/api/business/wf/inquiryRaDetail

The Partner can use the inquiryRaDetail interface to retrieve information about the Customer's Receiving Account.

Before calling the API, the Partner needs to redirect the Customer to an authorization page and open a Receiving Account with WorldFirst. For more details about the Customer onboarding process and the prerequisites to use this API, refer to the steps provided in the Complete Customer onboarding process chapter.
After the Customer completes the customer onboarding process and creates a Receiving Account with WorldFirst, the Partner can use this interface to inquire relevant information about the Customer's Receiving Account, which includes the account number of the Customer's wallet, the currency of the account, etc.

Structure

A message consists of a header and body. The following sections are focused on the body structure. For the header structure, see:

The unique ID that is assigned by the Partner to identify a Customer.

More information:

3-character ISO 4217 currency code that represents the prefunding currency.

Note: This field is required when the Partner needs to query the Receiving Account balance in a particular currency.

More information:

Indicates whether this API is called successfully.

Show child parameters

Indicates whether this API is called successfully.

Show child parameters

Information about the user.

Show child parameters

API Explorer

URL

Program Language

JSON

Request Body

Case

No additional information

Response Body

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

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.
U: This indicates the API call result is unknown. Partner can make a query when the returned status is UNKNOWN. Use the following query strategy:

Code	Value	Message	Further action
SUCCESS	S	Success
PROCESS_FAIL	F	A general business failure occurred. Do not retry.	Human intervention is usually needed. It is recommended that you contact WorldFirst Technical Support to resolve the issue.
PARAM_ILLEGAL	F	Illegal 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.
UNKNOWN_EXCEPTION	U	The API call is failed, which is caused by unknown reasons.	The service might be down, retry later. If the issue persists, contact WorldFirst Technical Support.
REQUEST_TRAFFIC_EXCEED_LIMIT	U	Call the interface again to resolve the issue. If not resolved, contact Alipay Technical Support.	Call the interface again to resolve the issue. If not resolved, contact Alipay Technical Support.
INVALID_API	F	The called API is invalid or not active.	Check whether the correct API is being called.
INVALID_CLIENT	F	The client is invalid.	The Client ID does not exist or is invalid.
INVALID_SIGNATURE	F	The signature is invalid.	Make sure the request is properly signed with a valid signature. For more details, refer to the following chapter: The signature field in a request header. How to calculate a signature.
METHOD_NOT_SUPPORTED	F	The server does not implement the requested HTTP method.	Ensure the HTTP method is `POST`.

Code	Value	Message	Further action
REPEAT_REQ_INCONSISTENT	F	Repeated requests are inconsistent.	Ensure all the fields in the requests are the same and retry.
MEDIA_TYPE_NOT_ACCEPTABLE	F	The server does not implement the media type that is acceptable to the client.	Retry with the correct media type.
PARTNER_INFO_NOT_EXIST	F	Biz partner info is not exist.	Retry with the correct information of the Partner.
SYSTEM_ERROR	F	Alipay system error.	Do not retry, and contact Alipay Technical Support for more details.