List Payments API

https://api.incasso.io/v2/payments

Met de List Payments API kan je alle betalingen in je incassozaken ophalen met een simpele call.

Wil je de betalingen van een specifieke incassozaak ophalen dan heb je de unieke id van de incassozaak nodig, deze begint altijd met cs_ en wordt ook getoond in het overzicht met betalingen.

Request

Bekijk alle betalingen welke zijn ontvangen binnen je administratie, gerangschikt van nieuw naar oud.

Parameters

limit het aantal betalingen dat zal worden weergegeven (met een maximum van 250).

Response

Resource Geeft aan dat het antwoord een payment (betaling) object bevat. De waarde zal bij deze api-call dan ook altijd paymentzijn.

Id De unieke id gekoppeld aan deze betaling. Deze unieke id wordt altijd automatisch gegenereerd bij het aanmaken van de betaling. Deze id wordt altijd gebruikt om te refereren naar een betaling.

Amount Het bedrag dat is betaald in euro, weergegevens als 100.00.

Created De datum van de betaling, weergegevens als 01-12-2020.

Case Het unieke Case Id, zoals deze bekend is binnen jouw incasso.io administratie. Deze id begint altijd met cs_, bijvoorbeeld cs_8UsSN1zuVS

CaseNumber Het externe dossiernummer van het dossier, zoals deze ook bij de debiteur bekend is, bijvoorbeeld 20120123.

Request voorbeeld

cURL

curl -X GET https://api.incasso.io/v2/payments \
   -H "Authorization: dHar4XY7LxsDOtmnkVtjNVWXLSlXsM" \

PHP

<?php
$incasso = new IncassoApi();
$incasso->setApiKey("dHar4XY7LxsDOtmnkVtjNVWXLSlXsM");
$listdebtcollections = $incasso->listPayments();

ASP

<%
Set IncassoApi = New IncassoApiClient
IncassoApi.setApiKey("dHar4XY7LxsDOtmnkVtjNVWXLSlXsM")
Listdebtcollections = IncassoApi.listPayments()
%>

Response voorbeeld

HTTP/1.1 200 OK
Content-Type: application/hal+json

{
    "count": 4,
    "payments": [{
        "resource": "payment",
        "id": "ec9fed02-3c52-41ec-93dd-bad2f4d5b965",
        "case":"c3097f04-6b98-4887-8d1f-6180356974b2",
        "casenumber":"20120123",
        "amount":"551.40",
        "created":"30-10-2020",
        },
        { },
        { },
        { }
        ]
}