List Meta Data for International External Accounts

post

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

Retrieve the dynamic field set and validation rules required to create an international external account for a given country, currency, and holder type. The metadata is sourced from a third-party service and is required to construct compliant non-USD account requests.

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

Holder type, destination country, and currency for which metadata is required.

holderType

string

enum

required

Holder Type of the account.

Allowed:

country

string

required

Country to which the funds are to be transferred. Length of input allowed is 2 characters only. For example, US for United States.

currency

string

required

Currency for which meta data is required. The list of accepted values is given in Appendix – Section.

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

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

200Request completed successfully.