> ## Documentation Index
> Fetch the complete documentation index at: https://docs.trio.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Create Counterparty Recipient

> Creates a counterparty recipient



## OpenAPI

````yaml v2/api-reference/openapi.json POST /v2/counterparty_recipients
openapi: 3.0.0
info:
  title: Trio API v2
  version: 2026-10-19.v2
servers:
  - url: https://api.sandbox.trio.com.br
    variables: {}
  - url: https://api.qa.trio.com.br
    variables: {}
  - url: https://api.trio.com.br
    variables: {}
security: []
tags: []
paths:
  /v2/counterparty_recipients:
    parameters:
      - description: >-
          Version of the v2 contract the client is written against. Each
          breaking change publishes a new version.
        example: 2026-10-19.v2
        in: header
        name: Trio-Version
        required: true
        schema:
          enum:
            - 2026-10-19.v2
          type: string
          x-struct: null
          x-validate: null
      - description: >-
          ID of another org to act on instead of the API key's own org. The
          key's org must have been granted access to it, and the request is
          refused with 403 FORBIDDEN otherwise. When that access or the API key
          is read-only, only GET and HEAD requests may carry it. When the target
          org requires mTLS, so does the request. Leave it out to act on the
          key's own org.
        in: header
        name: Trio-Target-Org-Id
        required: false
        schema:
          format: uuid
          type: string
          x-struct: null
          x-validate: null
    post:
      tags:
        - Counterparties
        - Split Recipients
      summary: Create counterparty recipient
      description: Creates a counterparty recipient
      operationId: TrioFoundationWeb.V2.CounterpartyRecipientController.create
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Create_counterparty_recipient_params'
        description: The create counterparty recipient attributes
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Counterparty_recipient_response'
          description: CounterpartyRecipient
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2_error'
          description: >-
            Malformed request: a body that is not valid JSON
            (MALFORMED_REQUEST), or a Trio-Version header that is missing or not
            the current one (INVALID_TRIO_VERSION).
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2_error'
          description: Missing or invalid API key credentials (INVALID_CREDENTIALS).
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2_error'
          description: >-
            The API key may not do this (FORBIDDEN): for instance
            Trio-Target-Org-Id names an org it has no access to, or writes
            through a read-only access.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2_error'
          description: >-
            Invalid input (INVALID_PARAMETER, REQUIRED_PARAMETER, or the code of
            the rule the request breaks). A request outside the operation's
            schema lists the offending fields in `errors`.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2_error'
          description: >-
            A service needed to answer is unavailable
            (TRIO_SERVICE_UNAVAILABLE).
      callbacks: {}
      security:
        - authorization: []
components:
  schemas:
    Create_counterparty_recipient_params:
      description: Body params to create a counterparty recipient
      example:
        name: Random
        pix_key: some-pix-key
        ref_type: pix_key
        tax_number: '12345678910'
      properties:
        branch:
          description: Bank account branch. Required when ref_type is bank_account_detailed
          nullable: true
          type: string
          x-struct: null
          x-validate: null
        digit:
          description: Bank account digit. Required when ref_type is bank_account_detailed
          nullable: true
          type: string
          x-struct: null
          x-validate: null
        ispb:
          description: Bank account ispb. Required when ref_type is bank_account_detailed
          nullable: true
          type: string
          x-struct: null
          x-validate: null
        name:
          description: Name of the counterparty
          type: string
          x-struct: null
          x-validate: null
        number:
          description: Bank account number. Required when ref_type is bank_account_detailed
          nullable: true
          type: string
          x-struct: null
          x-validate: null
        pix_key:
          description: Pix key. Required when ref_type is pix_key
          nullable: true
          type: string
          x-struct: null
          x-validate: null
        ref_type:
          description: How the recipient is referenced
          enum:
            - pix_key
            - bank_account_detailed
          type: string
          x-struct: null
          x-validate: null
        tax_number:
          description: Tax number of the counterparty
          type: string
          x-struct: null
          x-validate: null
        type:
          $ref: '#/components/schemas/Counterparty_bank_account_type'
      required:
        - tax_number
        - name
        - ref_type
      title: Create counterparty recipient params
      type: object
      x-struct: >-
        Elixir.TrioFoundationWeb.Schemas.Banking.V2.Counterparty.Recipient.CreateParams
      x-validate: null
    Counterparty_recipient_response:
      example:
        data:
          bank_account: null
          counterparty:
            id: 018df099-093e-cfd1-4500-4c9392eb5d8a
            name: Random
            tax_number: '34842155000197'
          id: 1fb05245-a185-0ec1-2661-3390353a35e3
          pix_key: some-pix-key
          ref_type: pix_key
      properties:
        data:
          $ref: '#/components/schemas/Counterparty_recipient_data'
      title: Counterparty recipient response
      type: object
      x-struct: >-
        Elixir.TrioFoundationWeb.Schemas.Banking.V2.Counterparty.Recipient.Response
      x-validate: null
    V2_error:
      example:
        error:
          error_code: INVALID_PARAMETER
          error_message: 'Invalid parameters: /amount: Invalid integer. Got: string'
          errors:
            - field: /amount
              message: 'Invalid integer. Got: string'
      properties:
        error:
          properties:
            error_code:
              description: >-
                Stable UPPER_SNAKE identifier of the error, for programs and
                logs. Branch on this, not on the message.
              type: string
              x-struct: null
              x-validate: null
            error_message:
              description: Human readable explanation of the error.
              type: string
              x-struct: null
              x-validate: null
            errors:
              description: >-
                Only on INVALID_PARAMETER for a request outside the operation's
                schema: one entry per offending field.
              items:
                properties:
                  field:
                    description: JSON pointer to the field, e.g. /amount.
                    type: string
                    x-struct: null
                    x-validate: null
                  message:
                    description: What is wrong with it.
                    type: string
                    x-struct: null
                    x-validate: null
                required:
                  - field
                  - message
                type: object
                x-struct: null
                x-validate: null
              type: array
              x-struct: null
              x-validate: null
          required:
            - error_code
            - error_message
          type: object
          x-struct: null
          x-validate: null
      required:
        - error
      title: V2 error
      type: object
      x-struct: Elixir.TrioFoundationWeb.Schemas.HTTP.V2Error
      x-validate: null
    Counterparty_bank_account_type:
      description: Type of the counterparty bank account
      items:
        enum:
          - checking
          - payment
          - salary
          - savings
        type: string
        x-struct: null
        x-validate: null
      title: Counterparty bank account type
      type: string
      x-struct: null
      x-validate: null
    Counterparty_recipient_data:
      description: Body response of the counterparty recipient
      example:
        bank_account: null
        counterparty:
          id: 018df099-093e-cfd1-4500-4c9392eb5d8a
          name: Random
          tax_number: '34842155000197'
        id: 1fb05245-a185-0ec1-2661-3390353a35e3
        pix_key: some-pix-key
        ref_type: pix_key
      properties:
        bank_account:
          $ref: '#/components/schemas/Counterparty_recipient_bank_account_data'
        counterparty:
          $ref: '#/components/schemas/Counterparty_recipient_counterparty_data'
        id:
          $ref: '#/components/schemas/UUID'
        pix_key:
          description: Pix key
          nullable: true
          type: string
          x-struct: null
          x-validate: null
        ref_type:
          description: How the recipient is referenced
          enum:
            - pix_key
            - bank_account_detailed
          type: string
          x-struct: null
          x-validate: null
      title: Counterparty recipient data
      type: object
      x-struct: >-
        Elixir.TrioFoundationWeb.Schemas.Banking.V2.Counterparty.Recipient.RecipientData
      x-validate: null
    Counterparty_recipient_bank_account_data:
      example:
        branch: '0001'
        digit: '1'
        ispb: '12345678'
        number: '87654321'
        type: checking
      nullable: true
      properties:
        branch:
          description: Bank account branch
          type: string
          x-struct: null
          x-validate: null
        digit:
          description: Bank account digit
          type: string
          x-struct: null
          x-validate: null
        ispb:
          description: Bank account ispb
          type: string
          x-struct: null
          x-validate: null
        number:
          description: Bank account number
          type: string
          x-struct: null
          x-validate: null
        type:
          $ref: '#/components/schemas/Counterparty_bank_account_type'
      title: Counterparty recipient bank account data
      type: object
      x-struct: >-
        Elixir.TrioFoundationWeb.Schemas.Banking.V2.Counterparty.Recipient.BankAccountData
      x-validate: null
    Counterparty_recipient_counterparty_data:
      example:
        id: 018df099-093e-cfd1-4500-4c9392eb5d8a
        name: Random
        tax_number: '34842155000197'
      properties:
        id:
          $ref: '#/components/schemas/UUID'
        name:
          description: Name of the counterparty
          type: string
          x-struct: null
          x-validate: null
        tax_number:
          description: Tax number of the counterparty
          type: string
          x-struct: null
          x-validate: null
      title: Counterparty recipient counterparty data
      type: object
      x-struct: >-
        Elixir.TrioFoundationWeb.Schemas.Banking.V2.Counterparty.Recipient.CounterpartyData
      x-validate: null
    UUID:
      description: Unique identifier
      format: uuid
      title: UUID
      type: string
      x-struct: null
      x-validate: null
  securitySchemes:
    authorization:
      scheme: basic
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.