WorldFirst DocsWorldFirst DocsDOCS

cardElementInquiry

POST: /aps/api/business/card/element/inquiry

Signature required

Before launching a transfer request, it is the best practice to inquire about a sample bank card, with applicable rules for every element of the bank card. Partner can double-check the submitted customer bank card information with the template and rules provided.

Use the cardElementInquiry interface to query information about card elements. WorldFirst(Alipay) responds to the partner with the necessary information of sample card elements, together with rules for each element.

Structure

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

Request parameters

Field

Data type

Required

Description

toRegion

String

Yes

2-character ISO-3166 country code that represents the country/region the card is assigned to. For example, US, CN.

More information:

  • Maximum length: 2 characters

currency

String

Yes

3-character ISO-4217 currency code of the currency that the card uses. For example, USD, CNY.

More information:

  • Maximum length: 3 characters

Response parameters

Field

Data type

Required

Description

cardDataCfgInfoList

List<CardDataCfgInfo object>

Yes

A list of information about the card data.

Result codes

result.resultCode

resultCode

resultStatus

resultMessage

SUCCESS

S

Success

PROCESS_FAIL

F

A general business failure occurred. Do not retry.

PARAM_ILLEGAL

F

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

UNKNOWN_EXCEPTION

U

The API call is failed, which is caused by unknown reasons.

Samples

Request

copy
{
    "toRegion":"HK",
    "currency":"EUR"
}

Response

copy
{
    "cardDataCfgInfoList": [
        {
            "cardColumnCode": "bankAccountNo",
            "cardColumnName": "收款人账户号(长号)",
            "cardColumnValueRule": "^[A-Z0-9]{0,34}$",
            "required": "Y"
        },
        {
            "cardColumnCode": "bankCountryCode",
            "cardColumnName": "收款行国家",
            "cardColumnValueRule": "^[A-Z]{2}$",
            "required": "Y"
        },
        {
            "cardColumnCode": "bankAccountName",
            "cardColumnName": "收款人账户姓名(英文)",
            "cardColumnValueRule": "^(?!.*\\s{2,})[A-Za-z0-9_\\-,()\\s.,]{0,70}$",
            "required": "Y"
        },
        {
            "cardColumnCode": "bankBIC",
            "cardColumnName": "收款行银行识别码(BIC)(即SWIFT号)",
            "cardColumnValueRule": "^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}$",
            "required": "Y"
        },
        {
            "cardColumnCode": "bankName",
            "cardColumnName": "收款行银行名称",
            "cardColumnValueRule": "^.{0,35}$",
            "required": "Y"
        }
    ],
    "result": {
        "resultCode": "SUCCESS",
        "resultMessage": "success",
        "resultStatus": "S"
    }
}

@2024 WorldFirst