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

# Demandes de règlement

## Introduction

Une demande de règlement permet de demander à HUB2 de vous verser des fonds prélevés sur le solde de votre compte de collecte. Les demandes de règlement se créent dans le [tableau de bord HUB2](https://dashboard.hub2.io) : il n'existe aucun point de terminaison de l'API pour les créer ou les lister. Pour suivre une demande depuis votre propre système, abonnez-vous aux [webhooks de demande de règlement](#webhooks).

La page **Règlements** apparaît dans le menu du tableau de bord HUB2 pour les utilisateurs qui ont la permission de consulter les demandes de règlement. Soumettre une demande nécessite la permission d'en créer.

## Créer une demande de règlement

**1. Ouvrir la page Règlements**

La page affiche le solde de votre compte de collecte et le **Solde disponible** par devise. Le solde disponible correspond au solde de votre compte de collecte, diminué des montants déjà engagés dans vos autres demandes de règlement non terminées.

**2. Soumettre une demande de règlement**

Cliquez sur **Soumettre une demande de règlement**, puis renseignez le formulaire :

* **Montant** : un nombre entier, dans la devise sélectionnée ci-dessous.
* **Devise** : la devise du solde sur lequel porte le retrait.
* **Description** (optionnel).

HUB2 attribue une référence unique à la demande. Elle s'affiche dans la colonne **Référence** de la liste.

HUB2 refuse la demande lorsque :

* le montant est inférieur au montant minimum de règlement ;
* votre compte marchand n'est pas actif ;
* le montant dépasse le solde disponible de la devise sélectionnée.

La demande n'est alors pas créée.

## Ce que fait HUB2 d'une demande

1. **Soumission** : la demande est enregistrée avec le statut **Soumise**.
2. **Examen** : HUB2 examine la demande.
   * Si elle est approuvée, le statut devient **En cours de traitement**.
   * Si elle est rejetée, le statut devient **Rejetée**. HUB2 indique toujours un motif, affiché sous le statut dans la liste et envoyé par e-mail. La demande s'arrête là et aucun fonds n'est déplacé.
3. **Fonds envoyés** : une fois la demande approuvée, le montant est débité de votre solde de collecte et HUB2 envoie les fonds. Le statut devient **Fonds envoyés**.
4. **Confirmation** : lorsque HUB2 a enregistré la preuve de virement, le statut devient **Confirmée** et vous recevez un e-mail de confirmation.

Si HUB2 ne parvient pas à exécuter la demande après l'avoir approuvée, le tableau de bord HUB2 affiche le statut **Échouée**. Contactez le support HUB2 en indiquant la référence de la demande.

## Suivre une demande

La liste de la page **Règlements** affiche la référence, le montant, la date de soumission et le statut de chaque demande, de la plus récente à la plus ancienne. Elle s'actualise automatiquement. Utilisez le filtre de statut pour n'afficher que les demandes d'un statut donné :

| Statut dans le tableau de bord | Signification |
| :- | :- |
| **Soumise** | La demande est enregistrée et en attente d'examen. |
| **En cours de traitement** | La demande est approuvée et HUB2 la traite. |
| **Fonds envoyés** | Le montant est débité de votre solde de collecte et les fonds sont envoyés. |
| **Confirmée** | La preuve de virement est disponible. |
| **Rejetée** | HUB2 a rejeté la demande. Le motif est affiché avec le statut. |
| **Échouée** | La demande approuvée n'a pas pu être exécutée. |

### Télécharger la preuve de virement

Pour une demande **Confirmée**, cliquez sur le bouton de téléchargement en fin de ligne (**Télécharger la preuve de virement**). La preuve est un fichier image (JPG ou PNG) nommé d'après la référence de la demande.

## Webhooks

HUB2 envoie un webhook à chaque changement de statut d'une demande de règlement. Abonnez-vous à ces événements dans le tableau de bord HUB2, comme pour tout autre événement (voir la [présentation des webhooks](https://docs.hub2.io/integration/fr/webhooks/webhooks_overview.md) et la [liste des événements disponibles](https://docs.hub2.io/integration/fr/webhooks/webhooks_events_list.md)). Les webhooks de demande de règlement sont envoyés pour l'environnement `live`.

| Événement | Envoyé lorsque | Statut dans le tableau de bord |
| :- | :- | :- |
| `settlement_request.submitted` | La demande est créée. | Soumise |
| `settlement_request.processing` | HUB2 approuve la demande. | En cours de traitement |
| `settlement_request.funds_sent` | Le montant est débité de votre solde de collecte et les fonds sont envoyés. | Fonds envoyés |
| `settlement_request.confirmed` | La preuve de virement est enregistrée. | Confirmée |
| `settlement_request.rejected` | HUB2 rejette la demande. | Rejetée |

Une demande qui échoue après son approbation ne déclenche aucun webhook : pour les consommateurs de webhooks, elle reste à `processing`.

L'objet `data` de chaque webhook contient :

| Champ | Description |
| :- | :- |
| `id` | Identifiant de la demande de règlement. |
| `reference` | Référence de la demande, telle qu'affichée dans le tableau de bord HUB2. |
| `amount` | Montant de la demande. |
| `currency` | Devise de la demande. |
| `previousStatus` | L'événement qui a précédé celui-ci pour la demande (par exemple `settlement_request.processing` dans un webhook `settlement_request.funds_sent`). Absent de `settlement_request.submitted`. |
| `reason` | Motif du rejet. Présent uniquement dans `settlement_request.rejected`. |

Exemple de webhook `settlement_request.rejected` :

```json theme={null}
{
  "owner": "1234",
  "type": "settlement_request.rejected",
  "data": {
    "id": 42,
    "reference": "SR-3f6c0a52-8a39-4d7c-9a0e-5f1f0a7c1b2d",
    "amount": 500000,
    "currency": "XOF",
    "previousStatus": "settlement_request.submitted",
    "reason": "Demande incomplète. Veuillez contacter votre gestionnaire de compte."
  },
  "test": false,
  "id": "evt_Doc7a41c2e9f0b5d38e6c1",
  "createdAt": "2024-06-06T10:49:36.212Z"
}
```


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