API Reference
  1. Treasury Solutions
  2. Contact

Create Contact

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

Create a new contact (frequent payee) for a customer. Contacts store payee details including bank accounts, cards, and international accounts to streamline recurring payments.

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.

Body Params

Details required to create Contact.

string
required

Display label of contact.

string
enum

Type of Customer.

Allowed:
string
required

First name of contact of type INDIVIDUAL.

string
required

Last name of contact of type INDIVIDUAL.

string
required

Legal name of contact of type BUSINESS.

string
required

Add PPI (Passport Payment ID) as contact.

string

The contact’s email address. Will be mandatory for creating a contact for method “VIRTUAL CARD”. Format: [email protected]

externalAccount
array of objects
required

Details of external account being added as contact.

externalAccount*
card
object

Save contact’s card details within the system.

internationalExternalAccount
array of objects
required

Details of international external account being added as contact.

internationalExternalAccount*
mailingAddress
array of objects
required

Details of mailing address being added as contact.

mailingAddress*
Headers
string
enum
required

This is a mandatory field, user must provide input either 'ALWAYS' or 'NEVER'. 'NEVER' - For immediate response, 'ALWAYS' - For later response.

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?