{ "opencollection": "1.0.0", "info": { "name": "Worldline Card Issuing Account - AccountState Card Contract API", "version": "2.41.1" }, "items": [ { "info": { "name": "Card Contract", "type": "folder" }, "items": [ { "info": { "name": "List card contracts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/card-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": "cardContractGroupReference", "value": "", "type": "query", "description": "group reference of the Card Contract" }, { "name": "embed", "value": "", "type": "query", "description": "Embedded Fields" } ] }, "docs": "The API allows the list of card contracts to be retrieved which have the same card contract group reference.\nThe main input fields are:\n- The issuer ID\n- The group reference of the card contract for which the detail is requested:\n\nIt is also possible to request some additional data by using the embedded fields.\n\nIn return, the interface provides the generic information (mainly master data) relevant to the card contract." }, { "info": { "name": "Retrieve card contract by external reference", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/card-contracts/external-card-contracts/:issuerCardContractExternalReference", "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": "issuerCardContractExternalReference", "value": "", "type": "path", "description": "Issuer Card Contract External Reference" }, { "name": "embed", "value": "", "type": "query", "description": "Embedded Fields" } ] }, "docs": "The API allows the card contract details to be retrieved. \nThe main input fields are:\n- The issuer ID\n- The card contract for which the detail is requested: It can be provided by using the card contract reference or the issuer card contract external reference. \n\nIt is also possible to request some additional data by using the embedded fields.\n\nIn return, the interface provides the generic information (mainly master data) relevant to the card contract." }, { "info": { "name": "Update card contract by external reference", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/issuers/:issuerId/card-contracts/external-card-contracts/:issuerCardContractExternalReference", "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": "issuerCardContractExternalReference", "value": "", "type": "path", "description": "Issuer Card Contract External Reference" } ] }, "docs": "The API allows a list of pre-defined parameters (attributes) of a card contract to be updated.\nThe main input fields are:\n- The issuer ID\n- The card contract for which updates are required: It can be provided by using the card contract reference or the issuer card contract external reference. \n- Parameters to be updated\n\nThe card contract parameters can be retrieved using the Retrieve card Contract detail API. \nThe updated parameters should be consistent with the initial product configuration de" }, { "info": { "name": "Retrieve cardholder for a card contract by external reference", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/card-contracts/external-card-contracts/:issuerCardContractExternalReference/cardholder", "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": "issuerCardContractExternalReference", "value": "", "type": "path", "description": "Issuer Card Contract External Reference" }, { "name": "embed", "value": "", "type": "query", "description": "Embedded Fields" } ] }, "docs": "The API allows the cardholder data linked to the card contract to be retrieved.\nThe main input fields are:\n- The issuer ID\n- The card contract for which the detail is requested: It can be provided by using the card contract reference or the issuer card contract external reference. \n\nIt is also possible to request some additional data by using the embedded fields.\n\nIn return, the interface provides the generic information of the customer." }, { "info": { "name": "List cards for card contract by external reference", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/card-contracts/external-card-contracts/:issuerCardContractExternalReference/cards", "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": "issuerCardContractExternalReference", "value": "", "type": "path", "description": "Issuer Card Contract External Reference" } ] }, "docs": "The API allows all the cards of a card contract to be retrieved. \nThe main input fields are:\n- The issuer ID\n- The card contract for which the cards list is requested: It can be provided by using the card contract reference or the issuer card contract external reference. \n\nIn return, the interface provides the list of all the cards linked to the card contract. Each card is provided with additional information such as card status, expiry date, embossing line, blocking reason (if in blocked status" }, { "info": { "name": "Close card contract by external reference", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/card-contracts/external-card-contracts/:issuerCardContractExternalReference/close", "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": "issuerCardContractExternalReference", "value": "", "type": "path", "description": "Issuer Card Contract External Reference" } ] }, "docs": "The API allows a card contract to be closed.\nThe main input fields are:\n•\tThe issuer ID\n•\tThe card contract for which the closure is requested: It can be provided by using the card contract reference or the issuer card contract external reference. \n•\tThe parameters of the closure: reason, delay, date.\n\nA card contract can be either closed immediately or in the future (either at the card expiry date or at another scheduled date)." }, { "info": { "name": "Cancel close card contract", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/card-contracts/:cardContractReference/cancel-close", "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": "cardContractReference", "value": "", "type": "path", "description": "Card Contract Reference" } ] }, "docs": "This API enables to cancel a card contract closing with a scheduled date in the future.\n\nAs a result, no closing date is planned anymore for the card contract." }, { "info": { "name": "cancel close card contract by external reference", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/card-contracts/external-card-contracts/:issuerCardContractExternalReference/cancel-close", "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": "issuerCardContractExternalReference", "value": "", "type": "path", "description": "Issuer Card Contract External Reference" } ] }, "docs": "This API enables to cancel a card contract closing with a scheduled date in the future.\n\nAs a result, no closing date is planned anymore for the card contract." }, { "info": { "name": "Retrieve contract for a card contract by external reference", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/card-contracts/external-card-contracts/:issuerCardContractExternalReference/contract", "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": "issuerCardContractExternalReference", "value": "", "type": "path", "description": "Issuer Card Contract External Reference" }, { "name": "embed", "value": "", "type": "query", "description": "Embedded Fields" } ] }, "docs": "The API allows the contract detail of a card contract to be retrieved. \nThe main input fields requested by the API are:\n- The issuer ID\n- The card contract for which the contract information is requested: It can be provided by using the card contract reference or the issuer card contract external reference. \n\nIt is also possible to request some additional data, such as contract customers, accounts, legitimacy documents, by using the embedded fields.\n\nIn return, the interface provides the contrac" }, { "info": { "name": "Retrieve corporate contract for a card contract by external reference", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/card-contracts/external-card-contracts/:issuerCardContractExternalReference/corporate-contract", "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": "issuerCardContractExternalReference", "value": "", "type": "path", "description": "Issuer Card Contract External Reference" }, { "name": "embed", "value": "", "type": "query", "description": "Embedded Fields" } ] }, "docs": "The API allows the corporate contract detail of a card contract to be retrieved. \n\nThe main input fields requested by the API are:\n•\tThe issuer ID\n•\tThe card contract for which the corporate contract information is requested: It can be provided by using the card contract reference or the issuer card contract external reference. \n\nIt is also possible to request some additional data, such as list of corporate contract entities (limited to 100), list of all customers (limited to 100), list of all c" }, { "info": { "name": "Retrieve card contract", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/card-contracts/:cardContractReference", "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": "cardContractReference", "value": "", "type": "path", "description": "Card Contract Reference" }, { "name": "embed", "value": "", "type": "query", "description": "Embedded Fields" } ] }, "docs": "The API allows the card contract details to be retrieved. \nThe main input fields are:\n- The issuer ID\n- The card contract for which the detail is requested: It can be provided by using the card contract reference or the issuer card contract external reference. \n\nIt is also possible to request some additional data by using the embedded fields.\n\nIn return, the interface provides the generic information (mainly master data) relevant to the card contract." }, { "info": { "name": "Update card contract", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/issuers/:issuerId/card-contracts/:cardContractReference", "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": "cardContractReference", "value": "", "type": "path", "description": "Card Contract Reference" } ] }, "docs": "The API allows a list of pre-defined parameters (attributes) of a card contract to be updated.\nThe main input fields are:\n- The issuer ID\n- The card contract for which updates are required: It can be provided by using the card contract reference or the issuer card contract external reference. \n- Parameters to be updated\n\nThe card contract parameters can be retrieved using the Retrieve card Contract detail API. \nThe updated parameters should be consistent with the initial product configuration de" }, { "info": { "name": "Retrieve cardholder for a card contract", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/card-contracts/:cardContractReference/cardholder", "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": "cardContractReference", "value": "", "type": "path", "description": "Card Contract Reference" }, { "name": "embed", "value": "", "type": "query", "description": "Embedded Fields" } ] }, "docs": "The API allows the cardholder data linked to the card contract to be retrieved.\nThe main input fields are:\n- The issuer ID\n- The card contract for which the detail is requested: It can be provided by using the card contract reference or the issuer card contract external reference. \n\nIt is also possible to request some additional data by using the embedded fields.\n\nIn return, the interface provides the generic information of the customer." }, { "info": { "name": "List cards for card contract", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/card-contracts/:cardContractReference/cards", "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": "cardContractReference", "value": "", "type": "path", "description": "Card Contract Reference" } ] }, "docs": "The API allows all the cards of a card contract to be retrieved. \nThe main input fields are:\n- The issuer ID\n- The card contract for which the cards list is requested: It can be provided by using the card contract reference or the issuer card contract external reference. \n\nIn return, the interface provides the list of all the cards linked to the card contract. Each card is provided with additional information such as card status, expiry date, embossing line, blocking reason (if in blocked status" }, { "info": { "name": "Close card contract", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/card-contracts/:cardContractReference/close", "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": "cardContractReference", "value": "", "type": "path", "description": "Card Contract Reference" } ] }, "docs": "The API allows a card contract to be closed.\nThe main input fields are:\n•\tThe issuer ID\n•\tThe card contract for which the closure is requested: It can be provided by using the card contract reference or the issuer card contract external reference. \n•\tThe parameters of the closure: reason, delay, date.\n\nA card contract can be either closed immediately or in the future (either at the card expiry date or at another scheduled date)." }, { "info": { "name": "Retrieve contract for a card contract", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/card-contracts/:cardContractReference/contract", "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": "cardContractReference", "value": "", "type": "path", "description": "Card Contract Reference" }, { "name": "embed", "value": "", "type": "query", "description": "Embedded Fields" } ] }, "docs": "The API allows the contract detail of a card contract to be retrieved. \nThe main input fields requested by the API are:\n- The issuer ID\n- The card contract for which the contract information is requested: It can be provided by using the card contract reference or the issuer card contract external reference. \n\nIt is also possible to request some additional data, such as contract customers, accounts, legitimacy documents, by using the embedded fields.\n\nIn return, the interface provides the contrac" }, { "info": { "name": "Retrieve corporate contract for a card contract", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/card-contracts/:cardContractReference/corporate-contract", "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": "cardContractReference", "value": "", "type": "path", "description": "Card Contract Reference" }, { "name": "embed", "value": "", "type": "query", "description": "Embedded Fields" } ] }, "docs": "The API allows the corporate contract detail of a card contract to be retrieved. \n\nThe main input fields requested by the API are:\n•\tThe issuer ID\n•\tThe card contract for which the corporate contract information is requested: It can be provided by using the card contract reference or the issuer card contract external reference. \n\nIt is also possible to request some additional data, such as list of corporate contract entities (limited to 100), list of all customers (limited to 100), list of all c" } ] } ], "bundled": true }