{ "opencollection": "1.0.0", "info": { "name": "Worldline Card Issuing Account - AccountState Card - Letter API", "version": "2.41.1" }, "items": [ { "info": { "name": "Card - Letter", "type": "folder" }, "items": [ { "info": { "name": "Retrieve letter for the card (beta)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/cards/:cardReference/letters/:letterId", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "issuerId", "value": "", "type": "path", "description": "Issuer ID" }, { "name": "letterId", "value": "", "type": "path", "description": "Letter Id" }, { "name": "cardReference", "value": "", "type": "path", "description": "Card Reference" } ] }, "docs": "The API allows to retreive a specific letter for a card.\nThe main input fields are:\n•\tThe issuer ID\n•\tThe card for which the letter is requested: It can be provided by using the card reference or the issuer external card reference\n•\tThe letter reference by providing the letterId\n\nIn return, the interface provides letter information for the requested card. Deleted letters are not returned by this interface." }, { "info": { "name": "Delete a letter for a card (beta)", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/issuers/:issuerId/cards/:cardReference/letters/:letterId", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "issuerId", "value": "", "type": "path", "description": "Issuer ID" }, { "name": "letterId", "value": "", "type": "path", "description": "Letter ID" }, { "name": "cardReference", "value": "", "type": "path", "description": "Card Reference" } ] }, "docs": "The API allows to delete a letter for a card.\nThe main input fields requested by the API are:\n• The issuer ID\n• The card for which the letter deletion is requested: It can be provided by using the card reference or the issuer external card reference\n• The letter reference by providing the letterId\n\nThe following controls will be performed during letter deletion:\n- If a cut off hour is configured the deletion is allowed if the generation and deletion occurs during the same 24 hour period between " }, { "info": { "name": "Retrieve letter for a card by external reference (beta)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/cards/external-cards/:issuerCardExternalReference/letters/:letterId", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "issuerId", "value": "", "type": "path", "description": "Issuer ID" }, { "name": "letterId", "value": "", "type": "path", "description": "Letter Id" }, { "name": "issuerCardExternalReference", "value": "", "type": "path", "description": "Issuer Card External Reference" } ] }, "docs": "The API allows to retreive a specific letter for a card.\nThe main input fields are:\n•\tThe issuer ID\n•\tThe card for which the letter is requested: It can be provided by using the card reference or the issuer external card reference\n•\tThe letter reference by providing the letterId\n\nIn return, the interface provides letter information for the requested card. Deleted letters are not returned by this interface." }, { "info": { "name": "Delete a letter for a card by external reference (beta)", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/issuers/:issuerId/cards/external-cards/:issuerCardExternalReference/letters/:letterId", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "issuerId", "value": "", "type": "path", "description": "Issuer ID" }, { "name": "letterId", "value": "", "type": "path", "description": "Letter ID" }, { "name": "issuerCardExternalReference", "value": "", "type": "path", "description": "Issuer Card External Reference" } ] }, "docs": "The API allows to delete a letter for a card.\nThe main input fields requested by the API are:\n• The issuer ID\n• The card for which the letter deletion is requested: It can be provided by using the card reference or the issuer external card reference\n• The letter reference by providing the letterId\n\nThe following controls will be performed during letter deletion:\n- If a cut off hour is configured the deletion is allowed if the generation and deletion occurs during the same 24 hour period between " }, { "info": { "name": "Validate a letter for a card (beta)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/cards/:cardReference/letters/:letterId/validate", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "issuerId", "value": "", "type": "path", "description": "Issuer Id" }, { "name": "letterId", "value": "", "type": "path", "description": "Letter Id" }, { "name": "cardReference", "value": "", "type": "path", "description": "Card Reference" } ] }, "docs": "The API allows to validate a letter for a card.\nThe validation status of the letter must be VALIDATION_NEEDED.\nThe main input fields requested by the API are:\n• The issuer ID\n• The card for which the letter validation is requested: It can be provided by using the card reference or the issuer external card reference\n• The letter reference by providing the letterId\n\nAs a result, the validation status of the letter is changed to VALIDATED." }, { "info": { "name": "Validate a letter for a card by external reference (beta)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/cards/external-cards/:issuerCardExternalReference/letters/:letterId/validate", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "issuerId", "value": "", "type": "path", "description": "Issuer Id" }, { "name": "letterId", "value": "", "type": "path", "description": "Letter Id" }, { "name": "issuerCardExternalReference", "value": "", "type": "path", "description": "Issuer Card External Reference" } ] }, "docs": "The API allows to validate a letter for a card.\nThe validation status of the letter must be VALIDATION_NEEDED.\nThe main input fields requested by the API are:\n• The issuer ID\n• The card for which the letter validation is requested: It can be provided by using the card reference or the issuer external card reference\n• The letter reference by providing the letterId\n\nAs a result, the validation status of the letter is changed to VALIDATED." }, { "info": { "name": "Generate letter for a card (beta)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/cards/:cardReference/generate-letter", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "issuerId", "value": "", "type": "path", "description": "Issuer Id" }, { "name": "cardReference", "value": "", "type": "path", "description": "Card Reference" } ] }, "docs": "The API allows to generate a letter for a card. \nThe main input fields requested by the API are:\n• The issuer ID\n• The card for which the letter generation is requested: It can be provided by using the card reference or the issuer external card reference\n• The letter template reference which is used to generate the letter\n\nDuring letter generation following controls will be performed:\n- If the template parameter is defined with a validator, the validator will be applied on the provided value.\n- " }, { "info": { "name": "Generate letter for a card by external reference (beta)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/cards/external-cards/:issuerCardExternalReference/generate-letter", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "issuerId", "value": "", "type": "path", "description": "Issuer Id" }, { "name": "issuerCardExternalReference", "value": "", "type": "path", "description": "Issuer Card External Reference" } ] }, "docs": "The API allows to generate a letter for a card. \nThe main input fields requested by the API are:\n• The issuer ID\n• The card for which the letter generation is requested: It can be provided by using the card reference or the issuer external card reference\n• The letter template reference which is used to generate the letter\n\nDuring letter generation following controls will be performed:\n- If the template parameter is defined with a validator, the validator will be applied on the provided value.\n- " }, { "info": { "name": "Get parameters for the defined letter templates (beta)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/cards/:cardReference/prefilled-letter-templates/:letterTemplateReference", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "letterTemplateReference", "value": "", "type": "path", "description": "Letter Template Reference" }, { "name": "issuerId", "value": "", "type": "path", "description": "Issuer Id" }, { "name": "cardReference", "value": "", "type": "path", "description": "Card Reference" } ] }, "docs": "The API allows to retrieve the prefilled parameters of a letter template for a card.\nThe main input fields are:\n•\tThe issuer ID\n•\tThe card for which the template parameters are requested: It can be provided by using the card reference or the issuer external card reference\n•\tThe letter template reference\n\nAs a result, the list of the letter template parameter names with the default values assigned to them, are returned, which can be used to prefill the letter template with default values." }, { "info": { "name": "Get parameters for the defined letter templates by external reference(beta)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/cards/external-cards/:issuerCardExternalReference/prefilled-letter-templates/:letterTemplateReference", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "letterTemplateReference", "value": "", "type": "path", "description": "Letter Template Reference" }, { "name": "issuerId", "value": "", "type": "path", "description": "Issuer Id" }, { "name": "issuerCardExternalReference", "value": "", "type": "path", "description": "Issuer Card External Reference" } ] }, "docs": "The API allows to retrieve the prefilled parameters of a letter template for a card.\nThe main input fields are:\n•\tThe issuer ID\n•\tThe card for which the template parameters are requested: It can be provided by using the card reference or the issuer external card reference\n•\tThe letter template reference\n\nAs a result, the list of the letter template parameter names with the default values assigned to them, are returned, which can be used to prefill the letter template with default values." }, { "info": { "name": "List of available letter templates for cards (beta)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/cards/letter-templates", "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": "Issuer Id" } ] }, "docs": "The API allows to retrieve the list of available letter templates for an Issuer related to the cards.\nThe main input fields are:\n•\tThe issuer ID\n\nIf requested, the API allows also to\trequest to enrich the response with additional data relative to the template parameters by using embedded fields.\n\nIn return, the interface provides the list of available letter templates for the requested issuer with the related parameters if requested." }, { "info": { "name": "Retrieve a specific letter template (beta)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/cards/letter-templates/:letterTemplateReference", "headers": [ { "name": "WL-Correlation-ID", "value": "" }, { "name": "WL-Origin", "value": "" }, { "name": "WL-Username", "value": "" } ], "params": [ { "name": "issuerId", "value": "", "type": "path", "description": "Issuer Id" }, { "name": "embed", "value": "", "type": "query", "description": "Embedded Fields" }, { "name": "letterTemplateReference", "value": "", "type": "path", "description": "Letter Template Reference" } ] }, "docs": "The API allows to retreive a specific letter template by its reference.\nThe main input fields are:\n•\tThe issuer ID\n•\tThe letter template reference for which its details is requested\n\nIf requested, the API allows also to\trequest to enrich the response with additional data relative to the template parameters by using embedded fields.\n\nIn return, the interface provides letter template information with the related parameters if requested." } ] } ], "bundled": true }