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

# Create recipients in bulk

> Up to 100 per call. Partial success is normal — check `failed` for rejects.



## OpenAPI

````yaml /api-reference/openapi.json post /v1/recipients/bulk
openapi: 3.1.0
info:
  title: Chipper Platform API
  version: '2026-02-20'
  description: >-
    Payouts, collections, and FX across African rails — bank, mobile money, and
    stablecoins — through one API.
servers:
  - url: https://sandbox-api.platform.chipper.ai
    description: Sandbox (sk_test_ keys — simulated rails, no real money)
  - url: https://api.platform.chipper.ai
    description: Production (sk_live_ keys)
security:
  - bearerAuth: []
paths:
  /v1/recipients/bulk:
    post:
      tags:
        - Recipients
      summary: Create recipients in bulk
      description: >-
        Up to 100 per call. Partial success is normal — check `failed` for
        rejects.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                recipients:
                  type: array
                  items:
                    type: object
                    properties:
                      accountName:
                        type: string
                        minLength: 1
                        maxLength: 200
                      label:
                        type: string
                        minLength: 1
                        maxLength: 100
                      code:
                        type: string
                        minLength: 1
                      accountNumber:
                        type: string
                        minLength: 1
                      address:
                        type: string
                        minLength: 1
                      tag:
                        type: string
                    required:
                      - code
                  minItems: 1
                  maxItems: 100
              required:
                - recipients
      responses:
        '201':
          description: Per-item results.
          content:
            application/json:
              schema:
                type: object
                properties:
                  summary:
                    type: object
                    properties:
                      total:
                        type: integer
                      created:
                        type: integer
                      failed:
                        type: integer
                    required:
                      - total
                      - created
                      - failed
                  created:
                    type: array
                    items:
                      $ref: '#/components/schemas/Recipient'
                  failed:
                    type: array
                    items:
                      type: object
                      properties:
                        index:
                          type: integer
                        error:
                          type: string
                      required:
                        - index
                        - error
                required:
                  - summary
                  - created
                  - failed
        '400':
          description: Invalid request — the body failed validation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: validation_error
                message: Request validation failed
                requestId: req_q7vei435zifs51ia0lqr
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: unauthorized
                message: Invalid API key
                requestId: req_q7vei435zifs51ia0lqr
        '403':
          description: The API key lacks the required scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: forbidden
                message: API key does not have the required scope
                requestId: req_q7vei435zifs51ia0lqr
      security:
        - bearerAuth: []
components:
  schemas:
    Recipient:
      type: object
      properties:
        id:
          type: string
          example: rcp_x7kd92mfn3qp8wz4t6vb
        accountName:
          type: string
          description: Validated account-holder name where available.
          example: Ama Serwaa
        label:
          type:
            - string
            - 'null'
          description: Your own display label.
          example: Supplier — Accra
        code:
          type: string
          description: Payment method code from the capabilities catalog.
          example: gh_mtn
        accountNumber:
          type: string
          description: Fiat recipients only.
          example: '233559630374'
        address:
          type: string
          description: Crypto recipients only.
          example: 9aE4gcS3…
        tag:
          type: string
          description: Memo/tag for chains that require one (Stellar, Ripple).
        country:
          type: string
          example: GH
        currency:
          type: string
          example: GHS
        isActive:
          type: boolean
        createdAt:
          type: string
          format: date-time
          example: '2026-08-01T09:12:44.000Z'
        updatedAt:
          type: string
          format: date-time
      required:
        - id
        - accountName
        - label
        - code
        - country
        - currency
        - isActive
        - createdAt
        - updatedAt
    Error:
      type: object
      properties:
        error:
          type: string
          description: Stable machine-readable code.
        message:
          type: string
          description: Human-readable explanation.
        requestId:
          type: string
          description: Echoed in the x-request-id response header — quote it to support.
      required:
        - error
        - message
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Your API key: `sk_test_…` (sandbox) or `sk_live_…` (production).'

````