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

# Enrôler un compte bancaire

> Rattacher un compte bancaire à un usager déjà enrôlé dans GIMpay.

Cet appel rattache un **compte bancaire supplémentaire** à un usager existant. Pour le premier instrument d'un nouvel usager, utilisez plutôt [l'enrôlement d'usager](https://sandbox.it-centrex.com/endpoints/users/enroll.md).

## Champs

C'est l'endpoint d'enrôlement le plus simple : les cinq champs sont **tous obligatoires**, sans variation selon le cas.

| Champ | Rôle |
| - | - |
| `numeroRib` | Numéro RIB du compte à enrôler |
| `typeCompteBancaire` | `CHEQUE`, `EPARGNE` ou `DAT` — voir le [glossaire](https://sandbox.it-centrex.com/glossary/enumerations.md#typecomptebancaire) |
| `refUsager` | Référence GIMpay de l'usager détenteur |
| `refContributeurDemandeur` | Vous, le contributeur qui demande l'enrôlement |
| `refContributeurEmetteur` | La banque détentrice du compte |

> [!NOTE]
>
> `DAT` désigne un **dépôt à terme**. Ces trois valeurs constituent la liste exhaustive du contrat : un type de compte non listé ne peut pas être enrôlé en l'état.

## Avant d'appeler

**1. Identifiez la banque émettrice**

`GET /contributors?typeInstrument=COMPTE_BANCAIRE&codeIso=...` retourne les contributeurs proposant ce type d'instrument, avec leur référence.

**2. Vérifiez que le compte n'est pas déjà enrôlé**

[`POST /check-existence`](https://sandbox.it-centrex.com/endpoints/wallets/check-existence) en passant le RIB comme `identifiantCompte`, puis validation de l'OTP.

## Réponses

Le corps utile arrive dans `body`, à l'intérieur de l'enveloppe commune `{ message, status, body, timestamp }`, et contient `refInstrumentPaiement` — la référence de l'instrument créé, à conserver pour les appels suivants.

Un `404` indique qu'une entité renseignée est introuvable : le plus souvent `refUsager` ou l'une des deux références de contributeur. Voir la [référence des codes d'erreur](https://sandbox.it-centrex.com/getting-started/errors.md).

## Et ensuite ?

> **[Consulter le solde](https://sandbox.it-centrex.com/api-reference/introduction.md)**
>
> `GET /wallets/{referenceWallet}/balance`

> **[Exécuter une opération](https://sandbox.it-centrex.com/endpoints/operations/execute.md)**
>
> Utilisez ce compte comme instrument initiateur.


## OpenAPI

````yaml openapi.json POST /api/v1/wallets/bank-account
openapi: 3.0.3
info:
  title: Registre des APIs GIM Gar Sud
  version: 1.0.9-sdk0.3.0
  description: >
    APIs exposées par GIM Gar Sud pour permettre aux Contributeurs Tiers de
    Service Financier (CTSF) de consommer les services de GIMpay : enrôlement
    d'usagers et d'instruments de paiement, opérations financières, OTP,
    consentements, documents d'identité et fidélité.
  contact:
    name: Support intégrateurs GimPay
    email: support@it-centrex.com
servers:
  - url: https://egimgarsud.gimpayapp.com
    variables:
      environnement:
        default: egimgarsud
        description: Sous-domaine de l'environnement (sandbox ou production).
security:
  - bearerAuth: []
tags:
  - name: Authentification
  - name: Wallets
    description: Instruments de paiement (cartes, comptes bancaires, mobile wallets)
  - name: Opérations
  - name: OTP
  - name: Usagers
  - name: Bénéficiaires
  - name: MMP favorites
  - name: Pays
  - name: Contributeurs
  - name: Mini-places de marché
  - name: Services
  - name: Terminaux
  - name: Documents
  - name: Consentements & demandes
paths:
  /api/v1/wallets/bank-account:
    post:
      tags:
        - Wallets
      summary: Enrôler un compte bancaire
      operationId: enrollBankAccount
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnrollAccountRequest'
      responses:
        '201':
          description: Compte bancaire enrôlé.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ApiEnvelope'
                  - type: object
                    properties:
                      body:
                        $ref: '#/components/schemas/EnrollAccountResponse'
        '400':
          $ref: '#/components/responses/Error400'
        '401':
          $ref: '#/components/responses/Error401'
        '500':
          $ref: '#/components/responses/Error500'
components:
  schemas:
    EnrollAccountRequest:
      type: object
      required:
        - numeroRib
        - refContributeurDemandeur
        - refContributeurEmetteur
        - refUsager
        - typeCompteBancaire
      properties:
        numeroRib:
          type: string
          description: Le numéro RIB
        refContributeurDemandeur:
          type: string
          description: >-
            La référence du contributeur demandeur qui demande l'enrôlement de
            l'instrument de paiement
        refContributeurEmetteur:
          type: string
          description: >-
            La référence du contributeur émetteur de l'instrument de paiement à
            enrôler
        refUsager:
          type: string
          description: La reference de l'usager
        typeCompteBancaire:
          $ref: '#/components/schemas/TypeCompteBancaire'
    ApiEnvelope:
      type: object
      description: Enveloppe standard de toutes les réponses (sauf auth).
      properties:
        message:
          type: string
          description: Message technique décrivant le résultat de l'appel.
        status:
          type: integer
          description: Code de statut HTTP de la réponse.
        timestamp:
          type: string
          format: date-time
          description: Horodatage de la réponse.
    EnrollAccountResponse:
      type: object
      properties:
        refUsager:
          type: string
          description: La reference de l'usager
        rib:
          type: string
        libelle:
          type: string
          description: Libellé de l'opération
        typeCompteBancaire:
          type: string
          description: Le type de compte bancaire
          enum:
            - CHEQUE
            - EPARGNE
            - DAT
        reference:
          type: string
          description: Référence unique de la demande.
    TypeCompteBancaire:
      type: string
      enum:
        - CHEQUE
        - EPARGNE
        - DAT
    ErrorEnvelope:
      allOf:
        - $ref: '#/components/schemas/ApiEnvelope'
        - type: object
          properties:
            body:
              nullable: true
  responses:
    Error400:
      description: Requête invalide (champ manquant ou mal formé).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Error401:
      description: Non autorisé — jeton manquant, invalide ou expiré.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Error500:
      description: Erreur interne du serveur.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Jeton émis par `POST /api/v1/auth/token`.

````

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