List payments

List payments

GET https://api.notify.cm/v2/payments

Path Parameters

Name	Type	Description
Authorization	string	Your test or live API key

Query Parameters

Name	Type	Description
Limit	string	The number of payments to return (max 250).
From	string	Used for pagination. Offset the result set to the payment with this ID. The payment with this ID is included in the result as well.

200

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

{
   "payments": [
        {
            "resource": "payments",
            "id": "07d125ef-8e59-4629-8ef5-5c82de9979e9",
            "date":"21-01-2021",
            "amount":"100.00",
            "invoice": {
                "id":"a0f0660d-6c8d-422b-8114-e363b260521e",
                "number":"10001",
                "invoiceTotal":"480.00",
                "invoiceBalance":"380.00"
            },
            "customer": {
                "id":"36cf1c0d-53fe-4c73-8a46-f9f40cd99b65",
                "number":"10001",
                "name":"Creditparters B.V."
            }
        }, 
        {},
        {},
        {}
   ],
   "count": 5,
   "links": {
        "previous": null,
        "next": {
            "href": "https://api.notify.cm/v2/payments?from=07d125ef-8e59-4629-8ef5-5c82de9979e9",
            "type": "application/hal+json"
        }
   }
}

Example

curl -X GET https://api.notify.cm/v2/payments \
   -H "Authorization: Bearer test_R7HQ9QpXgx8J32rW9X9UyXjgfNk6C7TQ2UD8M5rwf8vVnYxnSETvSuEC6SKFW8Ug" \

Response

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

{
   "payments": [
        {
            "resource": "payments",
            "id": "07d125ef-8e59-4629-8ef5-5c82de9979e9",
            "date":"21-01-2021",
            "amount":"100.00",
            "invoice": {
                "id":"a0f0660d-6c8d-422b-8114-e363b260521e",
                "number":"10001",
                "invoiceTotal":"480.00",
                "invoiceBalance":"380.00"
            },
            "customer": {
                "id":"36cf1c0d-53fe-4c73-8a46-f9f40cd99b65",
                "number":"10001",
                "name":"Creditparters B.V."
            }
        }, 
        {},
        {},
        {}
   ],
   "count": 5,
   "links": {
        "previous": null,
        "next": {
            "href": "https://api.notify.cm/v2/payments?from=07d125ef-8e59-4629-8ef5-5c82de9979e9",
            "type": "application/hal+json"
        }
   }
}