WorldFirst DocsWorldFirst DocsDOCS

Retrieve a beneficiary templateSignature required

POST /amsin/api/v1/business/account/inquiryBeneficiaryTemplate

Before initializing a transfer, the Partner needs to create a beneficiary who is on the receiving end of the transfer.

To create a beneficiary, the Partner can use this API to obtain a beneficiary template.

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

countryCode String  REQUIRED

2-character ISO 3166 country/region code that represents the country/region where the bank locates.

More information about this field

  • Maximum length: 2 characters

currency String  REQUIRED

3-character ISO 4217 currency code that represents the currency used. Currently, the following currencies are supported:

USD,EUR,GBP,NZD,CAD,AUD,JPY,SGD,HKD,CNH

Response parameters

result Result object REQUIRED

Indicates whether this API is called successfully.

Show child parameters

responseId String  REQUIRED

The unique ID that is assigned by WorldFirst to identify a response.

More information about this field

  • Maximum length: 32 characters

cardTemplateData Array<CardTemplateField> object REQUIRED

General template for the beneficiary's bank account.

Show child parameters

localCardTemplateData Array<CardTemplateField> object 

Local template containing bank account fields required for the local clearing network.  

Show child parameters

crossBorderCardTemplateData Array<CardTemplateField> object 

Cross-border template containing bank account fields required for the cross-border clearing network.  

Show child parameters
API Explorer

Request

URL
Case
DE-EUR
Request Body

Response

Case
DE-EUR
Case description
Beneficiary template for DE-EUR
Response Body

Result processing logic

Result of the API call

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.

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:

  • A Partner can make 7 queries at maximum.
  • Intervals between queries: 5m, 10m, 20m, 40m, 80m, 160m, and 320m.

If none of the queries is successful, contact WorldFirst Technical Support.

Different types of templates

WorldFirst provides template information about the beneficiary in one or more of the following fields:

  • cardTemplateData indicates a general template, containing all related fields of the beneficiary's bank account information.
  • localCardTemplateData indicates a local template, containing bank account fields required for the local clearing network.
  • crossBorderCardTemplateData indicates a cross-border template, containing bank account fields required for the cross-border clearing network.

If more than one templates are returned in the response, all templates are applicable for the requested situation. In most cases, localCardTemplateData and crossBorderCardTemplateData provide more optimized templates with less required fields. Partner can use any one of the returned templates for beneficiary binding. Contact WorldFirst Technical Support if you have further questions.

Card template field list

This table is for reference only. Please refer to the template(s) returned in the response for applicable fields under different circumstances.

fieldName

fieldDescription

restrictionType

bankAccountName

Account name

PATTERN_RESTRICTION

bankAccountNo

Account number

PATTERN_RESTRICTION

bankName

Bank name

PATTERN_RESTRICTION

bankBIC

Bank BIC/SWIFT

PATTERN_RESTRICTION

bankAccountIBAN

IBAN

PATTERN_RESTRICTION

routingNumber

Routing Number

PATTERN_RESTRICTION

beneficiaryAddress

Beneficiary address

PATTERN_RESTRICTION

beneficiaryCountryCode

Beneficiary country code

PATTERN_RESTRICTION

beneficiaryPhone

Beneficiary phone

PATTERN_RESTRICTION

bankBranchCode

Bank branch code

PATTERN_RESTRICTION

bankAccountLocalName

Account name (in local language)

PATTERN_RESTRICTION

System-realted result codes

CodeValueMessageFurther action
SUCCESSSSuccess
PROCESS_FAILFA general business failure occurred. Do not retry.

Human intervention is usually needed. It is recommended that you contact our Technical Support Team to resolve the issue.

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.

UNKNOWN_EXCEPTIONUAPI failed due to unknown reason.

The service might be down, retry later. If the issue persists, contact our Technical Support Team.

REQUEST_TRAFFIC_EXCEED_LIMITUThe request traffic exceeds the limit.

Call the interface again to resolve the issue. If the issue persists, contact our Technical Support Team.

OAUTH_FAILFOAuth process failed.

Contact our Technical Support Team for detailed reasons.

INVALID_APIFThe called API is invalid or not active.

Check whether the correct API is being called.

INVALID_CLIENTFThe client is invalid.

The Client ID does not exist or is invalid.

INVALID_SIGNATUREFThe signature is invalid.

Make sure the request is properly signed with a valid signature.

METHOD_NOT_SUPPORTEDFThe server does not implement the requested HTTP method.

Ensure the HTTP method is POST.

Business-related result codes

CodeValueMessageFurther action
UN_SUPPORT_BUSINESSFUnsupported business.

Invalid parameters are used e.g. currency is incorrect. Retry with the correct information.

SYSTEM_ERRORFSystem error.

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

USER_NOT_EXISTFThe user does not exist.

Retry with the correct user information.

CARD_TEMPLATE_NOT_EXISTFNo card templates met the query conditions.

Adjust the query and retry.
 

@2024 WorldFirst