Create a new account

post

https://sandbox-api.prioritycommerce.com/v1/passport/v1/customer/{parentIdType}/{id}/account

Create one or multiple FDIC-insured accounts for a customer. Accounts are used to collect, manage, store, and move funds within the Passport platform.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

parentIdType

string

enum

required

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

Allowed:

string

required

The customer's Passport-assigned ID or program manager-assigned external ID, based on the selected parentIdType.

Body Params

Account details including program association and initial configuration.

type

string

enum

The type of account to be created.

Allowed:

isCustomerOwned

boolean

If true, then customers have full control over fund movement. If false, then account is owned by program manager but in the name of customer for money movement.

purpose

string

Purpose for the account. Purposes are configurable and can be defined at the time of program manager's setup by sharing details with Passport team.

externalId

string

Assign an external reference to your account.

configuration

object

linkedDocument

array of objects

Document linked to the account. SPAA can be linked to account using purpose as AUTHORIZATION.

linkedDocument

acceptanceMode

string

enum

The mode of acceptance of documents.

Allowed:

acceptanceDetails

object

Details relating to the agreement acceptance.

debitCardissuance

object

Configuration for issuing debit cards for the account.

virtualCardissuance

object

Configuration for issuing virtual cards for the account.

nickName

string

Assign a nick name to the account.

isPrimary

boolean

Set one of your passport accounts as a primary account. By default, the customer’s first passport account will be set as primary. The customer can later change their primary account using this setting.

comment

string

Comments passed by the user.

Headers

PromiseMode

string

enum

required

Required. Set to NEVER for a synchronous response or ALWAYS for asynchronous processing.

Allowed:

Responses

201

The entity has been created successfully.

202

The request has been accepted for processing, but the processing has not been completed. The request might or might not be eventually acted upon, and may be disallowed when processing occurs. Expected for all requests with Promise Mode as ALWAYS.

299

The Passport server successfully processed the request i.e. the object has been created or modified as requested, however the action may have an impact on transacting which is notified in the warning.

400

The request could not be accepted by the Passport server due to a malformed syntax, which may be a missing required parameter or other syntactical error.

Language

Credentials

Header

Loading…

Response

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

application/json

200The Passport server successfully processed the request.