Create a Counterparty

Create a counterparty with contact metadata, an inline address, and optional payout defaults.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Create-counterparty payload. The current implementation requires address on create.

Request payload used to create a counterparty.

string
required

Counterparty business name. The service requires this field.

string

External system identifier for the counterparty.

int64

Parent counterparty identifier when the counterparty participates in a hierarchy.

string
enum
required
Allowed:
string

Tax identifier used with business name uniqueness checks.

string

Primary contact name.

string

Primary contact email address.

string

Primary contact phone number.

string

Secondary or backup contact name.

string

Secondary or backup contact email address.

string

Secondary or backup contact phone number.

boolean

Active flag for the new counterparty. Defaults to true when omitted.

int32

Default payout delay in days, primarily used for MERCHANT loan links.

address
object
required

Inline address payload used by counterparty create and update requests.

Response

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json