OVPAY-1293 - Processed review remarks myself.

This commit is contained in:
Bas Boterman 2025-03-17 10:57:15 +01:00
parent db12ae5f62
commit efb62a6abd

View File

@ -43,6 +43,23 @@ paths:
items: items:
type: integer type: integer
description: Filter on possible debtor statuses. 1 = Active, 2 = Inactive description: Filter on possible debtor statuses. 1 = Active, 2 = Inactive
- name: vasCustomerNumber
in: query
schema:
type: string
example: VAS100001
- name: lastLoginBefore
in: query
schema:
type: string
format: date-time
example: "2022-08-04 15:01:00.000"
- name: lastLoginAfter
in: query
schema:
type: string
format: date-time
example: "2022-08-04 15:01:00.000"
- name: birthname - name: birthname
in: query in: query
schema: schema:
@ -57,7 +74,7 @@ paths:
in: query in: query
schema: schema:
type: string type: string
example: De example: de
- name: suffix - name: suffix
in: query in: query
schema: schema:
@ -203,7 +220,7 @@ paths:
debtorStatus: debtorStatus:
debtorStatusId: 1 debtorStatusId: 1
name: Inactive name: Inactive
vascustomerNumber: CST005 vasCustomerNumber: CST005
customerPreference: customerPreference:
language: language:
languageId: 1 languageId: 1
@ -218,8 +235,8 @@ paths:
toInclusive: "2022-08-05 15:01:00.000" toInclusive: "2022-08-05 15:01:00.000"
person: person:
birthname: Pieter birthname: Pieter
surname: De valen surname: Valen
prefix: De prefix: de
suffix: PhD suffix: PhD
dateOfBirth: "2002-10-29" dateOfBirth: "2002-10-29"
emailAddresses: TEST@HTM.NL emailAddresses: TEST@HTM.NL
@ -308,10 +325,11 @@ paths:
correlationId: 01c6d8b4-1cd3-4f9b-85ea-c9adca53ce95 correlationId: 01c6d8b4-1cd3-4f9b-85ea-c9adca53ce95
_links: _links:
{ {
"self":{ "self":
{
"href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/customers?customerProfileId=1", "href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/customers?customerProfileId=1",
"method": "GET" "method": "GET",
} },
} }
- customerProfileId: 12 - customerProfileId: 12
customerNumber: 1000002 customerNumber: 1000002
@ -319,7 +337,7 @@ paths:
debtorStatus: debtorStatus:
debtorStatusId: 1 debtorStatusId: 1
name: Inactive name: Inactive
vascustomerNumber: CST005 vasCustomerNumber: CST005
customerPreference: customerPreference:
language: language:
languageId: 1 languageId: 1
@ -344,8 +362,8 @@ paths:
toInclusive: null toInclusive: null
person: person:
birthname: Pieter birthname: Pieter
surname: De valen surname: Valen
prefix: De prefix: de
suffix: PhD suffix: PhD
dateOfBirth: "2002-10-29" dateOfBirth: "2002-10-29"
emailAddresses: TEST@HTM.NL emailAddresses: TEST@HTM.NL
@ -434,25 +452,29 @@ paths:
correlationId: 01c6d8b4-1cd3-4f9b-85ea-c9adca53ce95 correlationId: 01c6d8b4-1cd3-4f9b-85ea-c9adca53ce95
_links: _links:
{ {
"self":{ "self":
{
"href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/customers?customerProfileId=12", "href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/customers?customerProfileId=12",
"method": "GET" "method": "GET",
} },
} }
_links: _links:
{ {
"self":{ "self":
{
"href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/customers?offset=20", "href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/customers?offset=20",
"method": "GET" "method": "GET",
}, },
"prev":{ "prev":
{
"href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/customers", "href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/customers",
"method": "GET" "method": "GET",
}, },
"next":{ "next":
{
"href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/customers?offset=40", "href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/customers?offset=40",
"method": "GET" "method": "GET",
} },
} }
getCustomerActive: getCustomerActive:
summary: getCustomerActive summary: getCustomerActive
@ -466,7 +488,7 @@ paths:
debtorStatus: debtorStatus:
debtorStatusId: 1 debtorStatusId: 1
name: Inactive name: Inactive
vascustomerNumber: CST005 vasCustomerNumber: CST005
customerPreference: customerPreference:
language: language:
languageId: 1 languageId: 1
@ -481,8 +503,8 @@ paths:
toInclusive: null toInclusive: null
person: person:
birthname: Pieter birthname: Pieter
surname: De valen surname: Valen
prefix: De prefix: de
suffix: PhD suffix: PhD
dateOfBirth: "2002-10-29" dateOfBirth: "2002-10-29"
emailAddresses: TEST@HTM.NL emailAddresses: TEST@HTM.NL
@ -571,17 +593,19 @@ paths:
correlationId: 01c6d8b4-1cd3-4f9b-85ea-c9adca53ce95 correlationId: 01c6d8b4-1cd3-4f9b-85ea-c9adca53ce95
_links: _links:
{ {
"self":{ "self":
{
"href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/customers?customerProfileId=1", "href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/customers?customerProfileId=1",
"method": "GET" "method": "GET",
} },
} }
_links: _links:
{ {
"self":{ "self":
{
"href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/customers", "href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/customers",
"method": "GET" "method": "GET",
} },
} }
getCustomerBlocked: getCustomerBlocked:
summary: getCustomerBlocked summary: getCustomerBlocked
@ -595,7 +619,7 @@ paths:
debtorStatus: debtorStatus:
debtorStatusId: 2 debtorStatusId: 2
name: Active name: Active
vascustomerNumber: CST005 vasCustomerNumber: CST005
customerPreference: customerPreference:
language: language:
languageId: 1 languageId: 1
@ -615,8 +639,8 @@ paths:
toInclusive: null toInclusive: null
person: person:
birthname: Pieter birthname: Pieter
surname: De valen surname: Valen
prefix: De prefix: de
suffix: PhD suffix: PhD
dateOfBirth: "2002-10-29" dateOfBirth: "2002-10-29"
emailAddresses: TEST@HTM.NL emailAddresses: TEST@HTM.NL
@ -705,17 +729,19 @@ paths:
correlationId: 01c6d8b4-1cd3-4f9b-85ea-c9adca53ce95 correlationId: 01c6d8b4-1cd3-4f9b-85ea-c9adca53ce95
_links: _links:
{ {
"self":{ "self":
{
"href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/customers?customerProfileId=1", "href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/customers?customerProfileId=1",
"method": "GET" "method": "GET",
} },
} }
_links: _links:
{ {
"self":{ "self":
{
"href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/customers", "href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/customers",
"method": "GET" "method": "GET",
} },
} }
400: 400:
description: Bad Request description: Bad Request
@ -731,7 +757,7 @@ paths:
value: value:
type: https://htm.nl/api/v1/probs/bad-request type: https://htm.nl/api/v1/probs/bad-request
title: Your request contains an invalid datatype title: Your request contains an invalid datatype
detail: '''2023-02-01 00:00:00'' is not a valid Datetime' detail: "'2023-02-01 00:00:00' is not a valid Datetime"
instance: urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b instance: urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b
security: security:
- default: [] - default: []
@ -748,6 +774,8 @@ paths:
- Requested format for postal code: - Requested format for postal code:
- 0000AA - 0000AA
- Requested format for country:
- NL
parameters: [] parameters: []
requestBody: requestBody:
content: content:
@ -772,7 +800,7 @@ paths:
person: person:
birthname: Jan birthname: Jan
surname: Jansen surname: Jansen
prefix: dhr prefix: de
suffix: jr suffix: jr
dateOfBirth: "1970-01-01" dateOfBirth: "1970-01-01"
emailAddress: j.jansen@hatseflats.nl emailAddress: j.jansen@hatseflats.nl
@ -818,6 +846,7 @@ paths:
value: value:
customerProfileId: 1 customerProfileId: 1
customerNumber: 1000001 customerNumber: 1000001
debtorNumber: DB100001
400: 400:
description: Bad Request description: Bad Request
content: content:
@ -832,7 +861,7 @@ paths:
value: value:
type: https://htm.nl/api/v1/probs/bad-request type: https://htm.nl/api/v1/probs/bad-request
title: Your request contains an invalid datatype title: Your request contains an invalid datatype
detail: '''2023-02-01 00:00:00'' is not a valid Datetime' detail: "'2023-02-01 00:00:00' is not a valid Datetime"
instance: urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b instance: urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b
security: security:
- default: [] - default: []
@ -904,7 +933,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/postCustomerPreferencesResponse" $ref: "#/components/schemas/postCustomerStatusResponse"
security: security:
- default: [] - default: []
x-auth-type: Application & Application User x-auth-type: Application & Application User
@ -1077,8 +1106,7 @@ paths:
200: 200:
description: Successfully deleted a customer Address description: Successfully deleted a customer Address
content: content:
application/json: application/json: {}
{}
security: security:
- default: [] - default: []
x-auth-type: Application & Application User x-auth-type: Application & Application User
@ -1175,8 +1203,7 @@ paths:
200: 200:
description: Successfully deleted a customer phonenumber description: Successfully deleted a customer phonenumber
content: content:
application/json: application/json: {}
{}
security: security:
- default: [] - default: []
x-auth-type: Application & Application User x-auth-type: Application & Application User
@ -1317,19 +1344,22 @@ paths:
], ],
"_links": "_links":
{ {
"self":{ "self":
{
"href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/ovPayTokens?offset=20", "href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/ovPayTokens?offset=20",
"method": "GET" "method": "GET",
}, },
"prev":{ "prev":
{
"href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/ovPayTokens", "href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/ovPayTokens",
"method": "GET" "method": "GET",
}, },
"next":{ "next":
{
"href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/ovPayTokens?offset=40", "href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/ovPayTokens?offset=40",
"method": "GET" "method": "GET",
} },
} },
} }
/customers/{customerProfileId}/ovpaytokens: /customers/{customerProfileId}/ovpaytokens:
post: post:
@ -1444,8 +1474,7 @@ paths:
200: 200:
description: Successfully deleted a customer ovpaytoken description: Successfully deleted a customer ovpaytoken
content: content:
application/json: application/json: {}
{}
security: security:
- default: [] - default: []
x-auth-type: Application & Application User x-auth-type: Application & Application User
@ -1541,8 +1570,7 @@ paths:
200: 200:
description: Successfully deleted a customer ovchipcard description: Successfully deleted a customer ovchipcard
content: content:
application/json: application/json: {}
{}
security: security:
- default: [] - default: []
x-auth-type: Application & Application User x-auth-type: Application & Application User
@ -1617,7 +1645,8 @@ paths:
Found multiple billing informations matching the search parameters Found multiple billing informations matching the search parameters
value: value:
{ {
"billingInformations":[ "billingInformations":
[
{ {
"billingInformationId": 1, "billingInformationId": 1,
"customerProfileId": 1, "customerProfileId": 1,
@ -1625,7 +1654,7 @@ paths:
"iban": "NL06RABO8902022560", "iban": "NL06RABO8902022560",
"ascription": "J. Doe", "ascription": "J. Doe",
"alias": null, "alias": null,
"billingAddressId": 3 "billingAddressId": 3,
}, },
{ {
"billingInformationId": 2, "billingInformationId": 2,
@ -1635,9 +1664,9 @@ paths:
"bic": "GHJZIEJSKVM", "bic": "GHJZIEJSKVM",
"ascription": "J. Doe", "ascription": "J. Doe",
"alias": "John's billing details", "alias": "John's billing details",
"billingAddressId": 4 "billingAddressId": 4,
} },
] ],
} }
getBillingInformationSingleSpecificCustomer: getBillingInformationSingleSpecificCustomer:
summary: Get singel billing information entity for a specific customers summary: Get singel billing information entity for a specific customers
@ -1645,7 +1674,8 @@ paths:
Found one billing information matching the search parameters Found one billing information matching the search parameters
value: value:
{ {
"billingInformations":[ "billingInformations":
[
{ {
"billingInformationId": 1, "billingInformationId": 1,
"customerProfileId": 1, "customerProfileId": 1,
@ -1653,9 +1683,9 @@ paths:
"iban": "NL06RABO8902022560", "iban": "NL06RABO8902022560",
"ascription": "J. Doe", "ascription": "J. Doe",
"alias": null, "alias": null,
"billingAddressId": 3 "billingAddressId": 3,
} },
] ],
} }
getBillingInformationIssuerCountry: getBillingInformationIssuerCountry:
summary: Get multiple billing information entities for a specific issuer country summary: Get multiple billing information entities for a specific issuer country
@ -1663,7 +1693,8 @@ paths:
Found multiple billing informations matching the search parameters Found multiple billing informations matching the search parameters
value: value:
{ {
"billingInformations":[ "billingInformations":
[
{ {
"billingInformationId": 1, "billingInformationId": 1,
"customerProfileId": 1, "customerProfileId": 1,
@ -1671,7 +1702,7 @@ paths:
"iban": "NL06RABO8902022560", "iban": "NL06RABO8902022560",
"ascription": "J. Doe", "ascription": "J. Doe",
"alias": null, "alias": null,
"billingAddressId": 3 "billingAddressId": 3,
}, },
{ {
"billingInformationId": 2, "billingInformationId": 2,
@ -1681,7 +1712,7 @@ paths:
"bic": "GHJZIEJSKVM", "bic": "GHJZIEJSKVM",
"ascription": "J. Doe", "ascription": "J. Doe",
"alias": null, "alias": null,
"billingAddressId": 42 "billingAddressId": 42,
}, },
{ {
"billingInformationId": 11, "billingInformationId": 11,
@ -1691,9 +1722,9 @@ paths:
"bic": "GHJZIEJSKVM", "bic": "GHJZIEJSKVM",
"ascription": "J. Doe", "ascription": "J. Doe",
"alias": null, "alias": null,
"billingAddressId": 84 "billingAddressId": 84,
} },
] ],
} }
/customers/{customerProfileId}/billingInformations: /customers/{customerProfileId}/billingInformations:
post: post:
@ -1782,7 +1813,16 @@ paths:
description: Successfully updated a customer billing information description: Successfully updated a customer billing information
content: content:
application/json: application/json:
{} example:
{
"billingInformationId": 1,
"customerProfileId": 1,
"issuerCountry": "NL",
"iban": "NL06RABO8902022560",
"ascription": "J. Doe",
"alias": "Mijn rekening details",
"billingAddressId": 4,
}
security: security:
- default: [] - default: []
x-auth-type: Application & Application User x-auth-type: Application & Application User
@ -1905,7 +1945,8 @@ paths:
getDirectDebitMandateWithNextPage: getDirectDebitMandateWithNextPage:
value: value:
{ {
"directDebitMandates": [ "directDebitMandates":
[
{ {
"directDebitMandateId": 71, "directDebitMandateId": 71,
"customerProfileId": 12, "customerProfileId": 12,
@ -1921,23 +1962,27 @@ paths:
"mandateReference": "CORE01", "mandateReference": "CORE01",
"mandateState": "SINGED", "mandateState": "SINGED",
"updateTimestamp": "2024-03-22T08:55:00", "updateTimestamp": "2024-03-22T08:55:00",
}
],
"_links": {
"self":{
"href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/directdebitmandates",
"method": "GET"
}, },
"next":{ ],
"_links":
{
"self":
{
"href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/directdebitmandates",
"method": "GET",
},
"next":
{
"href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/directdebitmandates?offset=20", "href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/directdebitmandates?offset=20",
"method": "GET" "method": "GET",
} },
} },
} }
getDirectDebitMandateWithNextPageandPreviousPage: getDirectDebitMandateWithNextPageandPreviousPage:
value: value:
{ {
"directDebitMandates": [ "directDebitMandates":
[
{ {
"directDebitMandateId": 71, "directDebitMandateId": 71,
"customerProfileId": 12, "customerProfileId": 12,
@ -1953,22 +1998,26 @@ paths:
"mandateReference": "CORE01", "mandateReference": "CORE01",
"mandateState": "SINGED", "mandateState": "SINGED",
"updateTimestamp": "2024-03-22T08:55:00", "updateTimestamp": "2024-03-22T08:55:00",
} },
], ],
"_links": { "_links":
"self":{ {
"self":
{
"href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/directdebitmandates?offset=20", "href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/directdebitmandates?offset=20",
"method": "GET" "method": "GET",
}, },
"prev":{ "prev":
{
"href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/directdebitmandates", "href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/directdebitmandates",
"method": "GET" "method": "GET",
}, },
"next":{ "next":
{
"href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/directdebitmandates?offset=40", "href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/directdebitmandates?offset=40",
"method": "GET" "method": "GET",
} },
} },
} }
/billingInformation/{billingInformationId}/directdebitmandates: /billingInformation/{billingInformationId}/directdebitmandates:
post: post:
@ -2029,7 +2078,7 @@ paths:
schema: schema:
$ref: "#/components/schemas/mandateEntity" $ref: "#/components/schemas/mandateEntity"
examples: examples:
customerDirectDebitMandatePrepared: customerDirectDebitMandateCancelled:
value: value:
directDebitMandate: directDebitMandate:
mandateState: CANCELLED mandateState: CANCELLED
@ -2039,12 +2088,27 @@ paths:
description: Successfully updated a customer mandate description: Successfully updated a customer mandate
content: content:
application/json: application/json:
{} example:
{
"directDebitMandateId": 1,
"customerProfileId": 12,
"billingInformationId": 51,
"directDebitMandateType":
{
"directDebitMandateTypeId": 1,
"name": "import",
"description": "import",
},
"mandateAddressId": 21,
"created": "2024-03-22T08:55:00",
"mandateReference": "CORE01",
"mandateState": "CANCELLED",
"updateTimestamp": "2025-03-22T08:55:00",
}
security: security:
- default: [] - default: []
x-auth-type: Application & Application User x-auth-type: Application & Application User
x-throttling-tier: Unlimited x-throttling-tier: Unlimited
components: components:
securitySchemes: securitySchemes:
default: default:
@ -2163,12 +2227,16 @@ components:
properties: properties:
birthname: birthname:
type: string type: string
description: voornaam
surname: surname:
type: string type: string
description: achternaam
prefix: prefix:
type: string type: string
description: tussenvoegsel
suffix: suffix:
type: string type: string
description: achtervoegsel
dateOfBirth: dateOfBirth:
type: string type: string
format: date format: date
@ -2263,7 +2331,7 @@ components:
type: integer type: integer
debtorStatus: debtorStatus:
$ref: "#/components/schemas/getDebtorStatus" $ref: "#/components/schemas/getDebtorStatus"
vascustomerNumber: vasCustomerNumber:
type: integer type: integer
customerPreference: customerPreference:
$ref: "#/components/schemas/getCustomerPreference" $ref: "#/components/schemas/getCustomerPreference"
@ -2349,17 +2417,17 @@ components:
debtorStatusId: debtorStatusId:
type: integer type: integer
customerPreference: customerPreference:
$ref: '#/components/schemas/customerPreferencesEntity' $ref: "#/components/schemas/customerPreferencesEntity"
person: person:
$ref: '#/components/schemas/personEntity' $ref: "#/components/schemas/personEntity"
addresses: addresses:
type: array type: array
items: items:
$ref: '#/components/schemas/addressPostEntity' $ref: "#/components/schemas/addressPostEntity"
phones: phones:
type: array type: array
items: items:
$ref: '#/components/schemas/postPhoneEntity' $ref: "#/components/schemas/postPhoneEntity"
postCustomerAddress: postCustomerAddress:
type: object type: object
properties: properties:
@ -2573,12 +2641,16 @@ components:
type: integer type: integer
birthname: birthname:
type: string type: string
description: voornaam
surname: surname:
type: string type: string
description: achternaam
prefix: prefix:
type: string type: string
description: tussenvoegsel
suffix: suffix:
type: string type: string
description: achtervoegsel
dateOfBirth: dateOfBirth:
type: string type: string
format: date format: date