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

# Collecter les consentements d'un usager



## OpenAPI

````yaml /openapi.json get /api/v1/users/{refUser}/consents
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/users/{refUser}/consents:
    get:
      tags:
        - Consentements & demandes
      summary: Collecter les consentements d'un usager
      operationId: getUserConsents
      parameters:
        - name: refUser
          in: path
          required: true
          description: Référence GIMpay de l'usager.
          schema:
            type: string
      responses:
        '200':
          description: Consentements collectés.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ApiEnvelope'
                  - type: object
                    properties:
                      body:
                        type: array
                        items:
                          $ref: '#/components/schemas/ConsentementResponse'
        '400':
          $ref: '#/components/responses/Error400'
        '401':
          $ref: '#/components/responses/Error401'
        '500':
          $ref: '#/components/responses/Error500'
components:
  schemas:
    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.
    ConsentementResponse:
      type: object
      description: >
        Backend : `Consentement`. La clé `refConditonUtilisationGen` reproduit
        la typo du contrat.
      properties:
        id:
          type: integer
          description: Identifiant technique de la demande.
        dateHeureCreation:
          type: string
          format: date-time
          description: Date et heure de création de la demande.
        dateDebut:
          type: string
          format: date-time
        dateFin:
          type: string
          format: date-time
        dateHeureValidite:
          type: string
          format: date-time
        dateHeureRevocation:
          type: string
          format: date-time
        texteDeConsentementSpecifique:
          type: string
        refConditonUtilisationGen:
          type: string
        motifRevocation:
          type: string
        refUsagerDestinataire:
          type: string
        refContributeurEmetteur:
          type: string
          description: >-
            La référence du contributeur émetteur de l'instrument de paiement à
            enrôler
        typeConsentement:
          $ref: '#/components/schemas/TypeConsentement'
        statutConsentement:
          $ref: '#/components/schemas/StatutConsentement'
        refConsentement:
          type: string
        numeroSerieTerminal:
          type: string
        refDemandeAchatACredit:
          type: string
    TypeConsentement:
      type: string
      enum:
        - CONDITION_GENERAL
        - SPECIFIQUE
    StatutConsentement:
      type: string
      enum:
        - INITIE
        - LU
        - ACCEPTE
        - REFUSE
        - PROROGE
        - REVOQUE
    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`.

````