API Reference
  1. Treasury Solutions
  2. International External Account

Update International External Account

post
https://sandbox-api.prioritycommerce.com/v1/passport/v1/customer///internationalExternalAccount//

Update editable fields of an international external account. Updates are restricted if the account is linked to any transaction in Scheduled, Pending, or Processing status. For non-USD accounts, only a limited set of fields can be updated.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
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:
string
required

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

string
enum
required

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

Allowed:
string
required

Unique identifier of the international external account. The value corresponds to the identifier type specified in idType.

Body Params

Details required to update an international external account.

string

Reference id assigned by the program manager. Conditional, once specified cannot be updated. Additionally, cannot add or update for non-USD international external accounts.

string

Comment passed by the user. Condiitonal, cannot update for non-USD international external accounts.

string

The bank account number. Only letters (uppercase and lowercase), numbers, and specific symbols: *:#-/&,+’. Conditional, only in INACTIVE status. Additionally, cannot update for non-USD international external accounts.

string
enum

Holder Type of the account. Conditional, only in INACTIVE status. Additionally, cannot update for non-USD international external accounts.

Allowed:
string

Purpose of adding International External account. Condiitonal, cannot update for non-USD international external accounts.

string
enum

Type of the account. Conditional, only in INACTIVE status. Additionally, cannot update for non-USD international external accounts.

Allowed:
string

Name of the bank account holder as it appears on the bank records. All printable ASCII characters are allowed other than Tilde ~ and pipe. Conditional, cannot update for non-USD international external accounts.

string

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

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.

string

The bank account number. Supports alphanumeric values. Conditional, only in INACTIVE status. Additionally, cannot update for non-USD international external accounts.

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
    • Conditional, only in INACTIVE status. Additionally, cannot update for non-USD international external accounts.

acceptedCurrency
array of strings

Accepted currencies for the international external account. Condiitonal, cannot update for non-USD international external accounts.

acceptedCurrency
holderAddress
object

Address details of the account holder. Conditional, cannot update for non-USD international external accounts.

Headers
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.

Updated 2 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago

Did this page help you?