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

# Créer un payout

> Envoyez des fonds depuis un portefeuille vers un bénéficiaire.

La clé `Idempotency-Key` empêche un double décaissement lors d'une nouvelle tentative.

```bash cURL theme={null}
curl --request POST \
  --url https://api.bizconnectpay.com/api/v1/payouts \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: payout-5012' \
  --data '{
    "wallet_id": "4e969910-8f06-4cd2-b92c-01765472e0e9",
    "amount": "25000",
    "currency": "XOF",
    "country": "CI",
    "payment_method": "orange_money",
    "destination": "+2250701020304",
    "metadata": {"client_reference": "PAYOUT-5012"}
  }'
```

```json Payload theme={null}
{
  "wallet_id": "4e969910-8f06-4cd2-b92c-01765472e0e9",
  "amount": "25000",
  "currency": "XOF",
  "country": "CI",
  "payment_method": "orange_money",
  "destination": "+2250701020304",
  "metadata": {
    "client_reference": "PAYOUT-5012"
  }
}
```

```json 201 Created theme={null}
{
  "success": true,
  "data": {
    "id": "a1a3a073-7578-47ab-af2b-c81bb923e74f",
    "reference": "BCP-OUT-01JACA2H",
    "wallet_id": "4e969910-8f06-4cd2-b92c-01765472e0e9",
    "amount": "25000.0000",
    "currency": "XOF",
    "country": "CI",
    "payment_method": "orange_money",
    "destination": "+2250701020304",
    "status": "PENDING",
    "created_at": "2026-10-20T13:00:00.000000Z"
  },
  "meta": {
    "correlation_id": "35ca88fb-f470-4643-a3aa-879a7c129955"
  }
}
```


## OpenAPI

````yaml openapi.json POST /payouts
openapi: 3.1.0
info:
  title: BizConnectPay API
  version: 1.0.0
  description: >-
    API serveur-à-serveur pour les collectes, décaissements, transactions,
    remboursements, liens de paiement et cartes virtuelles.
servers:
  - url: https://api.bizconnectpay.com/api/v1
    description: Passerelle API BizConnectPay
security:
  - bearerAuth: []
tags:
  - name: Authentification
  - name: Services
  - name: Collectes
  - name: Transactions
  - name: Décaissements
  - name: Remboursements
  - name: Liens de paiement
  - name: Porteurs de carte
  - name: Cartes virtuelles
paths:
  /payouts:
    post:
      tags:
        - Décaissements
      summary: Créer un payout
      description: >-
        Débite un wallet et envoie les fonds au destinataire. Scope requis :
        `withdrawals.write`.
      operationId: createPayout
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
        - $ref: '#/components/parameters/CorrelationId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WithdrawalRequest'
            example:
              wallet_id: 4e969910-8f06-4cd2-b92c-01765472e0e9
              amount: '25000'
              currency: XOF
              country: CI
              payment_method: orange_money
              destination: '+2250701020304'
              metadata:
                client_reference: PAYOUT-5012
      responses:
        '201':
          $ref: '#/components/responses/Created'
        '422':
          $ref: '#/components/responses/ValidationError'
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: true
      description: Clé unique et stable pour cette opération métier.
      schema:
        type: string
        maxLength: 255
    CorrelationId:
      name: X-Correlation-ID
      in: header
      required: false
      schema:
        type: string
        format: uuid
  schemas:
    WithdrawalRequest:
      type: object
      required:
        - wallet_id
        - amount
        - currency
        - country
        - payment_method
        - destination
      properties:
        wallet_id:
          type: string
          format: uuid
        amount:
          type: number
          exclusiveMinimum: 0
        currency:
          type: string
          minLength: 3
          maxLength: 3
        country:
          type: string
          minLength: 2
          maxLength: 2
        payment_method:
          type: string
        destination:
          type: string
        metadata:
          type: object
          additionalProperties: true
    SuccessEnvelope:
      type: object
      properties:
        success:
          type: boolean
          const: true
        data: {}
        meta:
          $ref: '#/components/schemas/Meta'
    ErrorEnvelope:
      type: object
      properties:
        success:
          type: boolean
          const: false
        data:
          type: object
          properties:
            error:
              type: object
              properties:
                code:
                  type: string
                message:
                  type: string
                details:
                  type:
                    - object
                    - array
        meta:
          $ref: '#/components/schemas/Meta'
    Meta:
      type: object
      properties:
        correlation_id:
          type:
            - string
            - 'null'
          format: uuid
  responses:
    Created:
      description: Ressource créée
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SuccessEnvelope'
    ValidationError:
      description: Payload ou règle métier invalide
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

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