> ## 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 crypto payout

> Creates a bulk crypto 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/crypto-payouts-docs.json post /api/payouts/crypto/bulk
openapi: 3.0.0
info:
  version: v1.0.0
  title: Crypto payouts API (legacy v1)
  description: API for managing crypto payouts in the Rio platform
servers:
  - url: https://app.sandbox.rio.trade
security:
  - apiKeyAuth: []
paths:
  /api/payouts/crypto/bulk:
    post:
      summary: Create bulk crypto payout
      description: >-
        Creates a bulk crypto payout container to group multiple order payouts
        into a single consolidated payout.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createBulkCryptoPayoutSchema'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responseCreateBulkCryptoPayoutSchema'
          description: Created
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/unauthorizedSchema'
          description: Unauthorized
components:
  schemas:
    createBulkCryptoPayoutSchema:
      type: object
      required:
        - payoutAddressId
        - country
      properties:
        payoutAddressId:
          type: string
          description: The ID of the crypto address where the payout will be sent.
          example: 65ba521a4b3e1bd9eb6a5107
        country:
          type: string
          enum:
            - MX
            - PE
            - CO
          description: The country of the operation.
    responseCreateBulkCryptoPayoutSchema:
      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
        crypto:
          type: string
          enum:
            - USDC
            - USDC_POLYGON_NXTB
            - SOL_USDC_PTHX
            - XLM_USDC_5F3T
            - USDC_BASECHAIN_ETH_5I5C
            - USDCE_TEMPO_MXYR
            - USDT_POLYGON
            - USDT_ERC20
            - TRX_USDT_S2UZ
            - USDT_BSC
            - SOL_USDT_EWAY
            - EUROC_ETH_F5NG
            - EURC_SOL
            - EURC_B609K9QB_Y213
          description: The cryptocurrency of the payout.
        payoutAddressId:
          type: string
          description: The ID of the destination crypto address.
          example: 65ba521a4b3e1bd9eb6a5107
        blockchainAddress:
          type: string
          description: The blockchain address where funds will be sent.
          example: '0x1234567890abcdef1234567890abcdef12345678'
        country:
          type: string
          enum:
            - MX
            - PE
            - CO
          description: The country of the operation.
        status:
          type: string
          enum:
            - awaitingOrders
            - awaitingPaymentForOrders
            - awaitingPayoutRequest
            - awaitingPayout
            - awaitingAsyncPayout
            - awaitingAsyncPayoutRequest
            - checkingLiquidity
            - sourcingLiquidity
            - liquiditySourced
            - complete
            - failed
            - cancelled
          description: The current status of the bulk crypto payout.
          example: awaitingOrders
        id:
          type: string
          description: The unique identifier of the bulk crypto 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.