{ "opencollection": "1.0.0", "info": { "name": "Worldline Card Issuing Account - AccountState Corporate Contract API", "version": "2.41.1" }, "items": [ { "info": { "name": "Corporate Contract", "type": "folder" }, "items": [ { "info": { "name": "Retrieve corporate employee Accounts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/corporate-contracts/:contractReference/corporate-employee-accounts/:accountReference", "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": "contractReference", "value": "", "type": "path", "description": "Contract Reference" }, { "name": "accountReference", "value": "", "type": "path", "description": "Account Reference" }, { "name": "embed", "value": "", "type": "query", "description": "Embedded Fields" } ] }, "docs": "This API allows a particular corporate employee account or Virtual Card Account to be retrieved from its reference or its issuer external reference.\n\nThe API response contains corporate employee account information such as:\n- account identifier with the account reference and the issuer external account reference\n- external reference of the employee account\n- parent identifier with the account reference and the issuer external account reference\n- allowed advertisement channels (flags) \n- allowed " }, { "info": { "name": "Update Corporate employee account", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/issuers/:issuerId/corporate-contracts/:contractReference/corporate-employee-accounts/:accountReference", "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": "contractReference", "value": "", "type": "path", "description": "contract Reference" }, { "name": "accountReference", "value": "", "type": "path", "description": "account Reference" } ] }, "docs": "The API allows to update certain data of an existing corporate employee account or Virtual Card Account, such as:\n- the external reference of the employee account\n- the allowed advertisement channels (flags)\n- the allowed delivery channel for possible letters\n- if both membership and account setup fees should be waived during contract lifecycle (can be changed at any moment)\n- if both membership fee and account setup fee are paid by the card account (usually the employee) or the root account (u" }, { "info": { "name": "Retrieve corporate employee accounts by account external reference", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/corporate-contracts/:contractReference/corporate-employee-accounts/external-accounts/:issuerAccountExternalReference", "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": "contractReference", "value": "", "type": "path", "description": "Contract Reference" }, { "name": "issuerAccountExternalReference", "value": "", "type": "path", "description": "Issuer Account External Reference" }, { "name": "embed", "value": "", "type": "query", "description": "Embedded Fields" } ] }, "docs": "This API allows a particular corporate employee account or Virtual Card Account to be retrieved from its reference or its issuer external reference.\n\nThe API response contains corporate employee account information such as:\n- account identifier with the account reference and the issuer external account reference\n- external reference of the employee account\n- parent identifier with the account reference and the issuer external account reference\n- allowed advertisement channels (flags) \n- allowed " }, { "info": { "name": "Update Corporate employee account by account external reference", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/issuers/:issuerId/corporate-contracts/:contractReference/corporate-employee-accounts/external-accounts/:issuerAccountExternalReference", "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": "contractReference", "value": "", "type": "path", "description": "contract Reference" }, { "name": "issuerAccountExternalReference", "value": "", "type": "path", "description": "issuer Account External Reference" } ] }, "docs": "The API allows to update certain data of an existing corporate employee account or Virtual Card Account, such as:\n- the external reference of the employee account\n- the allowed advertisement channels (flags)\n- the allowed delivery channel for possible letters\n- if both membership and account setup fees should be waived during contract lifecycle (can be changed at any moment)\n- if both membership fee and account setup fee are paid by the card account (usually the employee) or the root account (u" }, { "info": { "name": "Retrieve corporate employee Accounts by contract external reference and account external reference", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/corporate-contracts/external-contracts/:issuerContractExternalReference/corporate-employee-accounts/external-accounts/:issuerAccountExternalReference", "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": "issuerContractExternalReference", "value": "", "type": "path", "description": "Issuer Contract External Reference" }, { "name": "issuerAccountExternalReference", "value": "", "type": "path", "description": "Issuer Account External Reference" }, { "name": "embed", "value": "", "type": "query", "description": "Embedded Fields" } ] }, "docs": "This API allows a particular corporate employee account or Virtual Card Account to be retrieved from its reference or its issuer external reference.\n\nThe API response contains corporate employee account information such as:\n- account identifier with the account reference and the issuer external account reference\n- external reference of the employee account\n- parent identifier with the account reference and the issuer external account reference\n- allowed advertisement channels (flags) \n- allowed " }, { "info": { "name": "Update Corporate employee account by contract external reference and account external reference", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/issuers/:issuerId/corporate-contracts/external-contracts/:issuerContractExternalReference/corporate-employee-accounts/external-accounts/:issuerAccountExternalReference", "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": "issuerContractExternalReference", "value": "", "type": "path", "description": "Issuer Contract External Reference" }, { "name": "issuerAccountExternalReference", "value": "", "type": "path", "description": "issuer Account External Reference" } ] }, "docs": "The API allows to update certain data of an existing corporate employee account or Virtual Card Account, such as:\n- the external reference of the employee account\n- the allowed advertisement channels (flags)\n- the allowed delivery channel for possible letters\n- if both membership and account setup fees should be waived during contract lifecycle (can be changed at any moment)\n- if both membership fee and account setup fee are paid by the card account (usually the employee) or the root account (u" }, { "info": { "name": "Retrieve corporate employee Accounts by contract external reference", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/corporate-contracts/external-contracts/:issuerContractExternalReference/corporate-employee-accounts/:accountReference", "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": "issuerContractExternalReference", "value": "", "type": "path", "description": "Issuer Contract External Reference" }, { "name": "accountReference", "value": "", "type": "path", "description": "Account Reference" }, { "name": "embed", "value": "", "type": "query", "description": "Embedded Fields" } ] }, "docs": "This API allows a particular corporate employee account or Virtual Card Account to be retrieved from its reference or its issuer external reference.\n\nThe API response contains corporate employee account information such as:\n- account identifier with the account reference and the issuer external account reference\n- external reference of the employee account\n- parent identifier with the account reference and the issuer external account reference\n- allowed advertisement channels (flags) \n- allowed " }, { "info": { "name": "Update Corporate employee account by contract external reference", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/issuers/:issuerId/corporate-contracts/external-contracts/:issuerContractExternalReference/corporate-employee-accounts/:accountReference", "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": "issuerContractExternalReference", "value": "", "type": "path", "description": "Issuer Contract External Reference" }, { "name": "accountReference", "value": "", "type": "path", "description": "account Reference" } ] }, "docs": "The API allows to update certain data of an existing corporate employee account or Virtual Card Account, such as:\n- the external reference of the employee account\n- the allowed advertisement channels (flags)\n- the allowed delivery channel for possible letters\n- if both membership and account setup fees should be waived during contract lifecycle (can be changed at any moment)\n- if both membership fee and account setup fee are paid by the card account (usually the employee) or the root account (u" }, { "info": { "name": "Retrieve corporate contract", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/corporate-contracts/:contractReference", "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": "contractReference", "value": "", "type": "path", "description": "Contract Reference" }, { "name": "embed", "value": "", "type": "query", "description": "Embedded Fields" } ] }, "docs": "This API allows a particular corporate contract from its reference or its issuer external reference to be retrieved.\n\nThe API response contains corporate contract information such as:\n•\tcontract identifier with the contract reference and the issuer external contract reference if previously provided\n•\tlist of levels in the company organization\n•\tembedded fields if requested such as list of corporate contract entities (limited to 100), list of all customers (limited to 100), list of all companies " }, { "info": { "name": "Modify Corporate contract", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/issuers/:issuerId/corporate-contracts/:contractReference", "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": "contractReference", "value": "", "type": "path", "description": "contract Reference" } ] }, "docs": "The API allows to update certain data of an existing corporate contract such as\n- pass-through data (specificFields)\n- logo reference sent to the embosser (optional, and can be overridden at card level)\n- dispatch code sent to the embosser (optional)\n- if the company should receive a duplicate for statement or not\n- if the Open-to-buy should be reset to the credit limit amount at cycle closure date (credit account only)\n- if both membership fee and account setup fee are paid by the card account " }, { "info": { "name": "Retrieve corporate contract by external reference", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/corporate-contracts/external-contracts/:issuerContractExternalReference", "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": "issuerContractExternalReference", "value": "", "type": "path", "description": "Issuer Contract External Reference" }, { "name": "embed", "value": "", "type": "query", "description": "Embedded Fields" } ] }, "docs": "This API allows a particular corporate contract from its reference or its issuer external reference to be retrieved.\n\nThe API response contains corporate contract information such as:\n•\tcontract identifier with the contract reference and the issuer external contract reference if previously provided\n•\tlist of levels in the company organization\n•\tembedded fields if requested such as list of corporate contract entities (limited to 100), list of all customers (limited to 100), list of all companies " }, { "info": { "name": "Modify Corporate contract by external reference", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/issuers/:issuerId/corporate-contracts/external-contracts/:issuerContractExternalReference", "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": "issuerContractExternalReference", "value": "", "type": "path", "description": "issuer Contract External Reference" } ] }, "docs": "The API allows to update certain data of an existing corporate contract such as\n- pass-through data (specificFields)\n- logo reference sent to the embosser (optional, and can be overridden at card level)\n- dispatch code sent to the embosser (optional)\n- if the company should receive a duplicate for statement or not\n- if the Open-to-buy should be reset to the credit limit amount at cycle closure date (credit account only)\n- if both membership fee and account setup fee are paid by the card account " }, { "info": { "name": "Close Corporate contract", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/corporate-contracts/:contractReference/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": "contractReference", "value": "", "type": "path", "description": "contract Reference" } ] }, "docs": "The API allows to close a corporate contract identified by the Issuer Contract external reference or the Contract reference.\nThe corporate contract can be closed immediately or in the future at a date provided by the issuer.\n\nAs a result,\n- For immediate corporate contract closing: the corporate contract is closed, the cards within the corporate contract are deactivated, the accounts closing process is started for all accounts.\n- For scheduled corporate contract closing (closing in the future): " }, { "info": { "name": "Add an entity to a Corporate contract", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/corporate-contracts/:contractReference/add-corporate-contract-entity", "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": "contractReference", "value": "", "type": "path", "description": "contract Reference" } ] }, "docs": "This API allows an issuer to add a new entity to the company organization such a new country, division or department to an existing corporate contract.\n\nThe issuer shall provide required data to create the new entity such as \n- the product extension to be used among those available for the corporate product used to create the contract\n- entity and account data\n- customer (person) or company information (new ones) or customer references (existing ones in Worldline system)\n\nThe API response return" }, { "info": { "name": "Modify an entity of a Corporate contract - deprecated", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/issuers/:issuerId/corporate-contracts/:contractReference/corporate-contract-entity/:companyEntityExternalReference", "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": "contractReference", "value": "", "type": "path", "description": "contract Reference" }, { "name": "companyEntityExternalReference", "value": "", "type": "path", "description": "company Entity External Reference" } ] }, "docs": "The API allows certain data of an existing entity of a corporate contract to be updated such as\n- the allowed advertisement channels (flags)\n- the allowed delivery channel for possible letters\n\nAs a result the corporate contract entity is immediately updated with provided data in our system." }, { "info": { "name": "Modify an entity of a Corporate contract", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/issuers/:issuerId/corporate-contracts/:contractReference/corporate-contract-entities/:companyEntityExternalReference", "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": "contractReference", "value": "", "type": "path", "description": "contract Reference" }, { "name": "companyEntityExternalReference", "value": "", "type": "path", "description": "company Entity External Reference" } ] }, "docs": "The API allows certain data of an existing entity of a corporate contract to be updated such as\n- the allowed advertisement channels (flags)\n- the allowed delivery channel for possible letters\n\nAs a result the corporate contract entity is immediately updated with provided data in our system." }, { "info": { "name": "modify an entity of a Corporate contract by external reference - deprecated", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/issuers/:issuerId/corporate-contracts/external-contracts/:issuerContractExternalReference/corporate-contract-entity/:companyEntityExternalReference", "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": "issuerContractExternalReference", "value": "", "type": "path", "description": "Issuer Contract External Reference" }, { "name": "companyEntityExternalReference", "value": "", "type": "path", "description": "Company Entity External Reference" } ] }, "docs": "The API allows certain data of an existing entity of a corporate contract to be updated such as\n- the allowed advertisement channels (flags)\n- the allowed delivery channel for possible letters\n\nAs a result the corporate contract entity is immediately updated with provided data in our system." }, { "info": { "name": "modify an entity of a Corporate contract by external reference", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/issuers/:issuerId/corporate-contracts/external-contracts/:issuerContractExternalReference/corporate-contract-entities/:companyEntityExternalReference", "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": "issuerContractExternalReference", "value": "", "type": "path", "description": "Issuer Contract External Reference" }, { "name": "companyEntityExternalReference", "value": "", "type": "path", "description": "Company Entity External Reference" } ] }, "docs": "The API allows certain data of an existing entity of a corporate contract to be updated such as\n- the allowed advertisement channels (flags)\n- the allowed delivery channel for possible letters\n\nAs a result the corporate contract entity is immediately updated with provided data in our system." }, { "info": { "name": "Add an entity to a Corporate contract by external reference", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/corporate-contracts/external-contracts/:issuerContractExternalReference/add-corporate-contract-entity", "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": "issuerContractExternalReference", "value": "", "type": "path", "description": "Issuer Contract External Reference" } ] }, "docs": "This API allows an issuer to add a new entity to the company organization such a new country, division or department to an existing corporate contract.\n\nThe issuer shall provide required data to create the new entity such as \n- the product extension to be used among those available for the corporate product used to create the contract\n- entity and account data\n- customer (person) or company information (new ones) or customer references (existing ones in Worldline system)\n\nThe API response return" }, { "info": { "name": "Add an employee and its card(s) and account(s) to a Corporate contract", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/corporate-contracts/:contractReference/add-corporate-employee-cards-accounts", "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": "contractReference", "value": "", "type": "path", "description": "contract Reference" } ] }, "docs": "This API allows an issuer to add to an existing corporate contract an employee with a new card and a new card account. Different types of card products (e.g. MCI/VISA debit, credit, prepaid) are supported.\n\nThe issuer shall provide the required data\n- employee information (new or existing one)\n- the product extension, with appropriated card and account products among those available for the corporate product used to create the contract\n- required data for card and account\n- the entity of the com" }, { "info": { "name": "Add an employee and its card(s) and account(s) to a Corporate contract by external reference", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/corporate-contracts/external-contracts/:issuerContractExternalReference/add-corporate-employee-cards-accounts", "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": "issuerContractExternalReference", "value": "", "type": "path", "description": "Issuer Contract External Reference" } ] }, "docs": "This API allows an issuer to add to an existing corporate contract an employee with a new card and a new card account. Different types of card products (e.g. MCI/VISA debit, credit, prepaid) are supported.\n\nThe issuer shall provide the required data\n- employee information (new or existing one)\n- the product extension, with appropriated card and account products among those available for the corporate product used to create the contract\n- required data for card and account\n- the entity of the com" }, { "info": { "name": "Add Corporate VCA Service cards and accounts to a corporate contract", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/corporate-contracts/:contractReference/add-virtual-cards-accounts-service", "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": "contractReference", "value": "", "type": "path", "description": "contract Reference" } ] }, "docs": "This endpoint can be used to create Virtual Card Account (VCA). This is a specific service offered by MCI, VISA and Wordline service (VCE). The VCA is not used to pay transactions, instead a token is requested from MCI, VISA, Worldline service (depends on the Issuer), to fund the transactions.\n\nIt is possible to request creation of several VCA Service Cards and Accounts at the same time.\n\nPre Conditions\n- Card Profile related to Virtual Card account should exist\n\nThe Issuer can request adding VC" }, { "info": { "name": "Add Corporate VCA Service cards and accounts to a corporate contract by issuer contract external reference", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/corporate-contracts/external-contracts/:issuerContractExternalReference/add-virtual-cards-accounts-service", "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": "issuerContractExternalReference", "value": "", "type": "path", "description": "Issuer Contract External Reference" } ] }, "docs": "This endpoint can be used to create Virtual Card Account (VCA). This is a specific service offered by MCI, VISA and Wordline service (VCE). The VCA is not used to pay transactions, instead a token is requested from MCI, VISA, Worldline service (depends on the Issuer), to fund the transactions.\n\nIt is possible to request creation of several VCA Service Cards and Accounts at the same time.\n\nPre Conditions\n- Card Profile related to Virtual Card account should exist\n\nThe Issuer can request adding VC" }, { "info": { "name": "Create a Corporate contract", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/corporate-contracts/create-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" } ] }, "docs": "The Create Corporate Contract API allows the creation of a new corporate contract with the company organization (complete or partial structure).\n\nPre-conditions:\nThe request correlation ID, if provided by the issuer, must be unique. In case of re-use of a request correlation ID from an existing corporate contract, the system will return the data from the existing corporate contract (e.g., if the API call returns a \"time-out\" response, the same request correlation ID can be provided to retrieve " }, { "info": { "name": "Close Corporate contract by external reference", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/corporate-contracts/external-contracts/:issuerContractExternalReference/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": "issuerContractExternalReference", "value": "", "type": "path", "description": "Issuer Contract External Reference" } ] }, "docs": "The API allows to close a corporate contract identified by the Issuer Contract external reference or the Contract reference.\nThe corporate contract can be closed immediately or in the future at a date provided by the issuer.\n\nAs a result,\n- For immediate corporate contract closing: the corporate contract is closed, the cards within the corporate contract are deactivated, the accounts closing process is started for all accounts.\n- For scheduled corporate contract closing (closing in the future): " }, { "info": { "name": "Refund fee by contract reference for corporate contract", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/corporate-contracts/:contractReference/refund-fee-on-demand", "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": "contractReference", "value": "", "type": "path", "description": "Contract Reference" } ] }, "docs": "The API is used to trigger an on demand pro rata refund of Account Setup (AS) fee or Membership fee (MS) for the unutilised period. \n\nPre Conditions:\n- In case refund for Account Setup fee is requested then card contract closure date should be less than card contract creation date + 1 year\n- In case refund for Membership fee is requested, then the Membership fee should already be posted \n- Account setup fee refund on demand can be received only once during contract lifecycle\n- Membership fee r" }, { "info": { "name": "List add-on services subscriptions for a corporate contract by external reference", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/corporate-contracts/external-contracts/:issuerContractExternalReference/addon-subscriptions", "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": "issuerContractExternalReference", "value": "", "type": "path", "description": "Issuer Contract External Reference" }, { "name": "accountReference", "value": "", "type": "query", "description": "Account Reference" }, { "name": "issuerAccountExternalReference", "value": "", "type": "query", "description": "Issuer Account External Reference" }, { "name": "cardContractReference", "value": "", "type": "query", "description": "Card Contract Reference" }, { "name": "issuerCardContractExternalReference", "value": "", "type": "query", "description": "Issuer Card Contract External Reference" } ] }, "docs": "The API allows the list of additional service subscriptions (e.g. new letter, travel insurance) for the corporate contract to be retrieved.\nThe main input fields requested by the API are:\n•\tThe issuer ID\n•\tThe corporate contract for which the add-on subscriptions are requested: It can be provided by using the contract reference or the issuer external contract reference\n\nThe API response contains add-on subscription information such as:\n•\tThe reference of the additional service subscription\n•\tThe" }, { "info": { "name": "Subscribe to add-on for a corporate contract by external reference", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/corporate-contracts/external-contracts/:issuerContractExternalReference/addon-subscriptions", "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": "issuerContractExternalReference", "value": "", "type": "path", "description": "Issuer Contract External Reference" } ] }, "docs": "The API allows a cardholder to subscribe to an additional service (e.g. new letter, travel insurance) for the corporate contract during all contract life cycle.\nThe list of allowed additional services are defined on the product (e.g. PORTAL_ACCESS, ALERT, NOTIFICATION).\n\nThe main input fields requested by the API are:\n•\tThe issuer ID\n•\tThe corporate contract for which the add-on subscription is requested: It can be provided by using the contract reference or the issuer external contract referenc" }, { "info": { "name": "List add-on services subscriptions for a corporate contract", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/corporate-contracts/:contractReference/addon-subscriptions", "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": "contractReference", "value": "", "type": "path", "description": "Contract Reference" }, { "name": "accountReference", "value": "", "type": "query", "description": "Account Reference" }, { "name": "issuerAccountExternalReference", "value": "", "type": "query", "description": "Issuer Account External Reference" }, { "name": "cardContractReference", "value": "", "type": "query", "description": "Card Contract Reference" }, { "name": "issuerCardContractExternalReference", "value": "", "type": "query", "description": "Issuer Card Contract External Reference" } ] }, "docs": "The API allows the list of additional service subscriptions (e.g. new letter, travel insurance) for the corporate contract to be retrieved.\nThe main input fields requested by the API are:\n•\tThe issuer ID\n•\tThe corporate contract for which the add-on subscriptions are requested: It can be provided by using the contract reference or the issuer external contract reference\n\nThe API response contains add-on subscription information such as:\n•\tThe reference of the additional service subscription\n•\tThe" }, { "info": { "name": "Subscribe to add-on for a corporate contract", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/corporate-contracts/:contractReference/addon-subscriptions", "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": "contractReference", "value": "", "type": "path", "description": "Contract Reference" } ] }, "docs": "The API allows a cardholder to subscribe to an additional service (e.g. new letter, travel insurance) for the corporate contract during all contract life cycle.\nThe list of allowed additional services are defined on the product (e.g. PORTAL_ACCESS, ALERT, NOTIFICATION).\n\nThe main input fields requested by the API are:\n•\tThe issuer ID\n•\tThe corporate contract for which the add-on subscription is requested: It can be provided by using the contract reference or the issuer external contract referenc" }, { "info": { "name": "Unsubscribe add-on for a corporate contract by external reference", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/corporate-contracts/external-contracts/:issuerContractExternalReference/addon-subscriptions/unsubscribe", "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": "issuerContractExternalReference", "value": "", "type": "path", "description": "Issuer Contract External Reference" } ] }, "docs": "The API allows a cardholder to unsubscribe from an additional service (e.g. new letter, travel insurance) for the corporate contract during all contract life cycle.\n\nThe main input fields requested by the API are:\n•\tThe issuer ID\n•\tThe corporate contract for which the add-on unsubscription is requested: It can be provided by using the contract reference or the issuer external contract reference\n•\tThe identifier of the entity for which the add-on subscription is requested: Either the card contrac" }, { "info": { "name": "Unsubscribe add-on for a corporate contract", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/corporate-contracts/:contractReference/addon-subscriptions/unsubscribe", "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": "contractReference", "value": "", "type": "path", "description": "Contract Reference" } ] }, "docs": "The API allows a cardholder to unsubscribe from an additional service (e.g. new letter, travel insurance) for the corporate contract during all contract life cycle.\n\nThe main input fields requested by the API are:\n•\tThe issuer ID\n•\tThe corporate contract for which the add-on unsubscription is requested: It can be provided by using the contract reference or the issuer external contract reference\n•\tThe identifier of the entity for which the add-on subscription is requested: Either the card contrac" }, { "info": { "name": "Refund Fee By Issuer Contract External Reference For Corporate Contract", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/corporate-contracts/external-contracts/:issuerContractExternalReference/refund-fee-on-demand", "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": "issuerContractExternalReference", "value": "", "type": "path", "description": "Issuer Contract External Reference" } ] }, "docs": "The API is used to trigger an on demand pro rata refund of Account Setup (AS) fee or Membership fee (MS) for the unutilised period. \n\nPre Conditions:\n- In case refund for Account Setup fee is requested then card contract closure date should be less than card contract creation date + 1 year\n- In case refund for Membership fee is requested, then the Membership fee should already be posted \n- Account setup fee refund on demand can be received only once during contract lifecycle\n- Membership fee r" }, { "info": { "name": "Change paying account structure for a corporate contract", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/corporate-contracts/:contractReference/change-paying-account", "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": "contractReference", "value": "", "type": "path", "description": "Contract Reference" } ] }, "docs": "For a certain corporate contract it is possible to change the paying account type for all accounts from paid by the account itself (usually paid by the employees) to paid by the root account (usually paid by the company) or the inverse.\nE.g. all card accounts are paid by employees themselves (each account is paid by itself) within a contract, then it is possible to request to switch to all accounts are paid by the company itself (e.g. root account represents the company and becomes the paying ac" }, { "info": { "name": "Cancel scheduled change of paying account type", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/corporate-contracts/:contractReference/cancel-change-paying-account", "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": "contractReference", "value": "", "type": "path", "description": "Contract Reference" } ] }, "docs": "The API enables to cancel the scheduled change of paying account type, until the scheduled date has not reached yet." }, { "info": { "name": "Cancel scheduled change of paying account type by external reference", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/corporate-contracts/external-contracts/:issuerContractExternalReference/cancel-change-paying-account", "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": "issuerContractExternalReference", "value": "", "type": "path", "description": "Issuer Contract External Reference" } ] }, "docs": "The API enables to cancel the scheduled change of paying account type, until the scheduled date has not reached yet." }, { "info": { "name": "Change paying account structure for a corporate contract by external reference", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/corporate-contracts/external-contracts/:issuerContractExternalReference/change-paying-account", "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": "issuerContractExternalReference", "value": "", "type": "path", "description": "Issuer Contract External Reference" } ] }, "docs": "For a certain corporate contract it is possible to change the paying account type for all accounts from paid by the account itself (usually paid by the employees) to paid by the root account (usually paid by the company) or the inverse.\nE.g. all card accounts are paid by employees themselves (each account is paid by itself) within a contract, then it is possible to request to switch to all accounts are paid by the company itself (e.g. root account represents the company and becomes the paying ac" }, { "info": { "name": "Retrieve contract owner for a corporate contract (beta)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/corporate-contracts/:contractReference/contract-owner", "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": "contractReference", "value": "", "type": "path", "description": "Contract Reference" }, { "name": "embed", "value": "", "type": "query", "description": "Embedded Fields" } ] }, "docs": "This API allows the contract owner for a corporate contract identified by the Issuer Contract external reference or the Contract reference, to be retrieved.\n\nThe API response contains :\n- either customer information if the contract owner is a person\n- or company information if the contract owner is a company." }, { "info": { "name": "Retrieve contract owner for a corporate contract by external reference (beta)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/corporate-contracts/external-contracts/:issuerContractExternalReference/contract-owner", "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": "issuerContractExternalReference", "value": "", "type": "path", "description": "Issuer Contract External Reference" }, { "name": "embed", "value": "", "type": "query", "description": "Embedded Fields" } ] }, "docs": "This API allows the contract owner for a corporate contract identified by the Issuer Contract external reference or the Contract reference, to be retrieved.\n\nThe API response contains :\n- either customer information if the contract owner is a person\n- or company information if the contract owner is a company" }, { "info": { "name": "Reallocate employee", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/corporate-contracts/:contractReference/card-contracts/:cardContractReference/reallocate", "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": "contractReference", "value": "", "type": "path", "description": "Contract Reference" }, { "name": "cardContractReference", "value": "", "type": "path", "description": "Card Contract Reference" } ] }, "docs": "The API can be used to reallocate an employee (i.e., an employee card contract) within the same or different corporate contract(s).\nThis reallocation\n- must be allowed by the configuration (e.g. original employee product shall be in the list of allowed employee products for the new corporate contract)\n- is performed immediately \n\nAs a result, when employee reallocation is performed\n- the employee new account is created under the given parent account (can be within the same or different corporate" }, { "info": { "name": "Reallocate employee by issuer contract external reference", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/corporate-contracts/external-contracts/:issuerContractExternalReference/card-contracts/:cardContractReference/reallocate", "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": "issuerContractExternalReference", "value": "", "type": "path", "description": "Issuer Contract External Reference" }, { "name": "cardContractReference", "value": "", "type": "path", "description": "Card Contract Reference" } ] }, "docs": "The API can be used to reallocate an employee (i.e., an employee card contract) within the same or different corporate contract(s).\nThis reallocation\n- must be allowed by the configuration (e.g. original employee product shall be in the list of allowed employee products for the new corporate contract)\n- is performed immediately \n\nAs a result, when employee reallocation is performed\n- the employee new account is created under the given parent account (can be within the same or different corporate" }, { "info": { "name": "Reallocate employee by issuer card contract external reference", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/corporate-contracts/:contractReference/card-contracts/external-card-contracts/:issuerCardContractExternalReference/reallocate", "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": "contractReference", "value": "", "type": "path", "description": "Contract Reference" }, { "name": "issuerCardContractExternalReference", "value": "", "type": "path", "description": "Issuer Card Contract External Reference" } ] }, "docs": "The API can be used to reallocate an employee (i.e., an employee card contract) within the same or different corporate contract(s).\nThis reallocation\n- must be allowed by the configuration (e.g. original employee product shall be in the list of allowed employee products for the new corporate contract)\n- is performed immediately \n\nAs a result, when employee reallocation is performed\n- the employee new account is created under the given parent account (can be within the same or different corporate" }, { "info": { "name": "Reallocate employee by issuer contract external reference and issuer card contract external reference", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/corporate-contracts/external-contracts/:issuerContractExternalReference/card-contracts/external-card-contracts/:issuerCardContractExternalReference/reallocate", "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": "issuerContractExternalReference", "value": "", "type": "path", "description": "Issuer Contract External Reference" }, { "name": "issuerCardContractExternalReference", "value": "", "type": "path", "description": "Issuer Card Contract External Reference" } ] }, "docs": "The API can be used to reallocate an employee (i.e., an employee card contract) within the same or different corporate contract(s).\nThis reallocation\n- must be allowed by the configuration (e.g. original employee product shall be in the list of allowed employee products for the new corporate contract)\n- is performed immediately \n\nAs a result, when employee reallocation is performed\n- the employee new account is created under the given parent account (can be within the same or different corporate" } ] } ], "bundled": true }