Get customers requesting direct debit
GET {{AppUrl}}/api/v1/issuer/customer/debit-requested
Introduction
Get all customers that have requested direct debit as a payment type. Only customers that have not yet been authorized for direct debit will be returned.
Structure
| Item | Type | Plurality | Options | Required | Description | |
|---|---|---|---|---|---|---|
| id | integer | 1 | yes | Identifier. | ||
| first_name | varchar(255) | 1 | yes | First name. | ||
| initials | varchar(255) | 1 | yes | Initials. | ||
| infix | varchar(255) | 1 | no | Infix. | ||
| last_name | varchar(255) | 1 | yes | Last name. | ||
| gender | varchar(1) | 1 | m f | yes | Gender (male or female). | |
| phone_number | varchar(255) | 1 | yes | Phonenumber. | ||
| mobilephonenumber | varchar(255) | 1 | yes | Mobile phonenumber. | ||
| varchar(255) | 1 | yes | E-mail address. | |||
| dateofbirth | DateTime | 1 | yes | Date of birth. | ||
| payment_method | varchar(50) | 1 | cash direct-debit | yes | Payment method. | |
| directdebitrequested_at | DateTime | 1 | yes | Date and time when direct debit authorization was requested for this customer. | ||
| directdebitauthorized_at | DateTime | 1 | no | Date and time when direct debit request was authorized. | ||
| municipality_code | varchar(4) | 1 | yes | The numeric code of the municipality. | ||
| addresses | array | N | yes | Home, post and billing are required. Extra custom addresses are optional. | ||
| type | varchar(255) | 1 | home post billing custom | yes | Type of address (home, post, billing or custom). | |
| differentfromhome | boolean | 1 | 0 1 | yes | Indicates whether this address differs from the home address. | |
| label | varchar(255) | 1 | yes* | Label to identify the type of custom address. *Only required on addresses of type 'custom'. | ||
| street | varchar(255) | 1 | yes* | Street name. *Required on the home address and any addresses that have 'differentfromhome' set to 1. | ||
| number | varchar(255) | 1 | yes* | House number. *Required on the home address and any addresses that have 'differentfromhome' set to 1. | ||
| addition | varchar(255) | 1 | no | House number addition. | ||
| postcode | varchar(255) | 1 | yes* | Postal code. *Required on the home address and any addresses that have 'differentfromhome' set to 1. | ||
| city | varchar(255) | 1 | yes* | City. *Required on the home address and any addresses that have 'differentfromhome' set to 1. | ||
| created_at | DateTime | 1 | yes | Date/time the customer was created. | ||
| updated_at | DateTime | 1 | yes | Date/time customer was last modified. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"data":[{"id":57,"first_name":"Quinten","initials":"Q","infix":"","last_name":"Hussain","gender":"m","phone_number":"011 8486903","mobile_phone_number":"+316 13036885","email":"ejonker@example.net","date_of_birth":"2001-11-16T00:00:00+01:00","bankaccount":"NL27YBGI2209095944","bankaccount_name":"D Blewanus","payment_method":"cash","direct_debit_requested_at":"2018-12-06T06:05:24+01:00","direct_debit_authorized_at":null,"municipality_code":"8136","blocked":false,"addresses":[{"type":"home","different_from_home":1,"label":null,"street":"Appelmanhof","number":"1859","addition":null,"postcode":"1531KA","city":"Wagenberg"},{"type":"post","different_from_home":0,"label":null,"street":null,"number":null,"addition":null,"postcode":null,"city":null},{"type":"billing","different_from_home":1,"label":null,"street":"van de Veldendreef","number":"2347","addition":"b","postcode":"4793CM","city":"Vroomshoop"},{"type":"custom","different_from_home":0,"label":"Modi est","street":"van den Bergpad","number":"1641","addition":"bis","postcode":"4131NE","city":"Mantgum"},{"type":"custom","different_from_home":0,"label":"Soluta qui","street":"Neuteboompad","number":"3221","addition":"c","postcode":"1068NE","city":"Heilig Landstichting"},{"type":"custom","different_from_home":0,"label":"Vero nam","street":"van den Bergstraat","number":"2362","addition":"b","postcode":"3034VE","city":"Oosteind"},{"type":"custom","different_from_home":0,"label":"Quasi velit","street":"van der Polstraat","number":"349","addition":"c","postcode":"1121JC","city":"Nieuwland"},{"type":"custom","different_from_home":0,"label":"Sit provident","street":"Kurtdreef","number":"3187","addition":null,"postcode":"7557VC","city":"Hempens"}],"created_at":"2018-12-10T15:23:21+01:00","updated_at":"2018-12-10T15:23:27+01:00"},{"id":61,"first_name":"Helena","initials":"H","infix":"van der","last_name":"Mast","gender":"m","phone_number":"+3120 5852978","mobile_phone_number":"+31(0)6-43813624","email":"mvandewater@example.org","date_of_birth":"1995-03-19T00:00:00+01:00","bankaccount":"NL27YBGI2209095944","bankaccount_name":"D Blewanus","payment_method":"cash","direct_debit_requested_at":"2018-11-22T11:02:45+01:00","direct_debit_authorized_at":null,"municipality_code":"4808","addresses":[{"type":"home","different_from_home":1,"label":null,"street":"Lambregtlaan","number":"220","addition":null,"postcode":"2231BB","city":"Heusden"},{"type":"post","different_from_home":1,"label":null,"street":"die Bontpad","number":"818","addition":"b","postcode":"7622VX","city":"Vlist"},{"type":"billing","different_from_home":0,"label":null,"street":null,"number":null,"addition":null,"postcode":null,"city":null},{"type":"custom","different_from_home":0,"label":"Suscipit facere","street":"van Estedreef","number":"572","addition":null,"postcode":"9751TS","city":"IJsselmuiden"},{"type":"custom","different_from_home":0,"label":"Non iusto","street":"de Groteboulevard","number":"2782","addition":null,"postcode":"7722XJ","city":"Wier"},{"type":"custom","different_from_home":0,"label":"Laboriosam sint","street":"Blomdreef","number":"3120","addition":null,"postcode":"3527EJ","city":"'t Zandt"},{"type":"custom","different_from_home":0,"label":"Quibusdam voluptas","street":"Mahabiersteeg","number":"294","addition":"a","postcode":"4371EN","city":"Warffum"}],"created_at":"2018-12-10T15:23:22+01:00","updated_at":"2018-12-10T15:23:28+01:00"},{"id":62,"first_name":"Lily","initials":"L","infix":"","last_name":"Peeters","gender":"f","phone_number":"+3173 3526773","mobile_phone_number":"+31(0)6-43813624","email":"vanderkint.naud@example.net","date_of_birth":"2012-10-29T00:00:00+01:00","bankaccount":"NL27YBGI2209095944","bankaccount_name":"D Blewanus","payment_method":"cash","direct_debit_requested_at":"2018-12-06T01:13:46+01:00","direct_debit_authorized_at":null,"municipality_code":"4808","addresses":[{"type":"home","different_from_home":1,"label":null,"street":"Kösterboulevard","number":"730","addition":"c","postcode":"7311AL","city":"Langezwaag"},{"type":"post","different_from_home":0,"label":null,"street":null,"number":null,"addition":null,"postcode":null,"city":null},{"type":"billing","different_from_home":0,"label":null,"street":null,"number":null,"addition":null,"postcode":null,"city":null},{"type":"custom","different_from_home":0,"label":"Cum recusandae","street":"de Bruinweg","number":"747","addition":"bis","postcode":"3527EJ","city":"Buurmalsen"},{"type":"custom","different_from_home":0,"label":"Alias voluptatibus","street":"Ramosring","number":"2698","addition":null,"postcode":"8231JL","city":"Aldeboarn"}],"created_at":"2018-12-10T15:23:22+01:00","updated_at":"2018-12-10T15:24:26+01:00"},{"id":63,"first_name":"Lola","initials":"L","infix":"de","last_name":"Haan","gender":"m","phone_number":"+3120 5852978","mobile_phone_number":"+31(0)6 10433663","email":"tvanderlaar@example.org","date_of_birth":"1936-06-16T00:00:00+01:19","bankaccount":"NL27YBGI2209095944","bankaccount_name":"D Blewanus","payment_method":"cash","direct_debit_requested_at":"2018-12-03T13:00:39+01:00","direct_debit_authorized_at":null,"municipality_code":"4808","addresses":[{"type":"home","different_from_home":1,"label":null,"street":"Schoutenboulevard","number":"1735","addition":null,"postcode":"8121SB","city":"Kerkdriel"},{"type":"post","different_from_home":1,"label":null,"street":"Karacaweg","number":"3352","addition":"b","postcode":"4011KH","city":"Wetsens"},{"type":"billing","different_from_home":1,"label":null,"street":"Ariens Ansemslaan","number":"96","addition":null,"postcode":"5061NA","city":"Lutjebroek"},{"type":"custom","different_from_home":0,"label":"Sit amet","street":"Avcisteeg","number":"3070","addition":"b","postcode":"1448VB","city":"Wijster"},{"type":"custom","different_from_home":0,"label":"Ex et","street":"Jansenlaan","number":"1318","addition":null,"postcode":"8472DA","city":"De Wilp"},{"type":"custom","different_from_home":0,"label":"Ea a","street":"Kallenstraat","number":"358","addition":null,"postcode":"4698BG","city":"Steensel"}],"created_at":"2018-12-10T15:23:22+01:00","updated_at":"2018-12-10T15:24:26+01:00"}],"links":{"first":"https://vitapp.localtest.me/api/v1/issuer/customer/debit-requested?page=1","last":"https://vitapp.localtest.me/api/v1/issuer/customer/debit-requested?page=1","prev":null,"next":null},"meta":{"current_page":1,"from":1,"last_page":1,"path":"https://vitapp.localtest.me/api/v1/issuer/customer/debit-requested","per_page":50,"to":4,"total":4}}