{ "opencollection": "1.0.0", "info": { "name": "Worldline Card Issuing Account - AccountState Customer - Address API", "version": "2.41.1" }, "items": [ { "info": { "name": "Customer - Address", "type": "folder" }, "items": [ { "info": { "name": "Create address for a customer by external reference", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/customers/external-customers/:issuerCustomerExternalReference/addresses", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "filter", "value": "", "type": "query", "description": "Filtered Fields" }, { "name": "issuerId", "value": "", "type": "path", "description": "Issuer ID" }, { "name": "issuerCustomerExternalReference", "value": "", "type": "path", "description": "Issuer Customer External Reference" } ] }, "docs": "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 lab" }, { "info": { "name": "Retrieve customer address by customer external reference and address external reference", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/customers/external-customers/:issuerCustomerExternalReference/addresses/external-addresses/:issuerAddressExternalReference", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "filter", "value": "", "type": "query", "description": "Filtered Fields" }, { "name": "issuerId", "value": "", "type": "path", "description": "Issuer ID" }, { "name": "issuerCustomerExternalReference", "value": "", "type": "path", "description": "Issuer Customer External Reference" }, { "name": "issuerAddressExternalReference", "value": "", "type": "path", "description": "Issuer address external reference" }, { "name": "embed", "value": "", "type": "query", "description": "Embedded Fields" } ] }, "docs": "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." }, { "info": { "name": "Update address by customer external reference and address external reference", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/issuers/:issuerId/customers/external-customers/:issuerCustomerExternalReference/addresses/external-addresses/:issuerAddressExternalReference", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "filter", "value": "", "type": "query", "description": "Filtered Fields" }, { "name": "issuerId", "value": "", "type": "path", "description": "Issuer ID" }, { "name": "issuerCustomerExternalReference", "value": "", "type": "path", "description": "Issuer Customer External Reference" }, { "name": "issuerAddressExternalReference", "value": "", "type": "path", "description": "Issuer address external reference" } ] }, "docs": "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 addr" }, { "info": { "name": "Invalidate address by customer external reference and address external reference", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/customers/external-customers/:issuerCustomerExternalReference/addresses/external-addresses/:issuerAddressExternalReference/invalidate", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "issuerId", "value": "", "type": "path", "description": "Issuer ID" }, { "name": "issuerCustomerExternalReference", "value": "", "type": "path", "description": "Issuer Customer External Reference" }, { "name": "issuerAddressExternalReference", "value": "", "type": "path", "description": "Issuer address external reference" } ] }, "docs": "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'." }, { "info": { "name": "Invalidate address by customer external reference", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/customers/external-customers/:issuerCustomerExternalReference/addresses/:addressReference/invalidate", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "issuerId", "value": "", "type": "path", "description": "Issuer ID" }, { "name": "issuerCustomerExternalReference", "value": "", "type": "path", "description": "Issuer Customer External Reference" }, { "name": "addressReference", "value": "", "type": "path", "description": "Address Reference" } ] }, "docs": "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'." }, { "info": { "name": "Invalidate address by address external reference", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/customers/:customerReference/addresses/external-addresses/:issuerAddressExternalReference/invalidate", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "issuerId", "value": "", "type": "path", "description": "Issuer ID" }, { "name": "customerReference", "value": "", "type": "path", "description": "Customer Reference" }, { "name": "issuerAddressExternalReference", "value": "", "type": "path", "description": "Issuer address external reference" } ] }, "docs": "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'." }, { "info": { "name": "Invalidate address", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/customers/:customerReference/addresses/:addressReference/invalidate", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "issuerId", "value": "", "type": "path", "description": "Issuer ID" }, { "name": "customerReference", "value": "", "type": "path", "description": "Customer Reference" }, { "name": "addressReference", "value": "", "type": "path", "description": "Address Reference" } ] }, "docs": "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'." }, { "info": { "name": "Activate address by customer external reference and address external reference", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/customers/external-customers/:issuerCustomerExternalReference/addresses/external-addresses/:issuerAddressExternalReference/activate", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "filter", "value": "", "type": "query", "description": "Filtered Fields" }, { "name": "issuerId", "value": "", "type": "path", "description": "Issuer ID" }, { "name": "issuerCustomerExternalReference", "value": "", "type": "path", "description": "Issuer Customer External Reference" }, { "name": "issuerAddressExternalReference", "value": "", "type": "path", "description": "Issuer address external reference" } ] }, "docs": "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." }, { "info": { "name": "Add an address usage by customer external reference and address external reference", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/customers/external-customers/:issuerCustomerExternalReference/addresses/external-addresses/:issuerAddressExternalReference/address-usages", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "filter", "value": "", "type": "query", "description": "Filtered Fields" }, { "name": "issuerId", "value": "", "type": "path", "description": "Issuer ID" }, { "name": "issuerCustomerExternalReference", "value": "", "type": "path", "description": "Issuer Customer External Reference" }, { "name": "issuerAddressExternalReference", "value": "", "type": "path", "description": "Issuer address external reference" } ] }, "docs": "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 c" }, { "info": { "name": "Remove an address usage by customer external reference and address external reference", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/issuers/:issuerId/customers/external-customers/:issuerCustomerExternalReference/addresses/external-addresses/:issuerAddressExternalReference/address-usages", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "filter", "value": "", "type": "query", "description": "Filtered Fields" }, { "name": "issuerId", "value": "", "type": "path", "description": "Issuer ID" }, { "name": "issuerCustomerExternalReference", "value": "", "type": "path", "description": "Issuer Customer External Reference" }, { "name": "issuerAddressExternalReference", "value": "", "type": "path", "description": "Issuer address external reference" }, { "name": "serviceCode", "value": "", "type": "query", "description": "The Service for which the address usage is defined : CARD_SERVICE, ACCOUNT_SERVICE. Mandatory " }, { "name": "entityReference", "value": "", "type": "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.\nIt 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." }, { "name": "addressUsageName", "value": "", "type": "query", "description": "The business process for which the address usage is defined such as CARD_DELIVERY, PIN_MAILER_DELIVERY, STATEMENT_DELIVERY." } ] }, "docs": "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 addressUs" }, { "info": { "name": "Deactivate address by customer external reference and address external reference", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/customers/external-customers/:issuerCustomerExternalReference/addresses/external-addresses/:issuerAddressExternalReference/deactivate", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "filter", "value": "", "type": "query", "description": "Filtered Fields" }, { "name": "issuerId", "value": "", "type": "path", "description": "Issuer ID" }, { "name": "issuerCustomerExternalReference", "value": "", "type": "path", "description": "Issuer Customer External Reference" }, { "name": "issuerAddressExternalReference", "value": "", "type": "path", "description": "Issuer address external reference" } ] }, "docs": "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." }, { "info": { "name": "Retrieve customer address by customer external reference", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/customers/external-customers/:issuerCustomerExternalReference/addresses/:addressReference", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "filter", "value": "", "type": "query", "description": "Filtered Fields" }, { "name": "issuerId", "value": "", "type": "path", "description": "Issuer ID" }, { "name": "issuerCustomerExternalReference", "value": "", "type": "path", "description": "Issuer Customer External Reference" }, { "name": "addressReference", "value": "", "type": "path", "description": "Address Reference" }, { "name": "embed", "value": "", "type": "query", "description": "Embedded Fields" } ] }, "docs": "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." }, { "info": { "name": "Update address by customer external reference", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/issuers/:issuerId/customers/external-customers/:issuerCustomerExternalReference/addresses/:addressReference", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "filter", "value": "", "type": "query", "description": "Filtered Fields" }, { "name": "issuerId", "value": "", "type": "path", "description": "Issuer ID" }, { "name": "issuerCustomerExternalReference", "value": "", "type": "path", "description": "Issuer Customer External Reference" }, { "name": "addressReference", "value": "", "type": "path", "description": "Address Reference" } ] }, "docs": "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 addr" }, { "info": { "name": "Activate address by customer external reference", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/customers/external-customers/:issuerCustomerExternalReference/addresses/:addressReference/activate", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "filter", "value": "", "type": "query", "description": "Filtered Fields" }, { "name": "issuerId", "value": "", "type": "path", "description": "Issuer ID" }, { "name": "issuerCustomerExternalReference", "value": "", "type": "path", "description": "Issuer Customer External Reference" }, { "name": "addressReference", "value": "", "type": "path", "description": "Address Reference" } ] }, "docs": "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." }, { "info": { "name": "Add an address usage by customer external reference", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/customers/external-customers/:issuerCustomerExternalReference/addresses/:addressReference/address-usages", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "filter", "value": "", "type": "query", "description": "Filtered Fields" }, { "name": "issuerId", "value": "", "type": "path", "description": "Issuer ID" }, { "name": "issuerCustomerExternalReference", "value": "", "type": "path", "description": "Issuer Customer External Reference" }, { "name": "addressReference", "value": "", "type": "path", "description": "Address Reference" } ] }, "docs": "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 c" }, { "info": { "name": "Remove an address usage by customer external reference", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/issuers/:issuerId/customers/external-customers/:issuerCustomerExternalReference/addresses/:addressReference/address-usages", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "filter", "value": "", "type": "query", "description": "Filtered Fields" }, { "name": "issuerId", "value": "", "type": "path", "description": "Issuer ID" }, { "name": "issuerCustomerExternalReference", "value": "", "type": "path", "description": "Issuer Customer External Reference" }, { "name": "addressReference", "value": "", "type": "path", "description": "Address Reference" }, { "name": "serviceCode", "value": "", "type": "query", "description": "The Service for which the address usage is defined : CARD_SERVICE, ACCOUNT_SERVICE. Mandatory " }, { "name": "entityReference", "value": "", "type": "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.\nIt 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." }, { "name": "addressUsageName", "value": "", "type": "query", "description": "The business process for which the address usage is defined such as CARD_DELIVERY, PIN_MAILER_DELIVERY, STATEMENT_DELIVERY." } ] }, "docs": "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 addressUs" }, { "info": { "name": "Deactivate address by customer external reference", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/customers/external-customers/:issuerCustomerExternalReference/addresses/:addressReference/deactivate", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "filter", "value": "", "type": "query", "description": "Filtered Fields" }, { "name": "issuerId", "value": "", "type": "path", "description": "Issuer ID" }, { "name": "issuerCustomerExternalReference", "value": "", "type": "path", "description": "Issuer Customer External Reference" }, { "name": "addressReference", "value": "", "type": "path", "description": "Address Reference" } ] }, "docs": "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 :\n-the address is the MAIN_POSTAL_ADDRESS\n-an usage is linked to the address. " }, { "info": { "name": "Create address for a customer", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/customers/:customerReference/addresses", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "filter", "value": "", "type": "query", "description": "Filtered Fields" }, { "name": "issuerId", "value": "", "type": "path", "description": "Issuer ID" }, { "name": "customerReference", "value": "", "type": "path", "description": "Customer Reference" } ] }, "docs": "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 lab" }, { "info": { "name": "Retrieve customer address by address external reference", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/customers/:customerReference/addresses/external-addresses/:issuerAddressExternalReference", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "filter", "value": "", "type": "query", "description": "Filtered Fields" }, { "name": "issuerId", "value": "", "type": "path", "description": "Issuer ID" }, { "name": "customerReference", "value": "", "type": "path", "description": "Customer Reference" }, { "name": "issuerAddressExternalReference", "value": "", "type": "path", "description": "Issuer address external reference" }, { "name": "embed", "value": "", "type": "query", "description": "Embedded Fields" } ] }, "docs": "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." }, { "info": { "name": "Update address by address external reference", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/issuers/:issuerId/customers/:customerReference/addresses/external-addresses/:issuerAddressExternalReference", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "filter", "value": "", "type": "query", "description": "Filtered Fields" }, { "name": "issuerId", "value": "", "type": "path", "description": "Issuer ID" }, { "name": "customerReference", "value": "", "type": "path", "description": "Customer Reference" }, { "name": "issuerAddressExternalReference", "value": "", "type": "path", "description": "Issuer address external reference" } ] }, "docs": "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 addr" }, { "info": { "name": "Add an address usage by address external reference", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/customers/:customerReference/addresses/external-addresses/:issuerAddressExternalReference/address-usages", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "filter", "value": "", "type": "query", "description": "Filtered Fields" }, { "name": "issuerId", "value": "", "type": "path", "description": "Issuer ID" }, { "name": "customerReference", "value": "", "type": "path", "description": "Customer Reference" }, { "name": "issuerAddressExternalReference", "value": "", "type": "path", "description": "Issuer address external reference" } ] }, "docs": "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 c" }, { "info": { "name": "Remove an address usage by address external reference", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/issuers/:issuerId/customers/:customerReference/addresses/external-addresses/:issuerAddressExternalReference/address-usages", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "filter", "value": "", "type": "query", "description": "Filtered Fields" }, { "name": "issuerId", "value": "", "type": "path", "description": "Issuer ID" }, { "name": "customerReference", "value": "", "type": "path", "description": "Customer Reference" }, { "name": "issuerAddressExternalReference", "value": "", "type": "path", "description": "Issuer address external reference" }, { "name": "serviceCode", "value": "", "type": "query", "description": "The Service for which the address usage is defined : CARD_SERVICE, ACCOUNT_SERVICE. Mandatory " }, { "name": "entityReference", "value": "", "type": "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.\nIt 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." }, { "name": "addressUsageName", "value": "", "type": "query", "description": "The business process for which the address usage is defined such as CARD_DELIVERY, PIN_MAILER_DELIVERY, STATEMENT_DELIVERY." } ] }, "docs": "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 addressU" }, { "info": { "name": "Activate address by address external reference", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/customers/:customerReference/addresses/external-addresses/:issuerAddressExternalReference/activate", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "filter", "value": "", "type": "query", "description": "Filtered Fields" }, { "name": "issuerId", "value": "", "type": "path", "description": "Issuer ID" }, { "name": "customerReference", "value": "", "type": "path", "description": "Customer Reference" }, { "name": "issuerAddressExternalReference", "value": "", "type": "path", "description": "Issuer address external reference" } ] }, "docs": "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." }, { "info": { "name": "Deactivate address by address external reference", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/customers/:customerReference/addresses/external-addresses/:issuerAddressExternalReference/deactivate", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "filter", "value": "", "type": "query", "description": "Filtered Fields" }, { "name": "issuerId", "value": "", "type": "path", "description": "Issuer ID" }, { "name": "customerReference", "value": "", "type": "path", "description": "Customer Reference" }, { "name": "issuerAddressExternalReference", "value": "", "type": "path", "description": "Issuer address external reference" } ] }, "docs": "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 :\n-the address is the MAIN_POSTAL_ADDRESS\n-an usage is linked to the address. " }, { "info": { "name": "Retrieve customer address", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/customers/:customerReference/addresses/:addressReference", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "filter", "value": "", "type": "query", "description": "Filtered Fields" }, { "name": "issuerId", "value": "", "type": "path", "description": "Issuer ID" }, { "name": "customerReference", "value": "", "type": "path", "description": "Customer Reference" }, { "name": "addressReference", "value": "", "type": "path", "description": "Address Reference" }, { "name": "embed", "value": "", "type": "query", "description": "Embedded Fields" } ] }, "docs": "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." }, { "info": { "name": "Update address", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/issuers/:issuerId/customers/:customerReference/addresses/:addressReference", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "filter", "value": "", "type": "query", "description": "Filtered Fields" }, { "name": "issuerId", "value": "", "type": "path", "description": "Issuer ID" }, { "name": "customerReference", "value": "", "type": "path", "description": "Customer Reference" }, { "name": "addressReference", "value": "", "type": "path", "description": "Address Reference" } ] }, "docs": "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 addr" }, { "info": { "name": "Activate address", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/customers/:customerReference/addresses/:addressReference/activate", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "filter", "value": "", "type": "query", "description": "Filtered Fields" }, { "name": "issuerId", "value": "", "type": "path", "description": "Issuer ID" }, { "name": "customerReference", "value": "", "type": "path", "description": "Customer Reference" }, { "name": "addressReference", "value": "", "type": "path", "description": "Address Reference" } ] }, "docs": "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." }, { "info": { "name": "Add an address usage", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/customers/:customerReference/addresses/:addressReference/address-usages", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "filter", "value": "", "type": "query", "description": "Filtered Fields" }, { "name": "issuerId", "value": "", "type": "path", "description": "Issuer ID" }, { "name": "customerReference", "value": "", "type": "path", "description": "Customer Reference" }, { "name": "addressReference", "value": "", "type": "path", "description": "Address Reference" } ] }, "docs": "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 c" }, { "info": { "name": "Remove an address usage", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/issuers/:issuerId/customers/:customerReference/addresses/:addressReference/address-usages", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "filter", "value": "", "type": "query", "description": "Filtered Fields" }, { "name": "issuerId", "value": "", "type": "path", "description": "Issuer ID" }, { "name": "customerReference", "value": "", "type": "path", "description": "Customer Reference" }, { "name": "addressReference", "value": "", "type": "path", "description": "Address Reference" }, { "name": "serviceCode", "value": "", "type": "query", "description": "The Service for which the address usage is defined : CARD_SERVICE, ACCOUNT_SERVICE. Mandatory " }, { "name": "entityReference", "value": "", "type": "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.\nIt 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." }, { "name": "addressUsageName", "value": "", "type": "query", "description": "The business process for which the address usage is defined such as CARD_DELIVERY, PIN_MAILER_DELIVERY, STATEMENT_DELIVERY." } ] }, "docs": "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 addressU" }, { "info": { "name": "Deactivate address", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/customers/:customerReference/addresses/:addressReference/deactivate", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "filter", "value": "", "type": "query", "description": "Filtered Fields" }, { "name": "issuerId", "value": "", "type": "path", "description": "Issuer ID" }, { "name": "customerReference", "value": "", "type": "path", "description": "Customer Reference" }, { "name": "addressReference", "value": "", "type": "path", "description": "Address Reference" } ] }, "docs": "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." }, { "info": { "name": "Delete an address for a customer", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/issuers/:issuerId/customers/:customerReference/addresses/:addressReference/address-versions/:addressVersionReference", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "issuerId", "value": "", "type": "path", "description": "Issuer ID" }, { "name": "customerReference", "value": "", "type": "path", "description": "customerReference" }, { "name": "addressReference", "value": "", "type": "path", "description": "addressReference" }, { "name": "addressVersionReference", "value": "", "type": "path", "description": "addressVersionReference" } ] }, "docs": "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" }, { "info": { "name": "Delete an address for a customer by address external reference", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/issuers/:issuerId/customers/:customerReference/external-addresses/:issuerAddressExternalReference/address-versions/:addressVersionReference", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "issuerId", "value": "", "type": "path", "description": "Issuer ID" }, { "name": "customerReference", "value": "", "type": "path", "description": "customerReference" }, { "name": "issuerAddressExternalReference", "value": "", "type": "path", "description": "issuerAddressExternalReference" }, { "name": "addressVersionReference", "value": "", "type": "path", "description": "addressVersionReference" } ] }, "docs": "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" }, { "info": { "name": "Delete an address for a customer by customer external reference", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/issuers/:issuerId/customers/external-customers/:issuerCustomerExternalReference/addresses/:addressReference/address-versions/:addressVersionReference", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "issuerId", "value": "", "type": "path", "description": "Issuer ID" }, { "name": "issuerCustomerExternalReference", "value": "", "type": "path", "description": "issuerCustomerExternalReference" }, { "name": "addressReference", "value": "", "type": "path", "description": "addressReference" }, { "name": "addressVersionReference", "value": "", "type": "path", "description": "addressVersionReference" } ] }, "docs": "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" }, { "info": { "name": "Delete an address for a customer by customer external reference and address external reference", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/issuers/:issuerId/customers/external-customers/:issuerCustomerExternalReference/external-addresses/:issuerAddressExternalReference/address-versions/:addressVersionReference", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "issuerId", "value": "", "type": "path", "description": "Issuer ID" }, { "name": "issuerCustomerExternalReference", "value": "", "type": "path", "description": "issuerCustomerExternalReference" }, { "name": "issuerAddressExternalReference", "value": "", "type": "path", "description": "issuerAddressExternalReference" }, { "name": "addressVersionReference", "value": "", "type": "path", "description": "addressVersionReference" } ] }, "docs": "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" }, { "info": { "name": "Retrieve customer address versions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/customers/:customerReference/addresses/:addressReference/address-versions", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "filter", "value": "", "type": "query", "description": "Filtered Fields" }, { "name": "issuerId", "value": "", "type": "path", "description": "Issuer ID" }, { "name": "customerReference", "value": "", "type": "path", "description": "Customer Reference" }, { "name": "addressReference", "value": "", "type": "path", "description": "Address Reference" } ] }, "docs": "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." }, { "info": { "name": "Retrieve customer address versions by address external reference", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/customers/:customerReference/external-addresses/:issuerAddressExternalReference/address-versions", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "filter", "value": "", "type": "query", "description": "Filtered Fields" }, { "name": "issuerId", "value": "", "type": "path", "description": "Issuer ID" }, { "name": "customerReference", "value": "", "type": "path", "description": "Customer Reference" }, { "name": "issuerAddressExternalReference", "value": "", "type": "path", "description": "Issuer address external reference" } ] }, "docs": "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." }, { "info": { "name": "Retrieve customer address versions by customer external reference", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/customers/external-customers/:issuerCustomerExternalReference/addresses/:addressReference/address-versions", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "filter", "value": "", "type": "query", "description": "Filtered Fields" }, { "name": "issuerId", "value": "", "type": "path", "description": "Issuer ID" }, { "name": "issuerCustomerExternalReference", "value": "", "type": "path", "description": "Issuer Customer External Reference" }, { "name": "addressReference", "value": "", "type": "path", "description": "Address Reference" } ] }, "docs": "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." }, { "info": { "name": "Retrieve customer address versions by customer external reference and address external reference", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/customers/external-customers/:issuerCustomerExternalReference/external-addresses/:issuerAddressExternalReference/address-versions", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "filter", "value": "", "type": "query", "description": "Filtered Fields" }, { "name": "issuerId", "value": "", "type": "path", "description": "Issuer ID" }, { "name": "issuerCustomerExternalReference", "value": "", "type": "path", "description": "Issuer Customer External Reference" }, { "name": "issuerAddressExternalReference", "value": "", "type": "path", "description": "Issuer address external reference" } ] }, "docs": "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." } ] } ], "bundled": true }