Create External Account

post

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

Create one or multiple external accounts for a customer or program manager.

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 ID or 'externalId' for the program manager-assigned ID.

Allowed:

customerId

string

required

The customer identifier value, corresponding to the selected parentIdType.

Body Params

Details required to create an external account.

accountNumber

string

required

The bank account number.

holderName

string

required

Name of the bank account holder as it appears on bank records.

holderType

string

enum

required

Holder type of the account.

Allowed:

routingNumber

string

required

9-digit routing number used for ACH transactions.

type

string

enum

required

Type of the account.

Allowed:

externalId

string

Reference ID assigned by the program manager.

comment

string

Comment passed by the user.

holderPhone

number

Phone number of the bank account holder.

holderAddress

object

Address of the bank account holder.

purpose

string

Purpose of adding the external account.

wireRoutingNumber

string

9-digit routing number used for Wire transactions.

linkedDocument

array of objects

Authorization documents linked to the external account. Allowed extensions: pdf, jpg, bmp, txt, tiff, rtf, doc, docx, xls, csv, wav, jpeg, png, xlsx, efx.

linkedDocument

tags

metaData

object

Custom key-value metadata for the external account.

validateAccount

array of objects

Validate the account details using a validation method. Only program manager-enabled validations can be passed.

validateAccount

prenote

string

enum

Validate the account details using prenote.

Allowed:

microDeposit

string

enum

Validate the account details using micro deposit.

Allowed:

Headers

PromiseMode

string

enum

required

Controls response timing. NEVER returns an immediate response; ALWAYS defers processing.

Allowed:

Responses

202

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

299

The external account was created 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

The request lacks valid authentication credentials. Verify the API key and authorization header.

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 external account has been created successfully.