swagger: '2.0' info: description: 'The current set of APIs will be available in Q2 2026 on Worldline Global Issuing Platforms. Additional APIs are under construction and planned to be available in 2026.' version: 2.41.1 title: Worldline Card Issuing Account - AccountState Customer - Address API contact: {} host: sbx-wlip.api1-eu2.psapigateway.preprod.giservices.io/card-issuing basePath: /api/v2 schemes: - https tags: - name: Customer - Address description: Customer Address Api Controller paths: /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses: post: x-wl-idempotent: true x-wl-lra-operation: true tags: - Customer - Address summary: Create address for a customer by external reference operationId: createAddressByCustomerIssuerExtRef description: "The API allows to create either a permanent address or a temporary address for the customer, identified with his reference. \nAn address includes the following information:\n•\tthe issuer address external reference \n•\tthe label (eg MAIN_POSTAL_ADDRESS),\n•\tthe type (mail address, phone number, email) and the corresponding data\n•\tthe address usages\n•\tthe start date (optional, by default the current date is used)\n•\tthe end date (conditional, is mandatory when creating a temporary address)\n\nIf the label of the address is already used for the customer, a new version will be created and active once the start date is reached.\n\nWhen creating a temporary address, If a temporary address already exists with an overlap on the activity period then only the newly created address will be kept and the old one will be removed. \nThe temporary address is active between its start date and end date.\n\nOne or several address usages can be added to the address (in order to retrieve this address). An address usage is used for specific business process/service. When adding a usage to an address, the usage is immediately active and if it is already assigned to another address, it is removed from this latter. \n\nFor information, the main postal address is mandatory.\nIn return, the API provides the address Reference calculated by the system.\n\nIdempotency is managed by the API; that is, if the request with the same WL-Correlation-ID is sent multiple times, it will be executed only once.The response will be retrieved directly from our system." consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: issuerCustomerExternalReference in: path description: Issuer Customer External Reference required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/CreateAddressRequest' responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityCreateAddressResponse' security: - basic: [] deprecated: false ? /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference} : get: tags: - Customer - Address summary: Retrieve customer address by customer external reference and address external reference operationId: retrieveAddressByIssuerExtRefAndCustomerIssuerExtRef description: "The API returns the current version of the customer's address identified with:\n•\tthe reference of the customer,\n•\tthe reference of the address.\nThis address is either a permanent address or a temporary address (if this one is active at the time of request).\nThe address identifiers, address attributes, address usages and entity reference (application domain of the address) are displayed in the response." produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: issuerCustomerExternalReference in: path description: Issuer Customer External Reference required: true type: string - name: issuerAddressExternalReference in: path description: Issuer address external reference required: true type: string - name: embed in: query description: Embedded Fields required: false type: array items: type: string enum: - addressUsages collectionFormat: multi responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityAddress' security: - basic: [] deprecated: false put: tags: - Customer - Address summary: Update address by customer external reference and address external reference operationId: modifyAddressByIssuerExtRefAndCustomerIssuerExtRef description: "The API allows to update the permanent address of a customer, identified with the reference of the customer and the reference of the address.\nAll the attributes must be provided even those unchanged, except the line 1 to 5 of the postal address if a specific issuer algorithm is configured.\nIf the address was invalid, the address becomes valid.\n\nOne or several address usages can be added to the address. An address usage is used for specific business process/service. When adding a usage to an address, the usage is immediately active and if it is already assigned to another address, it is removed from this latter. \nAll the usages already linked to the address cannot be removed via this API." consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: issuerCustomerExternalReference in: path description: Issuer Customer External Reference required: true type: string - name: issuerAddressExternalReference in: path description: Issuer address external reference required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/ModifyAddressRequest' responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityModifyAddressResponse' security: - basic: [] deprecated: false ? /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}/invalidate : post: tags: - Customer - Address summary: Invalidate address by customer external reference and address external reference operationId: invalidateAddressByExtCustomerRefAndExtAddress description: "The API is used to invalidate the address identified with the customer reference (external or internal) and the address reference (external or internal).\nThe invalidation is applied only on the permanent address. \nThe address must be a postal address. If the user tries to invalidate another kind of address (PHONE/E_MAIL), an error is returned.\nThe attribute 'invalid' becomes 'true'." consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: issuerId in: path description: Issuer ID required: true type: string - name: issuerCustomerExternalReference in: path description: Issuer Customer External Reference required: true type: string - name: issuerAddressExternalReference in: path description: Issuer address external reference required: true type: string responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityInvalidateAddressResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}/invalidate: post: tags: - Customer - Address summary: Invalidate address by customer external reference operationId: invalidateAddressByExtCustomerAndAddress description: "The API is used to invalidate the address identified with the customer reference (external or internal) and the address reference (external or internal).\nThe invalidation is applied only on the permanent address. \nThe address must be a postal address. If the user tries to invalidate another kind of address (PHONE/E_MAIL), an error is returned.\nThe attribute 'invalid' becomes 'true'." consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: issuerId in: path description: Issuer ID required: true type: string - name: issuerCustomerExternalReference in: path description: Issuer Customer External Reference required: true type: string - name: addressReference in: path description: Address Reference required: true type: string responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityInvalidateAddressResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/customers/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}/invalidate: post: tags: - Customer - Address summary: Invalidate address by address external reference operationId: invalidateAddressByCustomerAndExtAddress description: "The API is used to invalidate the address identified with the customer reference (external or internal) and the address reference (external or internal).\nThe invalidation is applied only on the permanent address. \nThe address must be a postal address. If the user tries to invalidate another kind of address (PHONE/E_MAIL), an error is returned.\nThe attribute 'invalid' becomes 'true'." consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: issuerId in: path description: Issuer ID required: true type: string - name: customerReference in: path description: Customer Reference required: true type: string - name: issuerAddressExternalReference in: path description: Issuer address external reference required: true type: string responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityInvalidateAddressResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}/invalidate: post: tags: - Customer - Address summary: Invalidate address operationId: invalidateAddress description: "The API is used to invalidate the address identified with the customer reference (external or internal) and the address reference (external or internal).\nThe invalidation is applied only on the permanent address. \nThe address must be a postal address. If the user tries to invalidate another kind of address (PHONE/E_MAIL), an error is returned.\nThe attribute 'invalid' becomes 'true'." consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: issuerId in: path description: Issuer ID required: true type: string - name: customerReference in: path description: Customer Reference required: true type: string - name: addressReference in: path description: Address Reference required: true type: string responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityInvalidateAddressResponse' security: - basic: [] deprecated: false ? /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}/activate : post: tags: - Customer - Address summary: Activate address by customer external reference and address external reference operationId: activateAddressByIssuerExtRefAndCustomerIssuerExtRef description: "The API allows to activate on demand of an address by providing\n•\tthe reference of the customer,\n•\tthe reference of the address\n•\tthe issuer Id.\nIf a temporary address exists, it becomes also active.\nThe address identifiers, address attributes and address usages are displayed in the response." consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: issuerCustomerExternalReference in: path description: Issuer Customer External Reference required: true type: string - name: issuerAddressExternalReference in: path description: Issuer address external reference required: true type: string responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityActivateAddressResponse' security: - basic: [] deprecated: false ? /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}/address-usages : post: tags: - Customer - Address summary: Add an address usage by customer external reference and address external reference operationId: createAddressUsageByIssuerExtRefAndCustomerIssuerExtRef description: "The address usage describes in which business case the address will be used (eg statement sending, cad delivery, ...) \nThe complete authorized values list is shared during the product configuration between the issuer and WL.\nThis API allows a usage determined by its name (e.g. STATEMENT_SENDING) to be linked to the entity reference of the address (e.g. card contract reference) and the service code (e.g. ACCOUNT_SERVICE)\nTo create an address usage, it is needed to provide:\n- The issuer ID\n- The customer reference or the issuer customer reference \n- The address reference or the issuer address reference" consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: issuerCustomerExternalReference in: path description: Issuer Customer External Reference required: true type: string - name: issuerAddressExternalReference in: path description: Issuer address external reference required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/CreateAddressUsageRequest' responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityCreateAddressUsageResponse' security: - basic: [] deprecated: false delete: tags: - Customer - Address summary: Remove an address usage by customer external reference and address external reference operationId: deleteAddressUsageByIssuerExtRefAndCustomerIssuerExtRef description: "The API deletes the address usages linked to one address. \nThese address usages are filtered by the request params:\n- addressUsageName (for definition see the resource addressUsage), mandatory\n- entityReference (for definition see the resource addressUsage), optional\n- serviceCode (for definition see the resource addressUsage), mandatory\n\nIf the entityReference is empty and the API finds several addressUsages (for the addressUsageName and serviceCode in request param), then the list of addressUsages will be deleted" consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: issuerCustomerExternalReference in: path description: Issuer Customer External Reference required: true type: string - name: issuerAddressExternalReference in: path description: Issuer address external reference required: true type: string - name: serviceCode in: query description: 'The Service for which the address usage is defined : CARD_SERVICE, ACCOUNT_SERVICE. Mandatory ' required: true type: string - name: entityReference in: query description: 'This corresponds to the application domain of the address. It can be eg a card contract reference, card account reference. It is an optional field. It enables to have the same usage address for the same customer applied to different addresses (one cardholder with 2 card contracts: card delivery address usage is assigned to main postal address for contract A and card delivery address usage is also assigned to office postal address for contract B.' required: false type: string - name: addressUsageName in: query description: The business process for which the address usage is defined such as CARD_DELIVERY, PIN_MAILER_DELIVERY, STATEMENT_DELIVERY. required: true type: string responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityDeleteAddressUsageResponse' security: - basic: [] deprecated: false ? /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}/deactivate : post: tags: - Customer - Address summary: Deactivate address by customer external reference and address external reference operationId: deactivateAddressByIssuerExtRefAndCustomerIssuerExtRef description: "The API is used to deactivate the address, identified with the customer reference and the address reference. \nThe status becomes \"INACTIVE\". \nThis action is forbidden in case of:\n- the address is the MAIN_POSTAL_ADDRESS\n- an usage is linked to the address." consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: issuerCustomerExternalReference in: path description: Issuer Customer External Reference required: true type: string - name: issuerAddressExternalReference in: path description: Issuer address external reference required: true type: string responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityDeactivateAddressResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}: get: tags: - Customer - Address summary: Retrieve customer address by customer external reference operationId: retrieveAddressByCustomerIssuerExtRef description: "The API returns the current version of the customer's address identified with:\n•\tthe reference of the customer,\n•\tthe reference of the address.\nThis address is either a permanent address or a temporary address (if this one is active at the time of request).\nThe address identifiers, address attributes, address usages and entity reference (application domain of the address) are displayed in the response." produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: issuerCustomerExternalReference in: path description: Issuer Customer External Reference required: true type: string - name: addressReference in: path description: Address Reference required: true type: string - name: embed in: query description: Embedded Fields required: false type: array items: type: string enum: - addressUsages collectionFormat: multi responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityAddress' security: - basic: [] deprecated: false put: tags: - Customer - Address summary: Update address by customer external reference operationId: modifyAddressByCustomerIssuerExtRef description: "The API allows to update the permanent address of a customer, identified with the reference of the customer and the reference of the address.\nAll the attributes must be provided even those unchanged, except the line 1 to 5 of the postal address if a specific issuer algorithm is configured.\nIf the address was invalid, the address becomes valid.\n\nOne or several address usages can be added to the address. An address usage is used for specific business process/service. When adding a usage to an address, the usage is immediately active and if it is already assigned to another address, it is removed from this latter. \nAll the usages already linked to the address cannot be removed via this API." consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: issuerCustomerExternalReference in: path description: Issuer Customer External Reference required: true type: string - name: addressReference in: path description: Address Reference required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/ModifyAddressRequest' responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityModifyAddressResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}/activate: post: tags: - Customer - Address summary: Activate address by customer external reference operationId: activateAddressByCustomerIssuerExtRef description: "The API allows to activate on demand of an address by providing\n•\tthe reference of the customer,\n•\tthe reference of the address\n•\tthe issuer Id.\nIf a temporary address exists, it becomes also active.\nThe address identifiers, address attributes and address usages are displayed in the response." consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: issuerCustomerExternalReference in: path description: Issuer Customer External Reference required: true type: string - name: addressReference in: path description: Address Reference required: true type: string responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityActivateAddressResponse' security: - basic: [] deprecated: false ? /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}/address-usages : post: tags: - Customer - Address summary: Add an address usage by customer external reference operationId: createAddressUsageByCustomerIssuerExtRef description: "The address usage describes in which business case the address will be used (eg statement sending, cad delivery, ...) \nThe complete authorized values list is shared during the product configuration between the issuer and WL.\nThis API allows a usage determined by its name (e.g. STATEMENT_SENDING) to be linked to the entity reference of the address (e.g. card contract reference) and the service code (e.g. ACCOUNT_SERVICE)\nTo create an address usage, it is needed to provide:\n- The issuer ID\n- The customer reference or the issuer customer reference \n- The address reference or the issuer address reference" consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: issuerCustomerExternalReference in: path description: Issuer Customer External Reference required: true type: string - name: addressReference in: path description: Address Reference required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/CreateAddressUsageRequest' responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityCreateAddressUsageResponse' security: - basic: [] deprecated: false delete: tags: - Customer - Address summary: Remove an address usage by customer external reference operationId: deleteAddressUsageByCustomerIssuerExtRef description: "The API deletes the address usages linked to one address. \nThese address usages are filtered by the request params:\n- addressUsageName (for definition see the resource addressUsage), mandatory\n- entityReference (for definition see the resource addressUsage), optional\n- serviceCode (for definition see the resource addressUsage), mandatory\n\nIf the entityReference is empty and the API finds several addressUsages (for the addressUsageName and serviceCode in request param), then the list of addressUsages will be deleted" consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: issuerCustomerExternalReference in: path description: Issuer Customer External Reference required: true type: string - name: addressReference in: path description: Address Reference required: true type: string - name: serviceCode in: query description: 'The Service for which the address usage is defined : CARD_SERVICE, ACCOUNT_SERVICE. Mandatory ' required: true type: string - name: entityReference in: query description: 'This corresponds to the application domain of the address. It can be eg a card contract reference, card account reference. It is an optional field. It enables to have the same usage address for the same customer applied to different addresses (one cardholder with 2 card contracts: card delivery address usage is assigned to main postal address for contract A and card delivery address usage is also assigned to office postal address for contract B.' required: false type: string - name: addressUsageName in: query description: The business process for which the address usage is defined such as CARD_DELIVERY, PIN_MAILER_DELIVERY, STATEMENT_DELIVERY. required: true type: string responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityDeleteAddressUsageResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}/deactivate: post: tags: - Customer - Address summary: Deactivate address by customer external reference operationId: deactivateAddressByCustomerIssuerExtRef description: 'Deactivate the address identified with the customer external reference and the address internal reference. The status becomes ''INACTIVE''. This action is forbidden in case of : -the address is the MAIN_POSTAL_ADDRESS -an usage is linked to the address. ' consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: issuerCustomerExternalReference in: path description: Issuer Customer External Reference required: true type: string - name: addressReference in: path description: Address Reference required: true type: string responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityDeactivateAddressResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/customers/{customerReference}/addresses: post: x-wl-idempotent: true x-wl-lra-operation: true x-wl-lra-interface: true tags: - Customer - Address summary: Create address for a customer operationId: createAddress description: "The API allows to create either a permanent address or a temporary address for the customer, identified with his reference. \nAn address includes the following information:\n•\tthe issuer address external reference \n•\tthe label (eg MAIN_POSTAL_ADDRESS),\n•\tthe type (mail address, phone number, email) and the corresponding data\n•\tthe address usages\n•\tthe start date (optional, by default the current date is used)\n•\tthe end date (conditional, is mandatory when creating a temporary address)\n\nIf the label of the address is already used for the customer, a new version will be created and active once the start date is reached.\n\nWhen creating a temporary address, If a temporary address already exists with an overlap on the activity period then only the newly created address will be kept and the old one will be removed. \nThe temporary address is active between its start date and end date.\n\nOne or several address usages can be added to the address (in order to retrieve this address). An address usage is used for specific business process/service. When adding a usage to an address, the usage is immediately active and if it is already assigned to another address, it is removed from this latter. \n\nFor information, the main postal address is mandatory.\nIn return, the API provides the address Reference calculated by the system.\n\nIdempotency is managed by the API; that is, if the request with the same WL-Correlation-ID is sent multiple times, it will be executed only once.The response will be retrieved directly from our system." consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: customerReference in: path description: Customer Reference required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/CreateAddressRequest' responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityCreateAddressResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/customers/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}: get: tags: - Customer - Address summary: Retrieve customer address by address external reference operationId: retrieveAddressByIssuerExtRef description: "The API returns the current version of the customer's address identified with:\n•\tthe reference of the customer,\n•\tthe reference of the address.\nThis address is either a permanent address or a temporary address (if this one is active at the time of request).\nThe address identifiers, address attributes, address usages and entity reference (application domain of the address) are displayed in the response." produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: customerReference in: path description: Customer Reference required: true type: string - name: issuerAddressExternalReference in: path description: Issuer address external reference required: true type: string - name: embed in: query description: Embedded Fields required: false type: array items: type: string enum: - addressUsages collectionFormat: multi responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityAddress' security: - basic: [] deprecated: false put: tags: - Customer - Address summary: Update address by address external reference operationId: modifyAddressByIssuerExtRef description: "The API allows to update the permanent address of a customer, identified with the reference of the customer and the reference of the address.\nAll the attributes must be provided even those unchanged, except the line 1 to 5 of the postal address if a specific issuer algorithm is configured.\nIf the address was invalid, the address becomes valid.\n\nOne or several address usages can be added to the address. An address usage is used for specific business process/service. When adding a usage to an address, the usage is immediately active and if it is already assigned to another address, it is removed from this latter. \nAll the usages already linked to the address cannot be removed via this API." consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: customerReference in: path description: Customer Reference required: true type: string - name: issuerAddressExternalReference in: path description: Issuer address external reference required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/ModifyAddressRequest' responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityModifyAddressResponse' security: - basic: [] deprecated: false ? /issuers/{issuerId}/customers/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}/address-usages : post: tags: - Customer - Address summary: Add an address usage by address external reference operationId: createAddressUsageByIssuerExtRef description: "The address usage describes in which business case the address will be used (eg statement sending, cad delivery, ...) \nThe complete authorized values list is shared during the product configuration between the issuer and WL.\nThis API allows a usage determined by its name (e.g. STATEMENT_SENDING) to be linked to the entity reference of the address (e.g. card contract reference) and the service code (e.g. ACCOUNT_SERVICE)\nTo create an address usage, it is needed to provide:\n- The issuer ID\n- The customer reference or the issuer customer reference \n- The address reference or the issuer address reference" consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: customerReference in: path description: Customer Reference required: true type: string - name: issuerAddressExternalReference in: path description: Issuer address external reference required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/CreateAddressUsageRequest' responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityCreateAddressUsageResponse' security: - basic: [] deprecated: false delete: tags: - Customer - Address summary: Remove an address usage by address external reference operationId: deleteAddressUsageByIssuerExtRef description: "The API deletes the address usages linked to one address. \nThese address usages are filtered by the request params:\n- addressUsageName (for definition see the resource addressUsage), mandatory\n- entityReference (for definition see the resource addressUsage), optional\n- serviceCode (for definition see the resource addressUsage), mandatory\n\nIf the entityReference is empty and the API finds several address usages (for the addressUsageName and serviceCode in request param), then the list of addressUsages will be deleted." consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: customerReference in: path description: Customer Reference required: true type: string - name: issuerAddressExternalReference in: path description: Issuer address external reference required: true type: string - name: serviceCode in: query description: 'The Service for which the address usage is defined : CARD_SERVICE, ACCOUNT_SERVICE. Mandatory ' required: true type: string - name: entityReference in: query description: 'This corresponds to the application domain of the address. It can be eg a card contract reference, card account reference. It is an optional field. It enables to have the same usage address for the same customer applied to different addresses (one cardholder with 2 card contracts: card delivery address usage is assigned to main postal address for contract A and card delivery address usage is also assigned to office postal address for contract B.' required: false type: string - name: addressUsageName in: query description: The business process for which the address usage is defined such as CARD_DELIVERY, PIN_MAILER_DELIVERY, STATEMENT_DELIVERY. required: true type: string responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityDeleteAddressUsageResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/customers/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}/activate: post: tags: - Customer - Address summary: Activate address by address external reference operationId: activateAddressByIssuerExtRef description: "The API allows to activate on demand of an address by providing\n•\tthe reference of the customer,\n•\tthe reference of the address\n•\tthe issuer Id.\nIf a temporary address exists, it becomes also active.\nThe address identifiers, address attributes and address usages are displayed in the response." consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: customerReference in: path description: Customer Reference required: true type: string - name: issuerAddressExternalReference in: path description: Issuer address external reference required: true type: string responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityActivateAddressResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/customers/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}/deactivate: post: tags: - Customer - Address summary: Deactivate address by address external reference operationId: deactivateAddressByIssuerExtRef description: 'Deactivate the address identified with the customer internal reference and the address external reference. The status becomes ''INACTIVE''. This action is forbidden in case of : -the address is the MAIN_POSTAL_ADDRESS -an usage is linked to the address. ' consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: customerReference in: path description: Customer Reference required: true type: string - name: issuerAddressExternalReference in: path description: Issuer address external reference required: true type: string responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityDeactivateAddressResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}: get: tags: - Customer - Address summary: Retrieve customer address operationId: retrieveAddress description: "The API returns the current version of the customer's address identified with:\n•\tthe reference of the customer,\n•\tthe reference of the address.\nThis address is either a permanent address or a temporary address (if this one is active at the time of request).\nThe address identifiers, address attributes, address usages and entity reference (application domain of the address) are displayed in the response." produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: customerReference in: path description: Customer Reference required: true type: string - name: addressReference in: path description: Address Reference required: true type: string - name: embed in: query description: Embedded Fields required: false type: array items: type: string enum: - addressUsages collectionFormat: multi responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityAddress' security: - basic: [] deprecated: false put: tags: - Customer - Address summary: Update address operationId: modifyAddress description: "The API allows to update the permanent address of a customer, identified with the reference of the customer and the reference of the address.\nAll the attributes must be provided even those unchanged, except the line 1 to 5 of the postal address if a specific issuer algorithm is configured.\nIf the address was invalid, the address becomes valid.\n\nOne or several address usages can be added to the address. An address usage is used for specific business process/service. When adding a usage to an address, the usage is immediately active and if it is already assigned to another address, it is removed from this latter. \nAll the usages already linked to the address cannot be removed via this API." consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: customerReference in: path description: Customer Reference required: true type: string - name: addressReference in: path description: Address Reference required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/ModifyAddressRequest' responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityModifyAddressResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}/activate: post: tags: - Customer - Address summary: Activate address operationId: activateAddress description: "The API allows to activate on demand of an address by providing\n•\tthe reference of the customer,\n•\tthe reference of the address\n•\tthe issuer Id.\nIf a temporary address exists, it becomes also active.\nThe address identifiers, address attributes and address usages are displayed in the response." consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: customerReference in: path description: Customer Reference required: true type: string - name: addressReference in: path description: Address Reference required: true type: string responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityActivateAddressResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}/address-usages: post: x-wl-lra-operation: true tags: - Customer - Address summary: Add an address usage operationId: createAddressUsage description: "The address usage describes in which business case the address will be used (eg statement sending, cad delivery, ...) \nThe complete authorized values list is shared during the product configuration between the issuer and WL.\nThis API allows a usage determined by its name (e.g. STATEMENT_SENDING) to be linked to the entity reference of the address (e.g. card contract reference) and the service code (e.g. ACCOUNT_SERVICE)\nTo create an address usage, it is needed to provide:\n- The issuer ID\n- The customer reference or the issuer customer reference \n- The address reference or the issuer address reference" consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: customerReference in: path description: Customer Reference required: true type: string - name: addressReference in: path description: Address Reference required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/CreateAddressUsageRequest' responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityCreateAddressUsageResponse' security: - basic: [] deprecated: false delete: tags: - Customer - Address summary: Remove an address usage operationId: deleteAddressUsage description: "The API deletes the address usages linked to one address. \nThese address usages are filtered by the request params:\n- addressUsageName (for definition see the resource addressUsage), mandatory\n- entityReference (for definition see the resource addressUsage), optional\n- serviceCode (for definition see the resource addressUsage), mandatory\n\nIf the entityReference is empty and the API finds several address usages (for the addressUsageName and serviceCode in request param), then the list of addressUsages will be deleted." consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: customerReference in: path description: Customer Reference required: true type: string - name: addressReference in: path description: Address Reference required: true type: string - name: serviceCode in: query description: 'The Service for which the address usage is defined : CARD_SERVICE, ACCOUNT_SERVICE. Mandatory ' required: true type: string - name: entityReference in: query description: 'This corresponds to the application domain of the address. It can be eg a card contract reference, card account reference. It is an optional field. It enables to have the same usage address for the same customer applied to different addresses (one cardholder with 2 card contracts: card delivery address usage is assigned to main postal address for contract A and card delivery address usage is also assigned to office postal address for contract B.' required: false type: string - name: addressUsageName in: query description: The business process for which the address usage is defined such as CARD_DELIVERY, PIN_MAILER_DELIVERY, STATEMENT_DELIVERY. required: true type: string responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityDeleteAddressUsageResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}/deactivate: post: tags: - Customer - Address summary: Deactivate address operationId: deactivateAddress description: "The API is used to deactivate the address, identified with the customer reference and the address reference. \nThe status becomes \"INACTIVE\". \nThis action is forbidden in case of:\n- the address is the MAIN_POSTAL_ADDRESS\n- an usage is linked to the address." consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: customerReference in: path description: Customer Reference required: true type: string - name: addressReference in: path description: Address Reference required: true type: string responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityDeactivateAddressResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}/address-versions/{addressVersionReference}: delete: tags: - Customer - Address summary: Delete an address for a customer description: "The API allows a future permanent address or a temporary address (active or future) to be deleted.\n\nThe main input fields requested by the API are:\n•\tThe issuer ID\n•\tThe customer for which the address deletion is requested : It can be provided by using the customer reference or the issuer customer external reference\n•\tThe address of the customer for which the deletion is requested : It can be provided by using the address reference or the issuer address external reference\n•\tThe version reference of the address to be deleted\n\nAs result, the version of the customer address is deleted. If the address was an active temporary address, its end date is updated (set to the current date)\nIn response, the interface provides: \n- the address identifier (address reference or the issuer address external reference)\n- the deleted version reference of the address" operationId: deleteAddress produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: issuerId in: path description: Issuer ID required: true type: string - name: customerReference in: path description: customerReference required: true type: string - name: addressReference in: path description: addressReference required: true type: string - name: addressVersionReference in: path description: addressVersionReference required: true type: string responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityDeleteAddress' security: - basic: [] deprecated: false ? /issuers/{issuerId}/customers/{customerReference}/external-addresses/{issuerAddressExternalReference}/address-versions/{addressVersionReference} : delete: tags: - Customer - Address summary: Delete an address for a customer by address external reference description: "The API allows a future permanent address or a temporary address (active or future) to be deleted.\n\nThe main input fields requested by the API are:\n•\tThe issuer ID\n•\tThe customer for which the address deletion is requested : It can be provided by using the customer reference or the issuer customer external reference\n•\tThe address of the customer for which the deletion is requested : It can be provided by using the address reference or the issuer address external reference\n•\tThe version reference of the address to be deleted\n\nAs result, the version of the customer address is deleted. If the address was an active temporary address, its end date is updated (set to the current date)\nIn response, the interface provides: \n- the address identifier (address reference or the issuer address external reference)\n- the deleted version reference of the address" operationId: deleteAddressByAdrExtRef produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: issuerId in: path description: Issuer ID required: true type: string - name: customerReference in: path description: customerReference required: true type: string - name: issuerAddressExternalReference in: path description: issuerAddressExternalReference required: true type: string - name: addressVersionReference in: path description: addressVersionReference required: true type: string responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityDeleteAddress' security: - basic: [] deprecated: false ? /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}/address-versions/{addressVersionReference} : delete: tags: - Customer - Address summary: Delete an address for a customer by customer external reference description: "The API allows a future permanent address or a temporary address (active or future) to be deleted.\n\nThe main input fields requested by the API are:\n•\tThe issuer ID\n•\tThe customer for which the address deletion is requested : It can be provided by using the customer reference or the issuer customer external reference\n•\tThe address of the customer for which the deletion is requested : It can be provided by using the address reference or the issuer address external reference\n•\tThe version reference of the address to be deleted\n\nAs result, the version of the customer address is deleted. If the address was an active temporary address, its end date is updated (set to the current date)\nIn response, the interface provides: \n- the address identifier (address reference or the issuer address external reference)\n- the deleted version reference of the address" operationId: deleteAddressByCusExtRef produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: issuerId in: path description: Issuer ID required: true type: string - name: issuerCustomerExternalReference in: path description: issuerCustomerExternalReference required: true type: string - name: addressReference in: path description: addressReference required: true type: string - name: addressVersionReference in: path description: addressVersionReference required: true type: string responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityDeleteAddress' security: - basic: [] deprecated: false ? /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/external-addresses/{issuerAddressExternalReference}/address-versions/{addressVersionReference} : delete: tags: - Customer - Address summary: Delete an address for a customer by customer external reference and address external reference description: "The API allows a future permanent address or a temporary address (active or future) to be deleted.\n\nThe main input fields requested by the API are:\n•\tThe issuer ID\n•\tThe customer for which the address deletion is requested : It can be provided by using the customer reference or the issuer customer external reference\n•\tThe address of the customer for which the deletion is requested : It can be provided by using the address reference or the issuer address external reference\n•\tThe version reference of the address to be deleted\n\nAs result, the version of the customer address is deleted. If the address was an active temporary address, its end date is updated (set to the current date)\nIn response, the interface provides: \n- the address identifier (address reference or the issuer address external reference)\n- the deleted version reference of the address" operationId: deleteAddressByCusExtRefAndAdrExtRef produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: issuerId in: path description: Issuer ID required: true type: string - name: issuerCustomerExternalReference in: path description: issuerCustomerExternalReference required: true type: string - name: issuerAddressExternalReference in: path description: issuerAddressExternalReference required: true type: string - name: addressVersionReference in: path description: addressVersionReference required: true type: string responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityDeleteAddress' security: - basic: [] deprecated: false /issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}/address-versions: get: tags: - Customer - Address summary: Retrieve customer address versions operationId: retrieveAddressVersions description: "The API allows the versions of a customer address to be retrieved.\n\nThe main input fields requested by the API are:\n•\tThe issuer ID\n•\tThe customer : It can be provided by using the customer reference or the issuer customer external reference\n•\tThe address of the customer for which versions list is requested : It can be provided by using the address reference or the issuer address external reference\n\nIn response, the interface returns address data with the address version reference." produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: customerReference in: path description: Customer Reference required: true type: string - name: addressReference in: path description: Address Reference required: true type: string responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityAddressVersions' security: - basic: [] deprecated: false /issuers/{issuerId}/customers/{customerReference}/external-addresses/{issuerAddressExternalReference}/address-versions: get: tags: - Customer - Address summary: Retrieve customer address versions by address external reference operationId: retrieveAddressVersionsByIssuerExtRef description: "The API allows the versions of a customer address to be retrieved.\n\nThe main input fields requested by the API are:\n•\tThe issuer ID\n•\tThe customer : It can be provided by using the customer reference or the issuer customer external reference\n•\tThe address of the customer for which versions list is requested : It can be provided by using the address reference or the issuer address external reference\n\nIn response, the interface returns address data with the address version reference." produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: customerReference in: path description: Customer Reference required: true type: string - name: issuerAddressExternalReference in: path description: Issuer address external reference required: true type: string responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityAddressVersions' security: - basic: [] deprecated: false ? /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}/address-versions : get: tags: - Customer - Address summary: Retrieve customer address versions by customer external reference operationId: retrieveAddressVersionsByCustomerIssuerExtRef description: "The API allows the versions of a customer address to be retrieved.\n\nThe main input fields requested by the API are:\n•\tThe issuer ID\n•\tThe customer : It can be provided by using the customer reference or the issuer customer external reference\n•\tThe address of the customer for which versions list is requested : It can be provided by using the address reference or the issuer address external reference\n\nIn response, the interface returns address data with the address version reference." produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: issuerCustomerExternalReference in: path description: Issuer Customer External Reference required: true type: string - name: addressReference in: path description: Address Reference required: true type: string responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityAddressVersions' security: - basic: [] deprecated: false ? /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/external-addresses/{issuerAddressExternalReference}/address-versions : get: tags: - Customer - Address summary: Retrieve customer address versions by customer external reference and address external reference operationId: retrieveAddressVersionsByIssuerExtRefAndCustomerIssuerExtRef description: "The API allows the versions of a customer address to be retrieved.\n\nThe main input fields requested by the API are:\n•\tThe issuer ID\n•\tThe customer : It can be provided by using the customer reference or the issuer customer external reference\n•\tThe address of the customer for which versions list is requested : It can be provided by using the address reference or the issuer address external reference\n\nIn response, the interface returns address data with the address version reference." produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: issuerCustomerExternalReference in: path description: Issuer Customer External Reference required: true type: string - name: issuerAddressExternalReference in: path description: Issuer address external reference required: true type: string responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityAddressVersions' security: - basic: [] deprecated: false definitions: MailAddress: type: object required: - country properties: typeCode: type: string description: Deprecated field line1: type: string description: Address line 1 (conditional). Free text. A specific issuer algorithm can be activated to e.g. build the line, apply controls (e.g. length restriction). line2: type: string description: Address line 2 (optional). Free text. A specific issuer algorithm can be activated to e.g. build the line, apply controls (e.g. length restriction). line3: type: string description: Address line 3 (optional). Free text. A specific issuer algorithm can be activated to e.g. build the line, apply controls (e.g. length restriction). line4: type: string description: Address line 4 (optional). Free text. A specific issuer algorithm can be activated to e.g. build the line, apply controls (e.g. length restriction). line5: type: string description: Address line 5 (optional). Free text. A specific issuer algorithm can be activated to e.g. build the line, apply controls (e.g. length restriction). buildingNumber: type: string description: Building number of the address (optional) boxNumber: type: string description: Box number of the address (optional) streetName: type: string description: Street name of the address (optional) postCode: type: string description: Zip Code of the address (optional) townName: type: string description: 'City corresponding to the address ' countrySubdivision: type: string description: Subdivision of the country (optional) country: type: string description: Code of the country (mandatory). Free text. The value can be subject to a validation process if a specific rule has been configured at issuer level. The value can be optional if a specific rule has been configured. countryName: type: string description: Country Name of the address. Free text courtesyTitle: type: string description: Courtesy title of the address. Free text title: MailAddress ApiResponseEntityCreateAddressResponse: x-wl-api-response: true type: object required: - responseMetadata properties: responseMetadata: description: Response metadata allOf: - $ref: '#/definitions/ResponseMetadata' data: description: Response data allOf: - $ref: '#/definitions/CreateAddressResponse' description: Issuer response entity title: ApiResponseEntityCreateAddressResponse CreateAddressRequestPhoneNumber: type: object required: - localPhoneNumber properties: countryCode: type: string description: Country dialing code (optional). Free text. It is recommended to provide a region dialing code (e.g. +33, +49). localPhoneNumber: type: string description: 'Free text (mandatory). It’s recommended to provide an international phone number in accordance with the value provided in the country code Ex : - country code = ‘+’33’ and localPhoneNumber = ‘0622334455’ - country code = empty and localPhoneNumber = ‘+33622334455’ The value can be subject to a validation process if a specific rule has been configured at issuer level.' title: CreateAddressRequest.PhoneNumber ApiResponseEntityDeleteAddress: x-wl-api-response: true type: object required: - responseMetadata properties: responseMetadata: description: Response metadata allOf: - $ref: '#/definitions/ResponseMetadata' data: description: Response data allOf: - $ref: '#/definitions/DeleteAddressResponse' description: Delete address response entity title: ApiResponseEntityDeleteAddress AddressVersionIdentifier: type: object properties: addressVersionReference: type: string description: 'Identifies the version of the address A new version of the address is created when a change is done on the address.' title: AddressVersionIdentifier NotFoundErrorApiResponse: type: object required: - responseMetadata properties: responseMetadata: allOf: - $ref: '#/definitions/NotFoundResponseMetadata' title: NotFoundErrorApiResponse ApiResponseEntityDeleteAddressUsageResponse: x-wl-api-response: true type: object required: - responseMetadata properties: responseMetadata: description: Response metadata allOf: - $ref: '#/definitions/ResponseMetadata' data: description: Response data allOf: - $ref: '#/definitions/DeleteAddressUsageResponse' description: Issuer response entity title: ApiResponseEntityDeleteAddressUsageResponse BadGatewayErrorApiResponse: type: object required: - responseMetadata properties: responseMetadata: allOf: - $ref: '#/definitions/BadGatewayResponseMetadata' title: BadGatewayErrorApiResponse InternalServerErrorErrorApiResponse: type: object required: - responseMetadata properties: responseMetadata: allOf: - $ref: '#/definitions/InternalServerErrorResponseMetadata' title: InternalServerErrorErrorApiResponse InternalServerErrorResponseMetadata: type: object required: - correlationId - responseDateTime - statusCode - statusMessage properties: correlationId: type: string description: Correlation Identifier responseDateTime: type: string example: format:yyyy-MM-dd'T'HH:mm:ss.SSSZ description: Timestamp when response date was generated statusCode: type: integer format: int32 example: 500 description: HTTP status code statusMessage: type: string example: Internal server error description: Executed REST API status message title: InternalServerErrorResponseMetadata ApiResponseEntityAddress: x-wl-api-response: true type: object required: - responseMetadata properties: responseMetadata: description: Response metadata allOf: - $ref: '#/definitions/ResponseMetadata' data: description: Response data allOf: - $ref: '#/definitions/Address' description: Issuer response entity title: ApiResponseEntityAddress UnauthorizedErrorApiResponse: type: object required: - responseMetadata properties: responseMetadata: allOf: - $ref: '#/definitions/UnauthorizedResponseMetadata' title: UnauthorizedResponseMetadata ModifyAddressRequestPhoneNumber: type: object required: - localPhoneNumber properties: countryCode: type: string description: Country dialing code (optional). Free text. It is recommended to provide a region dialing code (e.g. +33, +49). localPhoneNumber: type: string description: 'Free text (mandatory). It’s recommended to provide an international phone number in accordance with the value provided in the country code Ex : - country code = ‘+’33’ and localPhoneNumber = ‘0622334455’ - country code = empty and localPhoneNumber = ‘+33622334455’ The value can be subject to a validation process if a specific rule has been configured at issuer level.' title: ModifyAddressRequest.PhoneNumber CreateAddressResponse: type: object properties: addressIdentifier: description: Identification of the customer address either by Issuer address external reference or by address reference allOf: - $ref: '#/definitions/AddressIdentifier' title: CreateAddressResponse AddressIdentifier: type: object properties: addressReference: type: string description: Unique internal identifier computed with a specific algorithm (mandatory) issuerAddressExternalReference: type: string description: Unique external identifier provided by the issuer (optional) title: AddressIdentifier AddressUsage: type: object required: - addressUsageName - serviceCode properties: addressUsageName: type: string example: STATEMENT_SENDING description: The business process for which the address usage is defined such as CARD_DELIVERY, PIN_MAILER_DELIVERY, STATEMENT_DELIVERY. entityReference: type: string description: 'This corresponds to the application domain of the address. It can be eg a card contract reference, card account reference. It is an optional field. It enables to have the same usage address for the same customer applied to different addresses (one cardholder with 2 card contracts: card delivery address usage is assigned to main postal address for contract A and card delivery address usage is also assigned to office postal address for contract B.' serviceCode: type: string example: ACCOUNT_SERVICE description: 'The Service for which the address usage is defined : CARD_SERVICE, ACCOUNT_SERVICE, …' title: AddressUsage ApiResponseEntityInvalidateAddressResponse: x-wl-api-response: true type: object required: - responseMetadata properties: responseMetadata: description: Response metadata allOf: - $ref: '#/definitions/ResponseMetadata' data: description: Response data allOf: - $ref: '#/definitions/InvalidAddressResponse' description: Issuer response entity title: ApiResponseEntityInvalidateAddressResponse Links: type: object required: - self properties: self: type: string example: /x/{x}?x=x description: Service method URL next: type: string example: /x/{x}?page[offset]=2 description: URL pagination query parameter next page title: Links DeleteAddressUsageResponse: type: object required: - addressUsageName - serviceCode properties: addressUsages: type: array description: List of deleted address usages items: $ref: '#/definitions/DeleteAddressUsageResponseAddressUsage' title: DeleteAddressUsageResponse CreateAddressUsageRequest: type: object required: - addressUsageName - serviceCode properties: addressUsageName: type: string example: STATEMENT_SENDING description: The business process for which the address usage is defined such as CARD_DELIVERY, PIN_MAILER_DELIVERY, STATEMENT_DELIVERY. entityReference: type: string description: 'This corresponds to the application domain of the address. It can be eg a card contract reference, card account reference. It is an optional field. It enables to have the same usage address for the same customer applied to different addresses (one cardholder with 2 card contracts: card delivery address usage is assigned to main postal address for contract A and card delivery address usage is also assigned to office postal address for contract B.' serviceCode: type: string example: ACCOUNT_SERVICE description: 'The Service for which the address usage is defined : CARD_SERVICE, ACCOUNT_SERVICE, …' title: CreateAddressUsageRequest ModifyAddressRequest: type: object required: - addressLabel - addressType properties: issuerAddressExternalReference: type: string description: Deprecated field - not to be used addressLabel: type: string example: MAIN_POSTAL_ADDRESS description: Indicate the class of the address amongst a list of possible values such as MAIN_POSTAL_ADDRESS, SECOND_POSTAL_ADDRESS, HOME_PHONE_NUMBER, PRIVATE_MOBILE_PHONE, PERSONAL_EMAIL. This list of values is shared between WL and the issuer during issuer configuration.Every label corresponds to a unique type of address. A customer (person) has at least one MAIN_POSTAL_ADDRESS (mandatory) and a company has at least one HEAD_OFFICE. addressType: type: string example: POSTAL_MAIL description: The type of an address is POSTAL_MAIL, PHONE or E_MAIL enum: - PHONE - POSTAL_MAIL - E_MAIL postalAddress: description: Customer Postal Address. This field is mandatory only if AddressType is POSTAL_MAIL.Depending on countries, the address format (mainly for line1, line 2, line3, line4 and line5) can have specific conditions such as length restriction. The customer should contact WL to check the address format and have more information. allOf: - $ref: '#/definitions/ModifyAddressRequestMailAddress' emailAddress: description: Customer Email. This field is mandatory only if AddressType is E_MAIL. allOf: - $ref: '#/definitions/EmailAddress' phone: description: 'Customer Phone details. This field is mandatory only if AddressType is PHONE. ' allOf: - $ref: '#/definitions/ModifyAddressRequestPhoneNumber' addressUsages: type: array description: List of the usages linked to the address if any exists items: $ref: '#/definitions/AddressUsage' invalid: type: boolean default: false description: Deprecated title: ModifyAddressRequest InvalidAddressResponse: type: object properties: addressIdentifier: description: Identification of the customer address either by Issuer address external reference or by address reference allOf: - $ref: '#/definitions/AddressIdentifier' invalid: type: boolean description: Indicates the address becomes invalid title: InvalidAddressResponse UnauthorizedResponseMetadata: type: object required: - correlationId - responseDateTime - statusCode - statusMessage properties: correlationId: type: string description: Correlation Identifier responseDateTime: type: string example: format:yyyy-MM-dd'T'HH:mm:ss.SSSZ description: Timestamp when response date was generated statusCode: type: integer format: int32 example: 401 description: HTTP status code statusMessage: type: string example: Unauthorized description: Executed REST API status message title: UnauthorizedResponseMetadata Address: type: object required: - addressLabel - addressType properties: issuerId: type: string description: Issuer identifier (unique per platform) addressIdentifier: description: Unique identifier of the address. See the AddressIdentifier's datatype for a detail description allOf: - $ref: '#/definitions/AddressIdentifier' addressVersionIdentifier: allOf: - $ref: '#/definitions/AddressVersionIdentifier' addressLabel: type: string example: MAIN_POSTAL_ADDRESS description: "example: MAIN_POSTAL_ADDRESS Indicate the class of the address amongst a list of possible values such as MAIN_POSTAL_ADDRESS, SECOND_POSTAL_ADDRESS, HOME_PHONE_NUMBER, PRIVATE_MOBILE_PHONE, PERSONAL_EMAIL. This list of values is shared between WL and the issuer during issuer configuration. \n Every label corresponds to a unique type of address. A customer (person) has at least one MAIN_POSTAL_ADDRESS (mandatory) and a company has at least one HEAD_OFFICE." addressType: type: string example: POSTAL_MAIL description: The type of an address is POSTAL_MAIL, PHONE or E_MAIL enum: - PHONE - POSTAL_MAIL - E_MAIL postalAddress: description: "Customer Postal Address. This field is mandatory only if AddressType is POSTAL_MAIL. \n Depending on countries, the address format (mainly for line1, line 2, line3, line4 and line5) can have specific conditions such as length restriction. The customer should contact WL to check the address format and have more information." allOf: - $ref: '#/definitions/MailAddress' emailAddress: description: Customer Email. This field is mandatory only if AddressType is E_MAIL. See the EmailAddress' datatype for the detail list of the attributes. allOf: - $ref: '#/definitions/EmailAddress' phone: description: Customer Phone details. This field is mandatory only if AddressType is PHONE. See the PhoneNumber's datatype for the detail list of the attributes. allOf: - $ref: '#/definitions/PhoneNumber' addressUsages: type: array description: 'List of the usages linked to the address if any exists. See the AddressUsage''s datatype for the detail list of the attributes (optional) _Embedded property, only filled when available for the endpoint and explicitly requested in the ''embed'' query parameter._' items: $ref: '#/definitions/AddressUsage' status: type: string description: Status of the address (ACTIVE or INACTIVE). If value is not provided, by default 'ACTIVE' statusDate: type: string description: 'If the address is INACTIVE, the date corresponds to the inactivation date. If the address is ACTIVE, the date corresponds to the last activation date.' format: date-time startDate: type: string description: Date when the address starts to be active format: date-time endDate: type: string description: 'This attribute represents : • in case of a permanent address : the last date the address has been active. This information is computed based on the next future address start date if any exists else this attribute is empty. • in case of a temporary address : the end date where this address is active. This end date is mandatory when a temporary address is created.' format: date-time invalid: type: boolean description: "Indicates if an address is invalid (by default false).\nThis feature is currently only accurate for the mail address and apply only on the current permanent address.\nIn case a postal address is invalid, this address cannot be used anymore for letters, cards, pin mailers, statement sending. \nThis feature is active only depending on an issuer configuration. " default: false temporary: type: boolean description: 'indicates if the address is a temporary one (by default ''false''). In case of a temporary address, the end date is mandatory.' default: false title: Address DeleteAddressUsageResponseAddressUsage: type: object required: - addressUsageName - serviceCode properties: addressUsageName: type: string example: STATEMENT_SENDING description: The business process for which the address usage is defined such as CARD_DELIVERY, PIN_MAILER_DELIVERY, STATEMENT_DELIVERY. entityReference: type: string description: 'This corresponds to the application domain of the address. It can be eg a card contract reference, card account reference. It is an optional field. It enables to have the same usage address for the same customer applied to different addresses (one cardholder with 2 card contracts: card delivery address usage is assigned to main postal address for contract A and card delivery address usage is also assigned to office postal address for contract B.' serviceCode: type: string example: ACCOUNT_SERVICE description: 'The Service for which the address usage is defined : CARD_SERVICE, ACCOUNT_SERVICE, …' title: DeleteAddressUsageResponseAddressUsage ApiResponseEntityActivateAddressResponse: x-wl-api-response: true type: object required: - responseMetadata properties: responseMetadata: description: Response metadata allOf: - $ref: '#/definitions/ResponseMetadata' data: description: Response data allOf: - $ref: '#/definitions/ActivateAddressResponse' description: Issuer response entity title: ApiResponseEntityActivateAddressResponse ResponseMetadata: type: object required: - correlationId - responseDateTime - statusCode - statusMessage properties: correlationId: type: string description: Correlation Identifier links: description: Metadata Links allOf: - $ref: '#/definitions/Links' statusMessage: type: string example: Executed successfully description: Executed REST API status message statusCode: type: integer format: int32 example: 200 description: HTTP status code responseDateTime: type: string example: format:yyyy-MM-dd'T'HH:mm:ss.SSSZ description: Timestamp when response date was generated timeTakenMs: type: integer format: int64 example: 12 description: Wall clock time required from service to generate the response title: ResponseMetadata NotFoundResponseMetadata: type: object required: - correlationId - responseDateTime - statusCode - statusMessage properties: correlationId: type: string description: Correlation Identifier responseDateTime: type: string example: format:yyyy-MM-dd'T'HH:mm:ss.SSSZ description: Timestamp when response date was generated statusCode: type: integer format: int32 example: 404 description: HTTP status code statusMessage: type: string example: Not found description: Executed REST API status message title: NotFoundResponseMetadata ModifyAddressResponse: type: object properties: addressIdentifier: description: Identification of the customer address either by Issuer address external reference or by address reference allOf: - $ref: '#/definitions/AddressIdentifier' title: ModifyAddressResponse CreateAddressRequest: type: object required: - addressLabel - addressType properties: issuerAddressExternalReference: type: string description: Unique external identifier provided by the issuer addressLabel: type: string example: MAIN_POSTAL_ADDRESS description: Indicate the class of the address amongst a list of possible values such as MAIN_POSTAL_ADDRESS, SECOND_POSTAL_ADDRESS, HOME_PHONE_NUMBER, PRIVATE_MOBILE_PHONE, PERSONAL_EMAIL.This list of values is shared between WL and the issuer during issuer configuration.Every label corresponds to a unique type of address. A customer (person) has at least one MAIN_POSTAL_ADDRESS (mandatory) and a company has at least one HEAD_OFFICE. addressType: type: string example: POSTAL_MAIL description: The type of an address is POSTAL_MAIL, PHONE or E_MAIL enum: - PHONE - POSTAL_MAIL - E_MAIL postalAddress: description: Customer Postal Address. This field is mandatory only if AddressType is POSTAL_MAIL.Depending on countries, the address format (mainly for line1, line 2, line3, line4 and line5) can have specific conditions such as length restriction. The customer should contact WL to check the address format and have more information. allOf: - $ref: '#/definitions/CreateAddressRequestMailAddress' emailAddress: description: Customer Email. This field is mandatory only if AddressType is E_MAIL. allOf: - $ref: '#/definitions/EmailAddress' phone: description: Customer Phone details. This field is mandatory only if AddressType is PHONE. allOf: - $ref: '#/definitions/CreateAddressRequestPhoneNumber' addressUsages: type: array description: List of the usages linked to the address if any exists items: $ref: '#/definitions/AddressUsage' startDate: type: string description: "If the date is not provided, the current date and time of the user’s request is used.\nIf the provided date corresponds to the current date, the provided time is ignored and replaced by the current time of the system.\nIf the provided date is in the future (at least current date +1), provided date and time are used only if the LABEL of the address is already existing for the customer. In case the time is not provided, the time is set up to the start of the day (e.g. ‘T00:00:00’)\nIn all cases, if the address is created for the first time for a given LABEL, both date and time of the system are used and the address is immediately active. \nFor generic definition, refer to Address.startDate." format: date-time endDate: type: string description: 'This date is conditional to the kind of address : - if the address is a permanent one (temporary flag = false or empty), the field must be empty - if the address is a temporary one (temporary flag = true), the field must be filled with the date corresponding to the end date of the active period of the temporary address' format: date-time temporary: type: boolean default: false description: The flag indicates if the address is permanent (by default, false) or temporary (flag = true) format: date-time title: CreateAddressRequest ModifyAddressRequestMailAddress: type: object required: - country properties: typeCode: type: string description: DEPRECATED courtesyTitle: type: string description: Courtesy title of the address. Free text line1: type: string description: Address line 1 (conditional). Free text. A specific issuer algorithm can be activated to e.g. build the line, apply controls (e.g. length restriction). line2: type: string description: Address line 2 (conditional). Free text. A specific issuer algorithm can be activated to e.g. build the line, apply controls (e.g. length restriction). line3: type: string description: Address line 3 (conditional). Free text. A specific issuer algorithm can be activated to e.g. build the line, apply controls (e.g. length restriction). line4: type: string description: Address line 4 (conditional). Free text. A specific issuer algorithm can be activated to e.g. build the line, apply controls (e.g. length restriction). line5: type: string description: Address line 5 (conditional). Free text. A specific issuer algorithm can be activated to e.g. build the line, apply controls (e.g. length restriction). buildingNumber: type: string description: Building number of the address (optional) boxNumber: type: string description: Box number of the address (optional) streetName: type: string description: Street name of the address (optional) postCode: type: string description: zip code of the address (optional) townName: type: string description: City corresponding to the address countrySubdivision: type: string description: Subdivision of the country (optional) country: type: string description: Code of the country (mandatory). Free text. The value can be subject to a validation process if a specific rule has been configured at issuer level. The value can be optional if a specific rule has been configured. title: ModifyAddressRequest.MailAddress ActivateAddressResponse: type: object properties: addressIdentifier: description: Identification of the customer address either by Issuer address external reference or by address reference allOf: - $ref: '#/definitions/AddressIdentifier' status: type: string description: Status of the address (ACTIVE) title: ActivateAddressResponse ApiResponseEntityCreateAddressUsageResponse: x-wl-api-response: true type: object required: - responseMetadata properties: responseMetadata: description: Response metadata allOf: - $ref: '#/definitions/ResponseMetadata' data: description: Response data allOf: - $ref: '#/definitions/CreateAddressUsageResponse' description: Issuer response entity title: ApiResponseEntityCreateAddressUsageResponse ForbiddenErrorApiResponse: type: object required: - responseMetadata properties: responseMetadata: allOf: - $ref: '#/definitions/ForbiddenResponseMetadata' title: ForbiddenErrorApiResponse DeactivateAddressResponse: type: object properties: addressIdentifier: description: Identification of the customer address either by Issuer address external reference or by address reference allOf: - $ref: '#/definitions/AddressIdentifier' status: type: string description: Status of the address (INACTIVE) title: DeactivateAddressResponse ApiResponseEntityAddressVersions: x-wl-api-response: true type: object required: - responseMetadata properties: responseMetadata: description: Response metadata allOf: - $ref: '#/definitions/ResponseMetadata' data: type: array items: $ref: '#/definitions/Address' description: Response data description: Retrieve address versions response entity title: ApiResponseEntityAddressVersions CreateAddressRequestMailAddress: type: object required: - country properties: typeCode: type: string description: DEPRECATED courtesyTitle: type: string description: Courtesy title of the address. Free text line1: type: string description: Address line 1 (conditional). Free text. A specific issuer algorithm can be activated to e.g. build the line, apply controls (e.g. length restriction). line2: type: string description: Address line 2 (conditional). Free text. A specific issuer algorithm can be activated to e.g. build the line, apply controls (e.g. length restriction). line3: type: string description: Address line 3 (conditional). Free text. A specific issuer algorithm can be activated to e.g. build the line, apply controls (e.g. length restriction). line4: type: string description: Address line 4 (conditional). Free text. A specific issuer algorithm can be activated to e.g. build the line, apply controls (e.g. length restriction). line5: type: string description: Address line 5 (conditional). Free text. A specific issuer algorithm can be activated to e.g. build the line, apply controls (e.g. length restriction). buildingNumber: type: string description: Building number of the address (optional) boxNumber: type: string description: Box number of the address (optional) streetName: type: string description: Street name of the address (optional) postCode: type: string description: zip code of the address (optional) townName: type: string description: City corresponding to the address countrySubdivision: type: string description: Subdivision of the country (optional) country: type: string description: Code of the country (mandatory). Free text. The value can be subject to a validation process if a specific rule has been configured at issuer level. The value can be optional if a specific rule has been configured. title: CreateAddressRequest.MailAddress CreateAddressUsageResponse: type: object required: - addressUsageName - serviceCode properties: addressUsageName: type: string example: STATEMENT_SENDING description: The business process for which the address usage is defined such as CARD_DELIVERY, PIN_MAILER_DELIVERY, STATEMENT_DELIVERY. entityReference: type: string description: 'This corresponds to the application domain of the address. It can be eg a card contract reference, card account reference. It is an optional field. It enables to have the same usage address for the same customer applied to different addresses (one cardholder with 2 card contracts: card delivery address usage is assigned to main postal address for contract A and card delivery address usage is also assigned to office postal address for contract B.' serviceCode: type: string example: ACCOUNT_SERVICE description: 'The Service for which the address usage is defined : CARD_SERVICE, ACCOUNT_SERVICE, …' title: CreateAddressUsageResponse ApiResponseEntityDeactivateAddressResponse: x-wl-api-response: true type: object required: - responseMetadata properties: responseMetadata: description: Response metadata allOf: - $ref: '#/definitions/ResponseMetadata' data: description: Response data allOf: - $ref: '#/definitions/DeactivateAddressResponse' description: Issuer response entity title: ApiResponseEntityDeactivateAddressResponse ApiResponseEntityModifyAddressResponse: x-wl-api-response: true type: object required: - responseMetadata properties: responseMetadata: description: Response metadata allOf: - $ref: '#/definitions/ResponseMetadata' data: description: Response data allOf: - $ref: '#/definitions/ModifyAddressResponse' description: Issuer response entity title: ApiResponseEntityModifyAddressResponse BadRequestResponseMetadata: type: object required: - correlationId - responseDateTime - statusCode - statusMessage properties: correlationId: type: string description: Correlation Identifier responseDateTime: type: string example: format:yyyy-MM-dd'T'HH:mm:ss.SSSZ description: Timestamp when response date was generated statusCode: type: integer format: int32 example: 400 description: HTTP status code statusMessage: type: string example: Bad request description: Executed REST API status message title: BadRequestResponseMetadata EmailAddress: type: object required: - email properties: email: type: string description: 'Email address of the Customer (mandatory). The email address should have the following format: aaa@bbb.ccc aaa, bbb, ccc are character string.' title: EmailAddress PhoneNumber: type: object required: - localPhoneNumber properties: countryCode: type: string description: Country dialing code (optional). Free text. It is recommended to provide a region dialing code (e.g. +33, +49). localPhoneNumber: type: string description: "Free text (mandatory). It’s recommended to provide an international phone number in accordance with the value provided in the country code.\nEx : \n- country code = ‘+’33’ and localPhoneNumber = ‘0622334455’ \n- country code = empty and localPhoneNumber = ‘+33622334455’\nThe value can be subject to a validation process if a specific rule has been configured at issuer level." internationalPhoneNumber: type: string description: "Free text (mandatory). It’s recommended to provide an international phone number in accordance with the value provided in the country code.\nEx : \n- country code = ‘+’33’ and localPhoneNumber = ‘0622334455’ \n- country code = empty and localPhoneNumber = ‘+33622334455’\nThe value can be subject to a validation process if a specific rule has been configured at issuer level." title: PhoneNumber BadGatewayResponseMetadata: type: object required: - correlationId - responseDateTime - statusCode - statusMessage properties: correlationId: type: string description: Correlation Identifier responseDateTime: type: string example: format:yyyy-MM-dd'T'HH:mm:ss.SSSZ description: Timestamp when response date was generated statusCode: type: integer format: int32 example: 502 description: HTTP status code statusMessage: type: string example: Bad Gateway description: Executed REST API status message title: BadGatewayResponseMetadata BadRequestErrorApiResponse: type: object required: - responseMetadata properties: responseMetadata: allOf: - $ref: '#/definitions/BadRequestResponseMetadata' title: BadRequestErrorApiResponse DeleteAddressResponse: type: object required: - addressIdentifier - addressVersionIdentifier properties: addressIdentifier: description: Identification of the customer address either by Issuer address external reference or by address reference allOf: - $ref: '#/definitions/AddressIdentifier' addressVersionIdentifier: description: Identification of the address version by address version reference allOf: - $ref: '#/definitions/AddressVersionIdentifier' title: DeleteAddressResponse ForbiddenResponseMetadata: type: object required: - correlationId - responseDateTime - statusCode - statusMessage properties: correlationId: type: string description: Correlation Identifier responseDateTime: type: string example: format:yyyy-MM-dd'T'HH:mm:ss.SSSZ description: Timestamp when response date was generated statusCode: type: integer format: int32 example: 403 description: HTTP status code statusMessage: type: string example: Forbidden description: Executed REST API status message title: ForbiddenResponseMetadata securityDefinitions: basic: type: oauth2 flow: application tokenUrl: https://sbx-wlip.api1-eu2.psapigateway.preprod.giservices.io/token