Business Units

Create a Business Unit

Changed on

Creates a Customer/Business Unit that can own instruments and private accounts. Business Units are useful when sub-accounts need their own RFC and legal identity on payment receipts.

post/v1/clients/{clientId}/customers

Request

Path parameters

clientIdstring uuid required
Example:c2d1d1e3-3340-4170-980e-e9269bbbc551

Client UUID.

Request body

client_idstring uuid required

Client UUID that will own the Business Unit.

namestring required

Legal name of the Business Unit.

rfcstring required

RFC tax identifier for the Business Unit.

legal_representative_namestring required

Full name of the Business Unit legal representative.

legal_representative_rfcstring required

RFC tax identifier of the legal representative.

legal_representative_phonestring required

Contact phone number of the legal representative.

legal_representative_emailstring email required

Contact email of the legal representative.

websitestring uri

Business Unit website when available.

domainstring

Business Unit domain when available.

customer_aliasstring

Short alias used to identify the Business Unit.

customer_status'ACTIVE' | 'INACTIVE' | 'BLOCKED'
customer_validation_status'PENDING' | 'VALIDATED' | 'REJECTED'
client_bank_adapter_idstring uuid

Bank adapter configuration UUID associated with the Business Unit.

Example request

{
  "client_id": "c2d1d1e3-3340-4170-980e-e9269bbbc551",
  "name": "Business Unit ABC",
  "rfc": "XAXX010101000",
  "legal_representative_name": "Jane Doe",
  "legal_representative_rfc": "XAXX010101000",
  "legal_representative_phone": "5555555555",
  "legal_representative_email": "legal@example.com",
  "website": "https://example.com",
  "domain": "example.com",
  "customer_alias": "BU ABC",
  "customer_status": "ACTIVE",
  "customer_validation_status": "VALIDATED",
  "client_bank_adapter_id": "5b3a1b67-ab59-4cc1-8fc6-1d558b32b237"
}

Response

Business Unit created.

idstring uuid required

Business Unit UUID.

clientIdstring uuid required

Client UUID that owns the Business Unit.

namestring required

Legal name of the Business Unit.

rfcstring required

RFC tax identifier of the Business Unit.

legalRepresentativeNamestring required

Full name of the legal representative.

legalRepresentativeRfcstring required

RFC tax identifier of the legal representative.

legalRepresentativePhonestring required

Contact phone number of the legal representative.

legalRepresentativeEmailstring email required

Contact email of the legal representative.

websitestring uri

Business Unit website when available.

domainstring

Business Unit domain when available.

customerAliasstring

Short alias used to identify the Business Unit.

customerStatus'ACTIVE' | 'INACTIVE' | 'BLOCKED'
customerValidationStatus'PENDING' | 'VALIDATED' | 'REJECTED'

Example response

{
  "id": "bb1e8fde-e68e-48e9-a483-d32153c752c2",
  "clientId": "c2d1d1e3-3340-4170-980e-e9269bbbc551",
  "name": "Business Unit ABC",
  "rfc": "XAXX010101000",
  "legalRepresentativeName": "Jane Doe",
  "legalRepresentativeRfc": "XAXX010101000",
  "legalRepresentativePhone": "5555555555",
  "legalRepresentativeEmail": "legal@example.com",
  "website": "https://example.com",
  "domain": "example.com",
  "customerAlias": "BU ABC",
  "customerStatus": "ACTIVE",
  "customerValidationStatus": "VALIDATED",
  "audit": {
    "createdAt": "2025-03-05 11:00:56.264527-06:00",
    "updatedAt": "2025-03-05 11:00:56.264527-06:00",
    "deletedAt": "None",
    "blockedAt": "None"
  }
}

Changes