{ "opencollection": "1.0.0", "info": { "name": "Worldline Card Issuing Account - AccountState Account - Insurance Contract API", "version": "2.41.1" }, "items": [ { "info": { "name": "Account - Insurance Contract", "type": "folder" }, "items": [ { "info": { "name": "List insurance contracts for an account by external reference", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/accounts/external-accounts/:issuerAccountExternalReference/insurance-contracts", "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": "issuerAccountExternalReference", "value": "", "type": "path", "description": "Issuer Account External Reference" } ] }, "docs": "The API allows the list of insurance contracts for an account to be retrieved. \nThe main input fields requested by the API are:\n- The issuer ID\n- The account for which info is requested: It can be provided by using the account reference or the issuer external account reference.\n\nIn return, the list of insurance contracts is provided with the subscribed insurance package, the insurance events, the latest occurring events and the status for each contract.\nThe list of insurance events and their cod" }, { "info": { "name": "Create insurance contract by external reference", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/accounts/external-accounts/:issuerAccountExternalReference/insurance-contracts", "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": "issuerAccountExternalReference", "value": "", "type": "path", "description": "Issuer Account External Reference" } ] }, "docs": "The API allows an insurance contract for an account to be activated if the activation was not requested at the contract creation.\nThe main input fields requested by the API are:\n- The issuer ID\n- The account for which info is requested: It can be provided by using the account reference or the issuer external account reference\n- The insurance package reference\n- The insurance event code for activation if the activation by default is not defined in the product setup.\n\nIdempotency is managed by the" }, { "info": { "name": "Retrieve an insurance contract for an account by external reference", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/accounts/external-accounts/:issuerAccountExternalReference/insurance-contracts/:insurancePackageReference", "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": "issuerAccountExternalReference", "value": "", "type": "path", "description": "Issuer Account External Reference" }, { "name": "insurancePackageReference", "value": "", "type": "path", "description": "Insurance package reference" }, { "name": "embed", "value": "", "type": "query", "description": "Embedded Fields" } ] }, "docs": "The API allows an insurance contract for an account to be retrieved.\nThe main input fields requested by the API are:\n- The issuer ID\n- The account for which info is requested: It can be provided by using the account reference or the issuer external account reference\n- The insurance package reference.\n\nIn return, the insured events and the latest occurring events for the account and insurance package reference are returned.\nThe list of insurance events and their codes are a pre-defined and config" }, { "info": { "name": "Close insurance contract by external reference", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/issuers/:issuerId/accounts/external-accounts/:issuerAccountExternalReference/insurance-contracts/:insurancePackageReference", "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": "issuerAccountExternalReference", "value": "", "type": "path", "description": "Issuer Account External Reference" }, { "name": "insurancePackageReference", "value": "", "type": "path", "description": "Insurance package reference" } ] }, "docs": "The API allows an insurance contract for an account to be closed.\nThe main input fields requested by the API are:\n- The issuer ID\n- The account for which info is requested: It can be provided by using the account reference or the issuer external account reference\n- The insurance package identifier" }, { "info": { "name": "Add an insurance event to insurance contract for an account by external reference", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/accounts/external-accounts/:issuerAccountExternalReference/insurance-contracts/:insurancePackageReference/insurance-events", "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": "issuerAccountExternalReference", "value": "", "type": "path", "description": "Issuer Account External Reference" }, { "name": "insurancePackageReference", "value": "", "type": "path", "description": "Insurance package reference" } ] }, "docs": "The API is used to pst some events to an insurance contract. \nThe complete list of event is defined in the product setup. The actions linked to the event can be:\n- activate insurance,\n- deactivate insurance\n- stop the fee calculation.\n\nThe main input fields requested by the API are:\n- The issuer ID\n- The account for which info is requested: It can be provided by using the account reference or the issuer external account reference\n- The insurance package identifier.\n\nIdempotency is managed by the" }, { "info": { "name": "List insurance contracts for an account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/accounts/:accountReference/insurance-contracts", "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": "accountReference", "value": "", "type": "path", "description": "Account Reference" } ] }, "docs": "The API allows the list of insurance contracts for an account to be retrieved. \nThe main input fields requested by the API are:\n- The issuer ID\n- The account for which info is requested: It can be provided by using the account reference or the issuer external account reference.\n\nIn return, the list of insurance contracts is provided with the subscribed insurance package, the insurance events, the latest occurring events and the status for each contract.\nThe list of insurance events and their cod" }, { "info": { "name": "Create insurance contract", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/accounts/:accountReference/insurance-contracts", "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": "accountReference", "value": "", "type": "path", "description": "Account Reference" } ] }, "docs": "The API allows an insurance contract for an account to be activated if the activation was not requested at the contract creation.\nThe main input fields requested by the API are:\n- The issuer ID\n- The account for which info is requested: It can be provided by using the account reference or the issuer external account reference\n- The insurance package reference\n- The insurance event code for activation if the activation by default is not defined in the product setup.\n\nIdempotency is managed by the" }, { "info": { "name": "Retrieve an insurance contract for an account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/accounts/:accountReference/insurance-contracts/:insurancePackageReference", "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": "accountReference", "value": "", "type": "path", "description": "Account Reference" }, { "name": "insurancePackageReference", "value": "", "type": "path", "description": "Insurance package reference" }, { "name": "embed", "value": "", "type": "query", "description": "Embedded Fields" } ] }, "docs": "The API allows an insurance contract for an account to be retrieved.\nThe main input fields requested by the API are:\n- The issuer ID\n- The account for which info is requested: It can be provided by using the account reference or the issuer external account reference\n- The insurance package reference.\n\nIn return, the insured events and the latest occurring events for the account and insurance package reference are returned.\nThe list of insurance events and their codes are a pre-defined and config" }, { "info": { "name": "Close insurance contract", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/issuers/:issuerId/accounts/:accountReference/insurance-contracts/:insurancePackageReference", "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": "accountReference", "value": "", "type": "path", "description": "Account Reference" }, { "name": "insurancePackageReference", "value": "", "type": "path", "description": "Insurance package reference" } ] }, "docs": "The API allows an insurance contract for an account to be closed.\nThe main input fields requested by the API are:\n- The issuer ID\n- The account for which info is requested: It can be provided by using the account reference or the issuer external account reference\n- The insurance package identifier" }, { "info": { "name": "Add an insurance event to insurance contract for an account", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/accounts/:accountReference/insurance-contracts/:insurancePackageReference/insurance-events", "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": "accountReference", "value": "", "type": "path", "description": "Account Reference" }, { "name": "insurancePackageReference", "value": "", "type": "path", "description": "Insurance package reference" } ] }, "docs": "The API is used to pst some events to an insurance contract. \nThe complete list of event is defined in the product setup. The actions linked to the event can be:\n- activate insurance,\n- deactivate insurance\n- stop the fee calculation.\n\nThe main input fields requested by the API are:\n- The issuer ID\n- The account for which info is requested: It can be provided by using the account reference or the issuer external account reference\n- The insurance package identifier.\n\nIdempotency is managed by the" } ] } ], "bundled": true }