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

# Create bulk bank payout

> Creates a bulk bank payout container to group multiple order payouts into a single consolidated payout.

<Warning>
  **v1 (legacy).** This page documents the API before the v2 update. The v1
  format is not enabled for new accounts and must be enabled on your account by
  your account manager. New integrations should use the
  [current documentation](/introduction). To update an existing integration,
  follow the [migration guide](/migration).
</Warning>

### Requirements to consume the endpoint.

<CardGroup cols={2}>
  <Card title="Create and modify role" icon="user-lock">
    The user must have the role to create and modify.
  </Card>

  <Card title="User approved" icon="check">
    The user must be approved in at least one country.
  </Card>
</CardGroup>


## OpenAPI

````yaml v1/api-reference/bank-payouts-docs.json post /api/payouts/bank/bulk
openapi: 3.0.0
info:
  version: v1.0.0
  title: Bank payouts API (legacy v1)
  description: API for managing bank payouts in the Rio platform
servers:
  - url: https://app.sandbox.rio.trade
security:
  - apiKeyAuth: []
paths:
  /api/payouts/bank/bulk:
    post:
      summary: Create bulk bank payout
      description: >-
        Creates a bulk bank payout container to group multiple order payouts
        into a single consolidated payout.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createBulkBankPayoutSchema'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responseCreateBulkBankPayoutSchema'
          description: Created
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/unauthorizedSchema'
          description: Unauthorized
components:
  schemas:
    createBulkBankPayoutSchema:
      type: object
      required:
        - payoutBankAccountId
      properties:
        payoutBankAccountId:
          type: string
          description: The ID of the bank account where the payout will be sent.
          example: 65ba521a4b3e1bd9eb6a5107
    responseCreateBulkBankPayoutSchema:
      type: object
      properties:
        createdAt:
          type: string
          description: The date and time the bulk payout was created.
          example: '2025-01-04T00:24:28.658Z'
        userId:
          type: string
          description: The unique identifier of the user.
          example: 6757546b4c5d19bf3cd7b09c
        orderIds:
          type: array
          description: List of order IDs associated with this bulk payout.
          items:
            type: string
          example: []
        amount:
          type: number
          description: The total payout amount across all orders.
          example: 0
        fiat:
          type: string
          enum:
            - MXN
            - PEN
            - COP
            - USD
          description: The fiat currency of the payout.
        country:
          type: string
          enum:
            - MX
            - PE
            - CO
          description: The country of the payout.
        bankName:
          type: string
          description: The name of the destination bank.
          example: BBVA
        CLABE:
          type: string
          description: The CLABE number for Mexican bank accounts.
          example: '012180015000000001'
        status:
          type: string
          enum:
            - awaitingOrders
            - awaitingPaymentForOrders
            - awaitingAsyncPayoutRequest
            - awaitingPayout
            - awaitingAsyncPayout
            - checkingLiquidity
            - sourcingLiquidity
            - liquiditySourced
            - complete
            - failed
            - cancelled
          description: The current status of the bulk bank payout.
          example: awaitingOrders
        payoutBankAccountId:
          type: string
          description: The ID of the destination bank account.
          example: 65ba521a4b3e1bd9eb6a5107
        id:
          type: string
          description: The unique identifier of the bulk bank payout.
          example: 677890d5d520f9ecb10e9c33
    unauthorizedSchema:
      type: object
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              code:
                type: number
                example: 19
              message:
                type: string
                example: Not authorized
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````

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