Sign in
multi-currency-account

Retrieve multi currency account eligibility

Checks eligibility for a multi-currency account for either a specific profile or for a location. Customers in some countries and states/provinces may not be eligible for a multi currency account.

To check a profile, pass the profileId as a query parameter.

To check a specific location, pass the country using 2-letter ISO 3166 codes. If the country is US, a valid 2-letter state parameter must also be passed.

  • Example (France): /v4/multi-currency-account/eligibility?country=FR
  • Example (USA, California): /v4/multi-currency-account/eligibility?country=US&state=CA
get/v4/multi-currency-account/eligibility

Query parameters

profileIdinteger

Profile ID to check eligibility for.

countrystring

2-letter ISO 3166 country code to check eligibility for.

statestring

2-letter state/province code. Required when country is US.

Headers

X-External-Correlation-Idstring uuid

Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more.

Response

Eligibility result.

eligibleboolean

Whether the profile is eligible for a multi currency account.

eligibilityCode'eligible' | 'invalid.profile.type' | 'invalid.country' | 'invalid.state'

Eligibility status code.

accountType'FULL' | 'RECEIVE_ONLY' | 'INELIGIBLE'

Account type available.

ineligibilityReasonstring nullable

Reason the profile is not eligible.

Example response

{
  "eligible": true,
  "eligibilityCode": "eligible",
  "accountType": "FULL"
}

Changes

No recorded changes to this endpoint across all 5 revisions of this API.