To get a list of Payment Costumers the model PaymentCustomersDTO needs to be passed to the method paymentCustomersGet of the class PaymentCustomersApi.

As (successful) response will return the model PaymentCustomersList back.

Api

Endpoint
GET https://connect.secucard.com/api/v2/Payment/Customers
Header

Accept:application/json
Content-Type:application/json
Accept-Charset:utf-8
Authorization:Bearer {{access_token}}

Response

Sample

{
    "count": 10848,
    "data": [
		{
            "object": "payment.customers",
            "id": "PCU_24AQMUZKP2NC28QJN0ZAVFGU4GJ3A2",
            "contract": {
                "object": "payment.contracts",
                "id": "PCR_M32....PAH"
            },
            "contact": {
                "forename": "John",
                "surname": "Doe",
                "companyname": "Example Inc.",
                "name": "John Doe",
                "salutation": "Mr.",
                "title": "Dr.",
                "address": {
                    "street": "Example Street",
                    "street_number": "6a",
                    "postal_code": "01234",
                    "city": "Examplecity",
                    "country": "Germany"
                },
                "email": "example@example.com",
                "mobile": "0049-987-654321",
                "phone": "0049-123-456789",
                "dob": "1901-02-03T00:00:00+01:00"
            },
            "created": "2019-09-18T17:00:55+02:00"
        },
        {
            "object": "payment.customers",
            "id": "PCU_XXXX",
            "contract": {
                "object": "payment.contracts",
                "id": "PCR_XXXX"
            },
            "contact": {
                "forename": "Max",
                "surname": "Mustermann",
                "name": "Max Mustermann",
                "address": {
                    "street": "test-street",
                    "street_number": "4",
                    "postal_code": "84030",
                    "city": "Landshut"
                },
                "email": "test@email.com"
            },
            "created": "2019-07-30T14:12:58+02:00"
        }
   ]
}

Properties

NameTypeDescriptionSampleNotes
countIntegerNumber of existing payment customers10848The number of all available entities you can get.
This is not equal the number you got (dis is by default limited to 10 entries)
dataList<Model\PaymentCustomersProductModel>Payment customers model
See PaymentCustomersProductModel