Merge pull request 'updated customer CRUD' (#41) from feature/OVPAY-1700-customer-address into develop
Reviewed-on: #41
This commit is contained in:
commit
18c507195d
@ -3033,9 +3033,6 @@ components:
|
||||
addressId:
|
||||
type: integer
|
||||
example: 1
|
||||
isPreferred:
|
||||
type: boolean
|
||||
example: true
|
||||
addressType:
|
||||
type: object
|
||||
properties:
|
||||
@ -3044,7 +3041,7 @@ components:
|
||||
example: 1
|
||||
name:
|
||||
type: string
|
||||
example: Home
|
||||
example: Shipping
|
||||
street:
|
||||
type: string
|
||||
example: Appelstraat
|
||||
@ -3062,7 +3059,7 @@ components:
|
||||
example: Den Haag
|
||||
country:
|
||||
type: string
|
||||
example: Nederland
|
||||
example: NL
|
||||
_links:
|
||||
type: object
|
||||
properties:
|
||||
|
||||
@ -248,10 +248,9 @@ paths:
|
||||
postalCode: 0000AA
|
||||
city: Den Haag
|
||||
country: NL
|
||||
isPreferred: false
|
||||
addressType:
|
||||
addressTypeId: 2
|
||||
name: Office
|
||||
name: Billing
|
||||
- addressId: 2
|
||||
street: mystreet 33
|
||||
houseNumber: 1
|
||||
@ -259,10 +258,9 @@ paths:
|
||||
postalCode: 4455CA
|
||||
city: Den BOSCH
|
||||
country: NL
|
||||
isPreferred: true
|
||||
addressType:
|
||||
addressTypeId: 2
|
||||
name: Office
|
||||
addressTypeId: 1
|
||||
name: Shipping
|
||||
phones:
|
||||
- phoneId: 1
|
||||
number: "3112345678"
|
||||
@ -375,10 +373,9 @@ paths:
|
||||
postalCode: 0000AA
|
||||
city: Den Haag
|
||||
country: NL
|
||||
isPreferred: false
|
||||
addressType:
|
||||
addressTypeId: 2
|
||||
name: Office
|
||||
name: Billing
|
||||
- addressId: 2
|
||||
street: mystreet 33
|
||||
houseNumber: 1
|
||||
@ -388,8 +385,8 @@ paths:
|
||||
country: NL
|
||||
isPreferred: true
|
||||
addressType:
|
||||
addressTypeId: 2
|
||||
name: Office
|
||||
addressTypeId: 1
|
||||
name: Shipping
|
||||
phones:
|
||||
- phoneId: 1
|
||||
number: "3112345678"
|
||||
@ -516,10 +513,9 @@ paths:
|
||||
postalCode: 0000AA
|
||||
city: Den Haag
|
||||
country: NL
|
||||
isPreferred: false
|
||||
addressType:
|
||||
addressTypeId: 2
|
||||
name: Office
|
||||
name: Billing
|
||||
- addressId: 2
|
||||
street: mystreet 33
|
||||
houseNumber: 1
|
||||
@ -527,10 +523,9 @@ paths:
|
||||
postalCode: 4455CA
|
||||
city: Den BOSCH
|
||||
country: NL
|
||||
isPreferred: true
|
||||
addressType:
|
||||
addressTypeId: 2
|
||||
name: Office
|
||||
addressTypeId: 1
|
||||
name: Shipping
|
||||
phones:
|
||||
- phoneId: 1
|
||||
number: "3112345678"
|
||||
@ -652,10 +647,9 @@ paths:
|
||||
postalCode: 0000AA
|
||||
city: Den Haag
|
||||
country: NL
|
||||
isPreferred: false
|
||||
addressType:
|
||||
addressTypeId: 2
|
||||
name: Office
|
||||
name: Billing
|
||||
- addressId: 2
|
||||
street: mystreet 33
|
||||
houseNumber: 1
|
||||
@ -663,10 +657,9 @@ paths:
|
||||
postalCode: 4455CA
|
||||
city: Den BOSCH
|
||||
country: NL
|
||||
isPreferred: true
|
||||
addressType:
|
||||
addressTypeId: 2
|
||||
name: Office
|
||||
addressTypeId: 1
|
||||
name: Shipping
|
||||
phones:
|
||||
- phoneId: 1
|
||||
number: "3112345678"
|
||||
@ -811,7 +804,6 @@ paths:
|
||||
postalCode: 2500AA
|
||||
city: Den Haag
|
||||
country: NL
|
||||
isPreferred: true
|
||||
addressTypeId: 1
|
||||
- street: Beeklaan
|
||||
houseNumber: 30
|
||||
@ -819,7 +811,6 @@ paths:
|
||||
postalCode: 2500AA
|
||||
city: Den Haag
|
||||
country: NL
|
||||
isPreferred: false
|
||||
addressTypeId: 2
|
||||
phones:
|
||||
- number: "6123456789"
|
||||
@ -948,10 +939,10 @@ paths:
|
||||
parameters:
|
||||
- name: customerProfileId
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
example: 1
|
||||
required: true
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
@ -1040,7 +1031,6 @@ paths:
|
||||
postalCode: 1234 AB
|
||||
city: Den Haag
|
||||
country: NL
|
||||
isPreferred: true
|
||||
required: true
|
||||
responses:
|
||||
201:
|
||||
@ -1588,11 +1578,6 @@ paths:
|
||||
schema:
|
||||
type: integer
|
||||
example: 1
|
||||
- name: issuerCountry
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
example: "NL"
|
||||
- name: iban
|
||||
in: query
|
||||
schema:
|
||||
@ -1613,11 +1598,22 @@ paths:
|
||||
schema:
|
||||
type: string
|
||||
example: "John's billing details"
|
||||
- name: billingAddressID
|
||||
in: query
|
||||
- in: query
|
||||
name: createdBefore
|
||||
schema:
|
||||
type: integer
|
||||
example: 1
|
||||
type: string
|
||||
format: date-time
|
||||
example: 2020-12-31T23:59:59
|
||||
required: false
|
||||
description: Filter on created before.
|
||||
- in: query
|
||||
name: createdAfter
|
||||
schema:
|
||||
type: string
|
||||
format: date-time
|
||||
example: 2020-12-31T23:59:59
|
||||
required: false
|
||||
description: Filter on created after.
|
||||
- name: sort
|
||||
in: query
|
||||
schema:
|
||||
@ -1650,21 +1646,19 @@ paths:
|
||||
{
|
||||
"billingInformationId": 1,
|
||||
"customerProfileId": 1,
|
||||
"issuerCountry": "NL",
|
||||
"iban": "NL06RABO8902022560",
|
||||
"ascription": "J. Doe",
|
||||
"alias": null,
|
||||
"billingAddressId": 3,
|
||||
"created": "2023-10-20T17:05:52.000",
|
||||
},
|
||||
{
|
||||
"billingInformationId": 2,
|
||||
"customerProfileId": 1,
|
||||
"issuerCountry": "NL",
|
||||
"iban": "NL27ABNA4458972219",
|
||||
"bic": "GHJZIEJSKVM",
|
||||
"ascription": "J. Doe",
|
||||
"alias": "John's billing details",
|
||||
"billingAddressId": 4,
|
||||
"alias": "John's billing details",
|
||||
"created": "2024-10-20T17:05:52.000",
|
||||
},
|
||||
],
|
||||
}
|
||||
@ -1679,50 +1673,10 @@ paths:
|
||||
{
|
||||
"billingInformationId": 1,
|
||||
"customerProfileId": 1,
|
||||
"issuerCountry": "NL",
|
||||
"iban": "NL06RABO8902022560",
|
||||
"ascription": "J. Doe",
|
||||
"alias": null,
|
||||
"billingAddressId": 3,
|
||||
},
|
||||
],
|
||||
}
|
||||
getBillingInformationIssuerCountry:
|
||||
summary: Get multiple billing information entities for a specific issuer country
|
||||
description: >-
|
||||
Found multiple billing informations matching the search parameters
|
||||
value:
|
||||
{
|
||||
"billingInformations":
|
||||
[
|
||||
{
|
||||
"billingInformationId": 1,
|
||||
"customerProfileId": 1,
|
||||
"issuerCountry": "NL",
|
||||
"iban": "NL06RABO8902022560",
|
||||
"ascription": "J. Doe",
|
||||
"alias": null,
|
||||
"billingAddressId": 3,
|
||||
},
|
||||
{
|
||||
"billingInformationId": 2,
|
||||
"customerProfileId": 5,
|
||||
"issuerCountry": "NL",
|
||||
"iban": "NL27ABNA4458972219",
|
||||
"bic": "GHJZIEJSKVM",
|
||||
"ascription": "J. Doe",
|
||||
"alias": null,
|
||||
"billingAddressId": 42,
|
||||
},
|
||||
{
|
||||
"billingInformationId": 11,
|
||||
"customerProfileId": 9,
|
||||
"issuerCountry": "NL",
|
||||
"iban": "NL27ABNA4458972219",
|
||||
"bic": "GHJZIEJSKVM",
|
||||
"ascription": "J. Doe",
|
||||
"alias": null,
|
||||
"billingAddressId": 84,
|
||||
"alias": null,
|
||||
"created": "2024-10-20T17:05:52.000",
|
||||
},
|
||||
],
|
||||
}
|
||||
@ -1749,19 +1703,15 @@ paths:
|
||||
customerBillinginformationMandatoryFields:
|
||||
value:
|
||||
billingInformation:
|
||||
issuerCountry: "NL"
|
||||
iban: "NL73RABO2677424363"
|
||||
ascription: "J. Doe"
|
||||
billingAddressId: 1
|
||||
customerBillinginformationMandatoryFull:
|
||||
value:
|
||||
billingInformation:
|
||||
issuerCountry: "NL"
|
||||
iban: "NL73RABO2677424363"
|
||||
bic: "GHJZIEJSKVM"
|
||||
ascription: "J. Doe"
|
||||
alias: "John's billing details"
|
||||
billingAddressId: 1
|
||||
required: true
|
||||
responses:
|
||||
201:
|
||||
@ -1798,15 +1748,11 @@ paths:
|
||||
value:
|
||||
billingInformation:
|
||||
alias: "Mijn rekening details"
|
||||
updateBillingInformationAdressId:
|
||||
value:
|
||||
billingInformation:
|
||||
billingAddressId: 4
|
||||
updateBillingInformation:
|
||||
value:
|
||||
billingInformation:
|
||||
alias: "Mijn rekening details"
|
||||
billingAddressId: 4
|
||||
iban: "NL06RABO8902022560"
|
||||
required: true
|
||||
responses:
|
||||
200:
|
||||
@ -1817,11 +1763,10 @@ paths:
|
||||
{
|
||||
"billingInformationId": 1,
|
||||
"customerProfileId": 1,
|
||||
"issuerCountry": "NL",
|
||||
"iban": "NL06RABO8902022560",
|
||||
"ascription": "J. Doe",
|
||||
"alias": "Mijn rekening details",
|
||||
"billingAddressId": 4,
|
||||
"created": "2024-03-22T08:55:00",
|
||||
}
|
||||
security:
|
||||
- default: []
|
||||
@ -1865,13 +1810,6 @@ paths:
|
||||
explode: false
|
||||
required: false
|
||||
description: The id of the direct debit mandate type. 1 = Paper contract, 2 = PIN transaction, 3 = SEPA eMandate, 4 = Digital signature, 5 = iDEAL transaction.
|
||||
- in: query
|
||||
name: mandateAddressId
|
||||
schema:
|
||||
type: integer
|
||||
example: 21
|
||||
required: false
|
||||
description: The id of the address related to the mandate.
|
||||
- in: query
|
||||
name: createdBefore
|
||||
schema:
|
||||
@ -1957,7 +1895,6 @@ paths:
|
||||
"name": "import",
|
||||
"description": "import",
|
||||
},
|
||||
"mandateAddressId": 21,
|
||||
"created": "2024-03-22T08:55:00",
|
||||
"mandateReference": "CORE01",
|
||||
"mandateState": "SINGED",
|
||||
@ -1993,7 +1930,6 @@ paths:
|
||||
"name": "import",
|
||||
"description": "import",
|
||||
},
|
||||
"mandateAddressId": 21,
|
||||
"created": "2024-03-22T08:55:00",
|
||||
"mandateReference": "CORE01",
|
||||
"mandateState": "SINGED",
|
||||
@ -2043,7 +1979,6 @@ paths:
|
||||
value:
|
||||
directDebitMandate:
|
||||
directDebitMandateTypeId: 1
|
||||
mandateAddressId: 1
|
||||
mandateReference: HTM-mandate-001
|
||||
mandateState: PREPARED
|
||||
required: true
|
||||
@ -2099,7 +2034,6 @@ paths:
|
||||
"name": "import",
|
||||
"description": "import",
|
||||
},
|
||||
"mandateAddressId": 21,
|
||||
"created": "2024-03-22T08:55:00",
|
||||
"mandateReference": "CORE01",
|
||||
"mandateState": "CANCELLED",
|
||||
@ -2268,8 +2202,6 @@ components:
|
||||
type: string
|
||||
country:
|
||||
type: string
|
||||
isPreferred:
|
||||
type: boolean
|
||||
addressType:
|
||||
$ref: "#/components/schemas/getAddressType"
|
||||
getAddressType:
|
||||
@ -2375,8 +2307,6 @@ components:
|
||||
type: string
|
||||
country:
|
||||
type: string
|
||||
isPreferred:
|
||||
type: boolean
|
||||
addressTypeId:
|
||||
type: integer
|
||||
postPhoneEntity:
|
||||
@ -2443,8 +2373,6 @@ components:
|
||||
type: string
|
||||
country:
|
||||
type: string
|
||||
isPreferred:
|
||||
type: boolean
|
||||
addressType:
|
||||
type: integer
|
||||
patchCustomerAddress:
|
||||
@ -2462,8 +2390,6 @@ components:
|
||||
type: string
|
||||
country:
|
||||
type: string
|
||||
isPreferred:
|
||||
type: boolean
|
||||
addressType:
|
||||
type: integer
|
||||
postCustomerProfileResponse:
|
||||
@ -2564,8 +2490,6 @@ components:
|
||||
properties:
|
||||
billingInformationId:
|
||||
type: integer
|
||||
issuerCountry:
|
||||
type: string
|
||||
iban:
|
||||
type: string
|
||||
bic:
|
||||
@ -2574,8 +2498,8 @@ components:
|
||||
type: string
|
||||
alias:
|
||||
type: string
|
||||
billingAddressId:
|
||||
type: integer
|
||||
created:
|
||||
type: string
|
||||
mandateEntity:
|
||||
type: object
|
||||
properties:
|
||||
@ -2583,8 +2507,6 @@ components:
|
||||
type: integer
|
||||
directDebitMandateTypeId:
|
||||
type: integer
|
||||
mandateAddressId:
|
||||
type: integer
|
||||
mandateReference:
|
||||
type: string
|
||||
mandateState:
|
||||
|
||||
@ -294,164 +294,6 @@ paths:
|
||||
- default: []
|
||||
x-auth-type: Application & Application User
|
||||
x-throttling-tier: Unlimited
|
||||
post:
|
||||
tags:
|
||||
- ABTCustomerReference
|
||||
summary: Create a address type
|
||||
description: Create a address type with a specific value
|
||||
parameters: []
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/addressType'
|
||||
required: true
|
||||
responses:
|
||||
'201':
|
||||
description: Successful created a new address type
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: integer
|
||||
example: 1
|
||||
'400':
|
||||
description: Bad Request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/400Response'
|
||||
'401':
|
||||
description: Unauthorized
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/401Response'
|
||||
'404':
|
||||
description: Not Found
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/404Response'
|
||||
'500':
|
||||
description: Internal Server Error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/500Response'
|
||||
security:
|
||||
- default: []
|
||||
x-auth-type: Application & Application User
|
||||
x-throttling-tier: Unlimited
|
||||
/addresstype/{addressTypeId}:
|
||||
put:
|
||||
tags:
|
||||
- ABTCustomerReference
|
||||
summary: Update a address type
|
||||
description: Update an existing address type with a specific value
|
||||
parameters:
|
||||
- name: addressTypeId
|
||||
in: path
|
||||
required: true
|
||||
style: simple
|
||||
explode: false
|
||||
schema:
|
||||
type: integer
|
||||
format: integer
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/addressType'
|
||||
required: true
|
||||
responses:
|
||||
'202':
|
||||
description: Successful updated an existing a address type
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: integer
|
||||
example: 1
|
||||
'400':
|
||||
description: Bad Request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/400Response'
|
||||
'401':
|
||||
description: Unauthorized
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/401Response'
|
||||
'404':
|
||||
description: Not Found
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/404Response'
|
||||
'500':
|
||||
description: Internal Server Error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/500Response'
|
||||
security:
|
||||
- default: []
|
||||
x-auth-type: Application & Application User
|
||||
x-throttling-tier: Unlimited
|
||||
delete:
|
||||
tags:
|
||||
- ABTCustomerReference
|
||||
summary: Remove a address type
|
||||
description: Remove an existing address type with a specific value
|
||||
parameters:
|
||||
- name: addressTypeId
|
||||
in: path
|
||||
required: true
|
||||
style: simple
|
||||
explode: false
|
||||
schema:
|
||||
type: integer
|
||||
format: integer
|
||||
responses:
|
||||
'202':
|
||||
description: Successful removed a address type
|
||||
'400':
|
||||
description: Bad Request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/400Response'
|
||||
'401':
|
||||
description: Unauthorized
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/401Response'
|
||||
'404':
|
||||
description: Not Found
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: '#/components/schemas/404ResponseId'
|
||||
- $ref: '#/components/schemas/404Response'
|
||||
'500':
|
||||
description: Internal Server Error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/500Response'
|
||||
security:
|
||||
- default: []
|
||||
x-auth-type: Application & Application User
|
||||
x-throttling-tier: Unlimited
|
||||
/customerstatus:
|
||||
get:
|
||||
tags:
|
||||
|
||||
Loading…
Reference in New Issue
Block a user