> ## 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.

# Lister les paiements

Utilisez le point de terminaison dédié pour récupérer une liste de paiements.

[Lister les paiements](https://docs.hub2.io/api-reference/payments/retrieve-a-payments-collection.md)

## Requête

Exemple de requête :

```bash Curl theme={null}
curl --location --request GET 'https://api.hub2.io/payments?from=2023-01-01T00:00:00.000Z&to=2023-01-01T12:00:00.000Z&page=1&perPage=100' \
--header 'ApiKey: [REDACTED]' \
--header 'MerchantId: [REDACTED]' \
--header 'Environment: sandbox'
```

```typescript Typescript theme={null}
import fetch from 'node-fetch';

async function getPayments() {
    const response = await fetch('https://api.hub2.io/payments?from=2023-01-01T00:00:00.000Z&to=2023-01-01T12:00:00.000Z&page=1&perPage=100', {
        method: 'GET',
        headers: {
            'ApiKey': '[REDACTED]',
            'MerchantId': '[REDACTED]',
            'Environment': 'sandbox'
        }
    });

    if (response.ok) {
        const result = await response.json();
        console.log(result);
    } else {
        console.log(`HTTP Status: ${response.status}`);
    }
}

getPayments();
```

```python Python theme={null}
import requests

url = 'https://api.hub2.io/payments?from=2023-01-01T00:00:00.000Z&to=2023-01-01T12:00:00.000Z&page=1&perPage=100'

headers = {
    'ApiKey': '[REDACTED]',
    'MerchantId': '[REDACTED]',
    'Environment': 'sandbox',
}

response = requests.get(url, headers=headers)

if response.ok:
    print(response.json())
else:
    print(f'HTTP Status: {response.status_code}')
```

Paramètres de la requête :

* `from` : début de la plage de dates, appliquée à la date de création des paiements, ici `2023-01-01T00:00:00.000Z`.
* `to` : fin de la plage de dates, appliquée à la date de création des paiements, ici `2023-01-01T12:00:00.000Z`.
* `page` et `perPage` : permettent de naviguer dans les pages de résultats. `perPage` vaut `10` par défaut.
* `isDelegated` (facultatif) : `true` ne renvoie que les paiements [Processing Only](https://docs.hub2.io/integration/fr/processing_only/processing_only_introduction.md), `false` uniquement les autres. Lorsque ce paramètre est renseigné, `from` est obligatoire et la plage de dates doit être inférieure à un an.

> [!WARNING]
>
> Ce point de terminaison est limité à **1 requête toutes les 30 secondes**. Au-delà, l'API renvoie `HTTP 429 - Too Many Requests`.

> [!WARNING]
>
> **En cas de trafic élevé, il est impossible de récupérer tous les paiements sans pagination.**

### Pagination

> [!NOTE]
>
> L'en-tête de réponse `Content-Range` indique la plage des résultats renvoyés, par exemple `0-99/999999`. La valeur après la barre oblique n'est pas le nombre exact de paiements correspondants.

Pour récupérer tous les paiements d'une plage de dates, demandez la page suivante jusqu'à obtenir une page contenant moins de résultats que `perPage`.

Renseignez toujours les filtres de dates, afin que l'ensemble des résultats ne change pas entre deux requêtes.

## Réponse

> [!NOTE]
>
> Les résultats sont triés par date de création, par ordre décroissant.

La réponse est un tableau d'objets `Payment` :

```json theme={null}
[
    {
        "id": "pay_vhmS6bGBsTCP08rXOAFZJ",
        "intentId": "pi_HVSUvR5OvvyZn4ozGonNs",
        "createdAt": "2023-11-06T11:52:18.891Z",
        "updatedAt": "2023-11-06T11:52:26.402Z",
        "amount": 10,
        "currency": "XOF",
        "status": "successful",
        "method": "mobile_money",
        "country": "CI",
        "provider": "orange",
        "number": "00000001",
        "fees": [],
        "isDelegated": false
    },
    {
        "id": "pay_uEBdIHJLwytg6phBvhg3d",
        "intentId": "pi_-RSGf4F7vqyPxfv2fYGpp",
        "createdAt": "2023-11-06T11:52:18.605Z",
        "updatedAt": "2023-11-06T11:52:25.986Z",
        "amount": 10,
        "currency": "XOF",
        "status": "failed",
        "method": "mobile_money",
        "country": "CI",
        "provider": "orange",
        "number": "00000100",
        "fees": [],
        "failure": {
            "code": "authentication_failed",
            "message": "Le paiement a échoué. La validation du paiement par le client a échoué."
        },
        "isDelegated": false
    }
]
```


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