{ "opencollection": "1.0.0", "info": { "name": "Worldline Card Issuing Account - AccountState Company - Address API", "version": "2.41.1" }, "items": [ { "info": { "name": "Company - Address", "type": "folder" }, "items": [ { "info": { "name": "Create address for a company customer", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/companies/: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 company, identified with his reference. \nTo identify the company, it is needed to provide:\n- The issuer ID\n- The customer reference or the issuer customer reference (as company)\nAn address includes the following information:\n•\tthe issuer address external reference \n•\tthe label (e.g. HEAD_OFFICE)\n•\tthe type (mail address, phone number, email) and the corresponding data\n•\tthe address usages\n•\tthe start date (optiona" }, { "info": { "name": "Retrieve company's address information by address ref", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/companies/:customerReference/addresses/:addressReference", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "issuerId", "value": "", "type": "path", "description": "issuerId" }, { "name": "customerReference", "value": "", "type": "path", "description": "customerReference" }, { "name": "addressReference", "value": "", "type": "path", "description": "addressReference" }, { "name": "embed", "value": "", "type": "query", "description": "Embedded Fields" }, { "name": "filter", "value": "", "type": "query", "description": "Filtered Fields" } ] }, "docs": "The API returns the current version of a company's address.\nInformation to be provided in input:\n- The issuer ID\n- The customer reference or the issuer customer reference (as company)\n- The address reference or the issuer address reference \nThe address identifiers, address attributes, address usages and entity reference (application domain of the address) are displayed in the response." }, { "info": { "name": "Update company address", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/issuers/:issuerId/companies/: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 updates all the attributes of a company's address.\nTo identify the address of the company for which updates are required, it is needed to provide:\n- The issuer ID\n- The customer reference or the issuer customer reference (as company) \n- The address reference or the issuer address reference\nAll the attributes must be provided even those unchanged (except for the usages).\nThe API allows to validate an address ('invalid' status is set to false). But it's not possible to invalidate an addres" }, { "info": { "name": "Retrieve company's address information by address external reference", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/companies/:customerReference/addresses/external-addresses/:issuerAddressExternalReference", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "issuerId", "value": "", "type": "path", "description": "issuerId" }, { "name": "customerReference", "value": "", "type": "path", "description": "customerReference" }, { "name": "issuerAddressExternalReference", "value": "", "type": "path", "description": "issuerAddressExternalReference" }, { "name": "embed", "value": "", "type": "query", "description": "Embedded Fields" }, { "name": "filter", "value": "", "type": "query", "description": "Filtered Fields" } ] }, "docs": "The API returns the current version of a company's address.\nInformation to be provided in input:\n- The issuer ID\n- The customer reference or the issuer customer reference (as company)\n- The address reference or the issuer address reference \nThe address identifiers, address attributes, address usages and entity reference (application domain of the address) are displayed in the response." }, { "info": { "name": "Update company address by external address reference", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/issuers/:issuerId/companies/: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 updates all the attributes of a company's address.\nTo identify the address of the company for which updates are required, it is needed to provide:\n- The issuer ID\n- The customer reference or the issuer customer reference (as company) \n- The address reference or the issuer address reference\nAll the attributes must be provided even those unchanged (except for the usages).\nThe API allows to validate an address ('invalid' status is set to false). But it's not possible to invalidate an addres" }, { "info": { "name": "Create address for a company by external reference", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/companies/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 company, identified with his reference. \nTo identify the company, it is needed to provide:\n- The issuer ID\n- The customer reference or the issuer customer reference (as company)\nAn address includes the following information:\n•\tthe issuer address external reference \n•\tthe label (e.g. HEAD_OFFICE)\n•\tthe type (mail address, phone number, email) and the corresponding data\n•\tthe address usages\n•\tthe start date (optiona" }, { "info": { "name": "Retrieve address information by company external reference", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/companies/external-customers/:issuerCustomerExternalReference/addresses/:addressReference", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "issuerId", "value": "", "type": "path", "description": "issuerId" }, { "name": "issuerCustomerExternalReference", "value": "", "type": "path", "description": "issuerCustomerExternalReference" }, { "name": "addressReference", "value": "", "type": "path", "description": "addressReference" }, { "name": "embed", "value": "", "type": "query", "description": "Embedded Fields" }, { "name": "filter", "value": "", "type": "query", "description": "Filtered Fields" } ] }, "docs": "The API returns the current version of a company's address.\nInformation to be provided in input:\n- The issuer ID\n- The customer reference or the issuer customer reference (as company)\n- The address reference or the issuer address reference \nThe address identifiers, address attributes, address usages and entity reference (application domain of the address) are displayed in the response." }, { "info": { "name": "Update company address by company external reference", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/issuers/:issuerId/companies/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 updates all the attributes of a company's address.\nTo identify the address of the company for which updates are required, it is needed to provide:\n- The issuer ID\n- The customer reference or the issuer customer reference (as company) \n- The address reference or the issuer address reference\nAll the attributes must be provided even those unchanged (except for the usages).\nThe API allows to validate an address ('invalid' status is set to false). But it's not possible to invalidate an addres" }, { "info": { "name": "Retrieve address information by company external reference and address external reference", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/companies/external-customers/:issuerCustomerExternalReference/addresses/external-addresses/:issuerAddressExternalReference", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "issuerId", "value": "", "type": "path", "description": "issuerId" }, { "name": "issuerCustomerExternalReference", "value": "", "type": "path", "description": "issuerCustomerExternalReference" }, { "name": "issuerAddressExternalReference", "value": "", "type": "path", "description": "issuerAddressExternalReference" }, { "name": "embed", "value": "", "type": "query", "description": "Embedded Fields" }, { "name": "filter", "value": "", "type": "query", "description": "Filtered Fields" } ] }, "docs": "The API returns the current version of a company's address.\nInformation to be provided in input:\n- The issuer ID\n- The customer reference or the issuer customer reference (as company)\n- The address reference or the issuer address reference \nThe address identifiers, address attributes, address usages and entity reference (application domain of the address) are displayed in the response." }, { "info": { "name": "Update company address by company external reference and address external reference", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/issuers/:issuerId/companies/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 updates all the attributes of a company's address.\nTo identify the address of the company for which updates are required, it is needed to provide:\n- The issuer ID\n- The customer reference or the issuer customer reference (as company) \n- The address reference or the issuer address reference\nAll the attributes must be provided even those unchanged (except for the usages).\nThe API allows to validate an address ('invalid' status is set to false). But it's not possible to invalidate an addres" }, { "info": { "name": "Activate address of a company", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/companies/: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": "issuerId" }, { "name": "customerReference", "value": "", "type": "path", "description": "customerReference" }, { "name": "addressReference", "value": "", "type": "path", "description": "addressReference" } ] }, "docs": "The API allows to activate on demand of an address.\nTo activate the address of the company, it is needed to provide:\n- The issuer ID\n- The customer reference or the issuer customer reference (as company) \n- The address reference or the issuer address reference\nIf a temporary address exists, it becomes also active.\nThe address identifiers, address attributes and address usages are displayed in the response." }, { "info": { "name": "Activate address of a company by company external reference", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/companies/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": "issuerId" }, { "name": "issuerCustomerExternalReference", "value": "", "type": "path", "description": "issuerCustomerExternalReference" }, { "name": "addressReference", "value": "", "type": "path", "description": "addressReference" } ] }, "docs": "The API allows to activate on demand of an address.\nTo activate the address of the company, it is needed to provide:\n- The issuer ID\n- The customer reference or the issuer customer reference (as company) \n- The address reference or the issuer address reference\nIf a temporary address exists, it becomes also active.\nThe address identifiers, address attributes and address usages are displayed in the response." }, { "info": { "name": "Activate address of a company by address external reference", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/companies/: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": "issuerId" }, { "name": "customerReference", "value": "", "type": "path", "description": "customerReference" }, { "name": "issuerAddressExternalReference", "value": "", "type": "path", "description": "issuerAddressExternalReference" } ] }, "docs": "The API allows to activate on demand of an address.\nTo activate the address of the company, it is needed to provide:\n- The issuer ID\n- The customer reference or the issuer customer reference (as company) \n- The address reference or the issuer address reference\nIf a temporary address exists, it becomes also active.\nThe address identifiers, address attributes and address usages are displayed in the response." }, { "info": { "name": "Activate address of a company by company external reference and address external reference", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/companies/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": "issuerId" }, { "name": "issuerCustomerExternalReference", "value": "", "type": "path", "description": "issuerCustomerExternalReference" }, { "name": "issuerAddressExternalReference", "value": "", "type": "path", "description": "issuerAddressExternalReference" } ] }, "docs": "The API allows to activate on demand of an address.\nTo activate the address of the company, it is needed to provide:\n- The issuer ID\n- The customer reference or the issuer customer reference (as company) \n- The address reference or the issuer address reference\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 of a company", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/companies/: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": "issuerId" }, { "name": "customerReference", "value": "", "type": "path", "description": "customerReference" }, { "name": "addressReference", "value": "", "type": "path", "description": "addressReference" } ] }, "docs": "The API is used to deactivate the address.\nTo deactivate the address of the company, it is needed to provide:\n- The issuer ID\n- The customer reference or the issuer customer reference (as company) \n- The address reference or the issuer address reference\nThe status becomes \"INACTIVE\".\nThis action is forbidden in case of:\n- the address label is the HEAD_OFFICE\n- an usage is linked to the address." }, { "info": { "name": "Deactivate address of a company by company external reference", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/companies/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": "issuerId" }, { "name": "issuerCustomerExternalReference", "value": "", "type": "path", "description": "issuerCustomerExternalReference" }, { "name": "addressReference", "value": "", "type": "path", "description": "addressReference" } ] }, "docs": "The API is used to deactivate the address.\nTo deactivate the address of the company, it is needed to provide:\n- The issuer ID\n- The customer reference or the issuer customer reference (as company) \n- The address reference or the issuer address reference\nThe status becomes \"INACTIVE\".\nThis action is forbidden in case of:\n- the address label is the HEAD_OFFICE\n- an usage is linked to the address." }, { "info": { "name": "Deactivate address of a company by address external reference", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/companies/: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": "issuerId" }, { "name": "customerReference", "value": "", "type": "path", "description": "customerReference" }, { "name": "issuerAddressExternalReference", "value": "", "type": "path", "description": "issuerAddressExternalReference" } ] }, "docs": "The API is used to deactivate the address.\nTo deactivate the address of the company, it is needed to provide:\n- The issuer ID\n- The customer reference or the issuer customer reference (as company) \n- The address reference or the issuer address reference\nThe status becomes \"INACTIVE\".\nThis action is forbidden in case of:\n- the address label is the HEAD_OFFICE\n- an usage is linked to the address." }, { "info": { "name": "Deactivate address of a company by company external reference and address external reference", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/companies/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": "issuerId" }, { "name": "issuerCustomerExternalReference", "value": "", "type": "path", "description": "issuerCustomerExternalReference" }, { "name": "issuerAddressExternalReference", "value": "", "type": "path", "description": "issuerAddressExternalReference" } ] }, "docs": "The API is used to deactivate the address.\nTo deactivate the address of the company, it is needed to provide:\n- The issuer ID\n- The customer reference or the issuer customer reference (as company) \n- The address reference or the issuer address reference\nThe status becomes \"INACTIVE\".\nThis action is forbidden in case of:\n- the address label is the HEAD_OFFICE\n- an usage is linked to the address." }, { "info": { "name": "Create an address usage for a company", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/companies/: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, card delivery, ...). The 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" }, { "info": { "name": "Remove an address usage of a company", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/issuers/:issuerId/companies/: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.\nTo identify the address of the company, it is needed to provide:\n- The issuer ID\n- The customer reference or the issuer customer reference (as company) \n- The address reference or the issuer address reference. \nThe 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 def" }, { "info": { "name": "Create an address usage for a company by company external reference", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/companies/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, card delivery, ...). The 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" }, { "info": { "name": "Remove an address usage of a company by company external reference", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/issuers/:issuerId/companies/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.\nTo identify the address of the company, it is needed to provide:\n- The issuer ID\n- The customer reference or the issuer customer reference (as company) \n- The address reference or the issuer address reference. \nThe 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 def" }, { "info": { "name": "Create an address usage for a company by address external reference", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/companies/: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, card delivery, ...). The 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" }, { "info": { "name": "Remove an address usage of a company by address external reference", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/issuers/:issuerId/companies/: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.\nTo identify the address of the company, it is needed to provide:\n- The issuer ID\n- The customer reference or the issuer customer reference (as company) \n- The address reference or the issuer address reference. \nThe 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 def" }, { "info": { "name": "Create an address usage for a company by company external reference and address external reference", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/companies/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, card delivery, ...). The 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" }, { "info": { "name": "Remove an address usage of a company by company external reference and address external reference", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/issuers/:issuerId/companies/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.\nTo identify the address of the company, it is needed to provide:\n- The issuer ID\n- The customer reference or the issuer customer reference (as company) \n- The address reference or the issuer address reference. \nThe address usages are filtered by the request params :\n- addressUsageName (for definition see the ressource addressUsage), mandatory \n- entityReference (for definition see the resource addressUsage), optional\n- serviceCode (for de" } ] } ], "bundled": true }