Important Components of Counterparty

Data 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.

Format

For the POST /counterparty endpoint, the sections related to phone numbers and emails should be formatted in the following manner:

  1. Email: The email field is optional but when provided, it should be in standard email format, e.g., [email protected]. Any deviation from this format may cause the request to be rejected.

  2. Phone: The phone field is also optional. If provided, the phone number should follow the international format which includes country code followed by the number, e.g., +11234567890. Numbers not adhering to this format might lead to unsuccessful responses or errors while using this endpoint. Always ensure that the data is correctly formatted to guarantee a successful request.