Create International External Account

post

https://sandbox-api.prioritycommerce.com/v1/passport/v1/customer/{parentIdType}/{customerId}/internationalExternalAccount

Create one or more international external accounts for a customer. Supports both USD and non-USD destinations; non-USD destinations may require additional fields (such as internationalRoutingCode and country-specific additionalDetail) which can be discovered via the List Meta Data endpoint.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

parentIdType

string

enum

required

Identifier type for the customer. Use id for the Passport-assigned reference ID or externalId for the program manager-assigned identifier.

Allowed:

customerId

string

required

Unique identifier of the customer. The value corresponds to the identifier type specified in parentIdType.

Body Params

Details required to create an international external account.

externalId

string

Reference id assigned by the program manager.

comment

string

Comment passed by the user.

accountNumber

string

required

The bank account number. Only letters (uppercase and lowercase), numbers, and specific symbols: *:#-/&,+’.

holderType

string

enum

required

Holder Type of the account.

Allowed:

purpose

string

This field helps meet cross-border compliance requirements and is shared with partner banks to facilitate secure and compliant processing of the wire transaction.

type

string

enum

required

Type of the account.

Allowed:

holderName

string

required

Name of the bank account holder as it appears on the bank records. All printable ASCII characters are allowed other than Tilde ~ and pipe.

holderEmail

string

The account holder’s email address. Validation: Format: [email protected]

holderPhone

number

Phone number of the bank account holder.

additionalDetail

object

Additional information required for non-USD International External Accounts. The key values are dynamic fields that vary based on the holder’s country validations.
Possible Value: taxID
The validations accepted around “taxID” can also vary based on the destination country.
For example, “taxID” value can be:

ARCTX for Argetina
CTID for Canada
INN Tax Authority for Russia.

Since the key values and their validations may vary based on the destination country & currency, please use the “Meta Data API” referred in Section 4.6.6, to fetch appropriate key values and validations.

swiftCode

string

required

The bank account number. Supports alphanumeric values.

internationalRoutingCode

string

Provide the international routing code if the account belongs to any one of the following countries:

Australia - 6 Characters
India - 11 Characters
Canada - 9 Characters
United Kingdom - 6 Characters
New Zealand - 6 Characters
Hong Kong - 3 Characters
Poland - 8 Characters

acceptedCurrency

array of strings

required

Accepted currencies for the international external account.

acceptedCurrency*

holderAddress

object

required

Address details of the account holder.

Headers

PromiseMode

string

enum

required

Controls response timing. NEVER returns an immediate response; ALWAYS defers processing and returns a 202 Accepted while the operation completes asynchronously.

Allowed:

Responses

202

The request has been accepted for processing. Expected when PromiseMode is ALWAYS.

299

The operation completed successfully, but the action may impact transacting. Check the warning details.

400

The request could not be processed due to invalid or missing parameters.

401

Authentication failed. Verify that the Authorization header contains a valid Bearer token.

403

The authenticated user does not have permission to perform this operation.

500

An unexpected error occurred on the Passport server while processing the request.

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201The international external account has been created successfully.