La récupération de listes de paiements peut être effectuée à l’aide du point de terminaison dédié.

Lister les paiements

​
Requête

Voici un exemple de requête vers ce point de terminaison :

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' \
--header 'Content-Type: application/json' \

Notez bien les paramètres suivants :

  • Paramètre from : détermine la date de début de la plage sur laquelle les paiements doivent être récupérés, ici la valeur est 2023-01-01T00:00:00.000Z
  • Paramètre to : détermine la date de fin de la plage sur laquelle les paiements doivent être récupérés, ici la valeur est 2023-01-01T12:00:00.000Z
  • Paramètres page et perPage : permet de naviguer dans les pages de résultats

En cas de trafic élevé, il ne peut pas être attendu de récupérer l’ensemble des paiements sans recourir à la pagination.

​
Pagination

De la pagination est disponible sur ce point de terminaison.

Une en-tête est disponible dans la réponse afin d’identifier le nombre de résultats, c’est l’en-tête Content-Range et son contenu est sous cette forme 0-99/2453.

Dans ce cas particulier, ce sont les 100 premiers résultats sur un total de 2453 - il y a donc 25 pages de 100 résultats à récupérer pour les avoir en totalité.

N’oubliez pas de mettre des filtres de dates également, afin d’être sûr que le nombre de résultats ne change pas entre deux requêtes.

​
Réponse

Les résultats sont automatiquement triés par ordre décroissant de date de création.

Voici un exemple de réponse au format JSON :

[
    {
        "id": "pi_HVSUvR5OvvyZn4ozGonNs",
        "createdAt": "2023-11-06T11:52:18.139Z",
        "updatedAt": "2023-11-06T11:52:26.382Z",
        "merchantId": "wP8PsNc3Je3Djp2FTiQTO",
        "purchaseReference": "purchaseReference",
        "customerReference": "customerReference",
        "amount": 10,
        "currency": "XOF",
        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpbnRlbnRJZCI6InBpX0hWU1V2UjVPdnZ5Wm40b3pHb25OcyIsIm1lcmNoYW50SWQiOiJ3UDhQc05jM0plM0RqcDJGVGlRVE8iLCJtb2RlIjoic2FuZGJveCIsImlhdCI6MTY5OTI3MTUzOH0.Bg2PIujWvtGIlH1jSPRndUiyBD8WBNRuWUQ242GHCZ8",
        "status": "successful",
        "payments": [
            {
                "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": []
            }
        ],
        "mode": "sandbox"
    },
    {
        "id": "pi_-RSGf4F7vqyPxfv2fYGpp",
        "createdAt": "2023-11-06T11:52:17.914Z",
        "updatedAt": "2023-11-06T11:52:25.978Z",
        "merchantId": "wP8PsNc3Je3Djp2FTiQTO",
        "purchaseReference": "purchaseReference",
        "customerReference": "customerReference",
        "amount": 10,
        "currency": "XOF",
        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpbnRlbnRJZCI6InBpXy1SU0dmNEY3dnF5UHhmdjJmWUdwcCIsIm1lcmNoYW50SWQiOiJ3UDhQc05jM0plM0RqcDJGVGlRVE8iLCJtb2RlIjoic2FuZGJveCIsImlhdCI6MTY5OTI3MTUzN30.4XX1HeDk_Be_sEvaBcqx6GfxBB2qrFJu7btHVUyLZII",
        "status": "successful",
        "payments": [
            {
                "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": "successful",
                "method": "mobile_money",
                "country": "CI",
                "provider": "orange",
                "number": "00000001",
                "fees": []
            }
        ],
        "mode": "sandbox"
    },
    {
        "id": "pi_UcRWisVdLCCw2Bq5S7XRl",
        "createdAt": "2023-11-06T11:52:17.677Z",
        "updatedAt": "2023-11-06T11:52:25.665Z",
        "merchantId": "wP8PsNc3Je3Djp2FTiQTO",
        "purchaseReference": "purchaseReference",
        "customerReference": "customerReference",
        "amount": 10,
        "currency": "XOF",
        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpbnRlbnRJZCI6InBpX1VjUldpc1ZkTENDdzJCcTVTN1hSbCIsIm1lcmNoYW50SWQiOiJ3UDhQc05jM0plM0RqcDJGVGlRVE8iLCJtb2RlIjoic2FuZGJveCIsImlhdCI6MTY5OTI3MTUzN30.zOPnbV8pRL0LVWPtU_m2bdW5-KIKBkTfffGbiEOvhKY",
        "status": "successful",
        "payments": [
            {
                "id": "pay_GdhjiFTsMcT4aeXrmK6xJ",
                "intentId": "pi_UcRWisVdLCCw2Bq5S7XRl",
                "createdAt": "2023-11-06T11:52:18.352Z",
                "updatedAt": "2023-11-06T11:52:25.668Z",
                "amount": 10,
                "currency": "XOF",
                "status": "successful",
                "method": "mobile_money",
                "country": "CI",
                "provider": "orange",
                "number": "00000001",
                "fees": []
            }
        ],
        "mode": "sandbox"
    }
]
AuthentificationExemples d'objets