{ "opencollection": "1.0.0", "info": { "name": "Worldline Card Issuing Account - AccountState Company API", "version": "2.41.1" }, "items": [ { "info": { "name": "Company", "type": "folder" }, "items": [ { "info": { "name": "Retrieve company's information", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/companies/:customerReference", "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": "embed", "value": "", "type": "query", "description": "Embedded Fields" } ] }, "docs": "The \"retrieve company's information\" API allows the user to get company information.\nInformation to be provided in input:\n- The issuer ID\n- The customer reference or the issuer customer reference (as company)\nIn addition to the company information, it is also possible to request the list of addresses and contacts of the company." }, { "info": { "name": "Update company", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/issuers/:issuerId/companies/:customerReference", "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 \"update company\" API allows the user to update the attributes of a customer (as company).\nTo identify the company, it is needed to provide:\n- The issuer ID\n- The customer reference or the issuer customer reference (as company) for which updates are required\nThe customer reference can be retrieved by using the \"Retrieve list of company's information\" API.\nAll the attributes must be given in input even if they remain unchanged. For that, It can be needed to use the \"retrieve company's informat" }, { "info": { "name": "Update company partially", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/issuers/:issuerId/companies/:customerReference", "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 \"update company partially\" API allows the user to update the attributes of a customer (as company).\nTo identify the company, it is needed to provide:\n- The issuer ID\n- The customer reference or the issuer customer reference (as company) for which updates are required\nThe customer reference can be retrieved by using the \"Retrieve list of company's information\" API.\nWith this API, only attributes that need to be updated must be given in input." }, { "info": { "name": "Retrieve list of historic updates of a company (beta)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/companies/:customerReference/company-history", "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": "periodStartDateTime", "value": "", "type": "query", "description": "Format : yyyy-MM-ddTHH:mm:ssZ" }, { "name": "periodEndDateTime", "value": "", "type": "query", "description": "Format : yyyy-MM-ddTHH:mm:ssZ" } ] }, "docs": "The API allows the company update history of a company to be retrieved. \nThe main input fields requested by the API are:\n•\tThe issuer ID\n•\tThe customer for which information is requested : It can be provided by using the customer reference or the issuer customer external reference (as company). \nA start date and an end date can be provided in order to limit the search of the history. \nIn response, the interface provides a list of changes with the effective date of the update." }, { "info": { "name": "Retrieve company information by external reference", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/companies/external-customers/:issuerCustomerExternalReference", "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": "embed", "value": "", "type": "query", "description": "Embedded Fields" } ] }, "docs": "The \"retrieve company's information\" API allows the user to get company information.\nInformation to be provided in input:\n- The issuer ID\n- The customer reference or the issuer customer reference (as company)\nIn addition to the company information, it is also possible to request the list of addresses and contacts of the company." }, { "info": { "name": "Update Company by external reference", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/issuers/:issuerId/companies/external-customers/:issuerCustomerExternalReference", "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 \"update company\" API allows the user to update the attributes of a customer (as company).\nTo identify the company, it is needed to provide:\n- The issuer ID\n- The customer reference or the issuer customer reference (as company) for which updates are required\nThe customer reference can be retrieved by using the \"Retrieve list of company's information\" API.\nAll the attributes must be given in input even if they remain unchanged. For that, It can be needed to use the \"retrieve company's informat" }, { "info": { "name": "Update Company partially by external reference", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/issuers/:issuerId/companies/external-customers/:issuerCustomerExternalReference", "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 \"update company partially\" API allows the user to update the attributes of a customer (as company).\nTo identify the company, it is needed to provide:\n- The issuer ID\n- The customer reference or the issuer customer reference (as company) for which updates are required\nThe customer reference can be retrieved by using the \"Retrieve list of company's information\" API.\nWith this API, only attributes that need to be updated must be given in input." }, { "info": { "name": "Retrieve list of historic updates of a company by customer external reference (beta)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/companies/external-customers/:issuerCustomerExternalReference/company-history", "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": "periodStartDateTime", "value": "", "type": "query", "description": "Format : yyyy-MM-ddTHH:mm:ssZ" }, { "name": "periodEndDateTime", "value": "", "type": "query", "description": "Format : yyyy-MM-ddTHH:mm:ssZ" } ] }, "docs": "The API allows the company update history of a company to be retrieved. \nThe main input fields requested by the API are:\n•\tThe issuer ID\n•\tThe customer for which information is requested : It can be provided by using the customer reference or the issuer customer external reference (as company). \nA start date and an end date can be provided in order to limit the search of the history. \nIn response, the interface provides a list of changes with the effective date of the update." }, { "info": { "name": "Retrieve list of company's information", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/companies", "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": "corporateName", "value": "", "type": "query", "description": "Name of the company" }, { "name": "nationalFiscalIdentifier", "value": "", "type": "query", "description": "national fiscal identifier of the company" }, { "name": "postalAddress.postCode", "value": "", "type": "query", "description": "Post code of the company's address" }, { "name": "postalAddress.townName", "value": "", "type": "query", "description": "Town name of the company's address" }, { "name": "buildingNumber", "value": "", "type": "query", "description": "Building number of the company" }, { "name": "streetName", "value": "", "type": "query", "description": "Street name of the company" }, { "name": "page", "value": "", "type": "query", "description": "0" }, { "name": "offset", "value": "", "type": "query", "description": "100" } ] }, "docs": "The \"Retrieve list of company's information\" API enables to get a list of customers based on multiple criteria such as corporateName, nationalFiscalNumber, address town name, address postal code.\nAll companies whose corporate name includes the 'corporate name' parameter are returned (e.g. 'zon' => 'amazon' + 'zon craft', ...)" }, { "info": { "name": "Create company", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/companies", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "embed", "value": "", "type": "query", "description": "Embedded Fields" }, { "name": "issuerId", "value": "", "type": "path", "description": "issuerId" } ] }, "docs": "The API creates a company if all the mandatory fields are provided (see company's resource).\nBy default, the company is considered 'ACTIVE' if the Status field is not provided.\nThe default address of the company must be also configured.\nThe API returns a customer reference (as company).\nThe response can also be enriched (if specified as embedded fields in input) with additional data such as company information, address identifiers linked to the company, addresses of the company, contacts of the " }, { "info": { "name": "Retrieve company's Address information list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/companies/:customerReference/addresses", "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": "filter", "value": "", "type": "query", "description": "Filtered Fields" }, { "name": "serviceCode", "value": "", "type": "query", "description": "The Service for which the address usage is defined : CARD_SERVICE, ACCOUNT_SERVICE. Conditional (must be used with addressUsageName)" }, { "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." }, { "name": "showHistory", "value": "", "type": "query", "description": "If the showHistory indicator is set to 'true' then the full history of the addresses are returned. If this indicator is empty (default behavior) or equals to 'false', then only the last active addresses are returned. " }, { "name": "embed", "value": "", "type": "query", "description": "Embedded Fields" } ] }, "docs": "This API enables all the addresses associated with a given customer (as company), identified by customer reference or issuer customer reference to be retrieved. \nTo identify the company, it is needed to provide:\n- The issuer ID\n- The customer reference or the issuer customer reference (as company)\nThe address could be either a permanent address or a temporary address.\nSeveral address types are managed. Each address can be used for a specific usage (card delivery, statement delivery, contract let" }, { "info": { "name": "Retrieve company's Address information list by external reference", "type": "http" }, "http": { "method": "GET", "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": "issuerId", "value": "", "type": "path", "description": "issuerId" }, { "name": "issuerCustomerExternalReference", "value": "", "type": "path", "description": "issuerCustomerExternalReference" }, { "name": "filter", "value": "", "type": "query", "description": "Filtered Fields" }, { "name": "serviceCode", "value": "", "type": "query", "description": "The Service for which the address usage is defined : CARD_SERVICE, ACCOUNT_SERVICE. Conditional (must be used with addressUsageName)" }, { "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." }, { "name": "showHistory", "value": "", "type": "query", "description": "If the showHistory indicator is set to 'true' then the full history of the addresses are returned. If this indicator is empty (default behavior) or equals to 'false', then only the last active addresses are returned. " }, { "name": "embed", "value": "", "type": "query", "description": "Embedded Fields" } ] }, "docs": "This API enables all the addresses associated with a given customer (as company), identified by customer reference or issuer customer reference to be retrieved. \nTo identify the company, it is needed to provide:\n- The issuer ID\n- The customer reference or the issuer customer reference (as company)\nThe address could be either a permanent address or a temporary address.\nSeveral address types are managed. Each address can be used for a specific usage (card delivery, statement delivery, contract let" }, { "info": { "name": "Create Contact", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/companies/:customerReference/contacts", "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 creates a contact person belonging to the company by providing information such as first name, name, department to which he is attached.\nTo create a contact, it is needed to provide:\n- The issuer ID\n- The customer reference or the issuer customer reference (as company).\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." }, { "info": { "name": "Create Contact by external reference", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/companies/external-customers/:issuerCustomerExternalReference/contacts", "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 creates a contact person belonging to the company by providing information such as first name, name, department to which he is attached.\nTo create a contact, it is needed to provide:\n- The issuer ID\n- The customer reference or the issuer customer reference (as company).\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." }, { "info": { "name": "Modify Contact", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/issuers/:issuerId/companies/:customerReference/contacts/:contactReference", "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": "contactReference", "value": "", "type": "path", "description": "Contact Reference" } ] }, "docs": "The API allows information of a contact of the company to be modified. \nTo update a contact, it is needed to provide:\n- The issuer ID\n- The customer reference or the issuer customer reference (as company) \n- The contact reference\nAll attributes must be provided (even if some of them have not been modified) else the value of missing attributes will be empty." }, { "info": { "name": "Remove Contact by customer reference and contact reference", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/issuers/:issuerId/companies/:customerReference/contacts/:contactReference", "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": "contactReference", "value": "", "type": "path", "description": "Contact Reference" } ] }, "docs": "The API allows a contact of the company to be deleted.\nTo remove a contact, it is needed to provide:\n- The issuer ID\n- The customer reference or the issuer customer reference (as company) \n- The contact reference" }, { "info": { "name": "Modify Contact by external reference", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/issuers/:issuerId/companies/external-customers/:issuerCustomerExternalReference/contacts/:contactReference", "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": "contactReference", "value": "", "type": "path", "description": "Contact Reference" } ] }, "docs": "The API allows information of a contact of the company to be modified. \nTo update a contact, it is needed to provide:\n- The issuer ID\n- The customer reference or the issuer customer reference (as company) \n- The contact reference\nAll attributes must be provided (even if some of them have not been modified) else the value of missing attributes will be empty." }, { "info": { "name": "Remove Contact by external reference", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/issuers/:issuerId/companies/external-customers/:issuerCustomerExternalReference/contacts/:contactReference", "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": "contactReference", "value": "", "type": "path", "description": "Contact Reference" } ] }, "docs": "The API allows a contact of the company to be deleted.\nTo remove a contact, it is needed to provide:\n- The issuer ID\n- The customer reference or the issuer customer reference (as company) \n- The contact reference" } ] } ], "bundled": true }