Create a counterparty

post

https://api.sandbox.braid.zone/counterparty

Body Params

name

string

required

Name of the counterparty

phone

string

Phone number of the counterparty

string

Email of the counterparty

individualId

int32

The individualId the counterparty is associated with. If set, the counterparty can not be used with other customers. One and only one of the association (accountNumber / businessId / individualId / productId) is required.

businessId

int32

The businessId the counterparty is associated with. If set, the counterparty can not be used with other customers. One and only one of the association (accountNumber / businessId / individualId / productId) is required.

productId

int32

The productId the counterparty is associated with. If set, the counterparty can be used with any account with the productId. One and only one of the association (accountNumber / businessId / individualId / productId) is required.

accountNumber

string

The accountNumber the counterparty is associated with. If set, the counterparty can not be used with other account numbers. One and only one of the association (accountNumber / businessId / individualId / productId) is required.

type

string

enum

Type of the counterparty

Allowed:

dateOfBirth

date

Date of birth of the counterparty

idNumber

string

ID Number of the counterparty

idType

string

enum

ID Type of the counterparty

ach

object

Ach Payment Instrument

wire

object

Wire Payment Instrument

braid

object

Braid Payment Instrument

fedNow

object

FedNow Payment Instrument

Responses

Language

Response

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

*/*

200OK

400Bad Request

401Unauthorized

403Forbidden

404Not Found

422Unprocessable Entity

500Internal Server Error

503Service Unavailable