Counterparty

Endpoints

The Counterparty section of our API facilitates operations related to counterparties for a customer. This includes retrieving a list of counterparties, adding new ones, updating and deleting existing ones.

• GET/counterparty : Get a list of counterparties for a customer. This can be searched by ProductID, businessID, individualID, or counterpartyID.
• POST/counterparty : Add a new counterparty for the logged-in customer.
• POST/counterparty/unblock/{id} : Only update the status of a counterparty.
• POST/counterparty/whitelist/{id} : Whitelist a counterparty.
• DELETE/counterparty/{id} : Delete an existing counterparty.
• GET/counterparty/{id} : Get a specific counterparty.
• PUT/counterparty/{id} : Update an existing counterparty.

Main Objects:

The primary objects found within Counterparty are ach, braid, type, and wire. Each of these objects possesses key components that are outlined in detail below.

1. ach: The Automated Clearing House (ach) object contains details regarding an ACH bank transfer, and it includes the following fields:

   • bankAccountType: Specifies the type of bank account used in the transaction, which can either be a "SAVINGS" or a "CHECKING" account.
   • bankName: The name of the bank associated with the account.
   • routingNumber: The bank-specific routing number.

2. braid: This object includes identifiers to link a specific product, individual, or business as follows:

   • productId: Identifier for a specific product.
   • individualId: Identifier for an individual.
   • businessId: Identifier for a business entity.
   • accountNumber: Represents the account number for the product, individual, or business.

3. type: A required field that indicates whether the counterparty is either a "BUSINESS" or an "INDIVIDUAL".

   1. Business (type is "BUSINESS"): This object includes details specific to a business entity as a counterparty
   • businessName: This required field represents the name of the business entity.
   • email: This optional field should contain a valid email address of the business.
   1. Individual (type is "INDIVIDUAL"): This object incorporates details specific to an individual as a counterparty:
   • firstName: This required field indicates the first name of the individual counterparty.
   • lastName: Also a required field, it represents the last name of the individual counterparty.
   • phone: An optional field that contains the contact number for the individual counterparty.

4. wire: This object contains details specific to a wire transfer:

• accountNumber: The number of the account involved in the wire transfer.
• accountType: Represents the type of account. Possible values include "BUSINESS_CHECKING", "BUSINESS_SAVING", "INDIVIDUAL_CHECKING", or "INDIVIDUAL_SAVING".
• address: This is a nested object that includes address details such as city (city), street information (line1, line2), state or province (state), type of address (type - "MAILING"), and zip or postal code (zip).
• bankName: The name of the bank associated with the wire transfer.
• routingNumber: The routing number specific to the bank involved in the wire transfer.

Parameters

• type: Denotes the type of the counterparty, can either be BUSINESS or INDIVIDUAL. This is a required field.
• businessName: Required when type is BUSINESS.
• email: Optional email address; Must be in the format of [email protected].
• firstName and lastName: Required when type is INDIVIDUAL.
• phone: Optional phone number; Must be in the format of +1123456789.

Enums

• bankAccountType: Can be either SAVINGS or CHECKING.
• accountType: Can be BUSINESS_CHECKING, BUSINESS_SAVING, INDIVIDUAL_CHECKING, or INDIVIDUAL_SAVING.