{
"opencollection": "1.0.0",
"info": {
"name": "Worldline Card Issuing - AccountState Account API",
"version": "2.41.1"
},
"items": [
{
"info": {
"name": "Account",
"type": "folder"
},
"items": [
{
"info": {
"name": "Retrieve account by external reference",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/issuers/:issuerId/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": "issuerAccountExternalReference",
"value": "",
"type": "path",
"description": "Issuer Account External Reference"
},
{
"name": "embed",
"value": "",
"type": "query",
"description": "Embedded Fields"
}
]
},
"docs": "The \"retrieve account\" API allows the account details to be retrieved.\nThe main input fields are:\n- The issuer ID\n- The account for which the detail is requested: It can be provided by using the account reference or the issuer external account reference \n\nIt is also possible to request some additional data by using the embedded fields.\n\nIn return, the interface provides generic account information (mainly master data). For credit cards, payment mode, the due amount calculation is provided back."
},
{
"info": {
"name": "Update account parameters by external reference",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{{baseUrl}}/issuers/:issuerId/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": "issuerAccountExternalReference",
"value": "",
"type": "path",
"description": "Issuer Account External Reference"
}
]
},
"docs": "The \"update account parameters\" API allows the list of pre-defined parameters (attributes) of an account to be updated.\nThe main input fields requested by the API are:\n- The issuer ID\n- The account for which updates are required: It can be provided by using the account reference or the issuer external account reference\n- Parameters to be updated\n\nThe account information can be initially retrieved by using the retrieve Account API.\nThe updated parameters should be consistent with the initial prod"
},
{
"info": {
"name": "Retrieve account guarantor for an account by external reference",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/issuers/:issuerId/accounts/external-accounts/:issuerAccountExternalReference/account-guarantor",
"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": "embed",
"value": "",
"type": "query",
"description": "Embedded Fields"
}
]
},
"docs": "The API allows information on the account guarantor to be retrieved.\nThe main input fields are:\n- The issuer ID\n- The account for which information is requested.\n\nIt is also possible to request additional data like addresses by using the embedded fields.\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 list of historic updates of an account by external reference",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/issuers/:issuerId/accounts/external-accounts/:issuerAccountExternalReference/account-history",
"headers": [
{
"name": "WL-Correlation-ID",
"value": ""
},
{
"name": "WL-Origin",
"value": ""
},
{
"name": "WL-Username",
"value": ""
}
],
"params": [
{
"name": "filter",
"value": "",
"type": "query",
"description": "Filtered Fields"
},
{
"name": "issuerId",
"value": "",
"type": "path",
"description": "Issuer ID"
},
{
"name": "issuerAccountExternalReference",
"value": "",
"type": "path",
"description": "Issuer Account External Reference"
},
{
"name": "periodStartDateTime",
"value": "",
"type": "query",
"description": "Format : yyyy-MM-ddTHH:mm:ssZ"
},
{
"name": "periodEndDateTime",
"value": "",
"type": "query",
"description": "Format : yyyy-MM-ddTHH:mm:ssZ"
}
]
},
"docs": "The API allows the account update history of an account to be retrieved.\nThe main input fields requested by the API are:\n•\tThe issuer ID\n•\tThe account for which information is requested : It can be provided by using the account reference or the issuer account external reference.\nA start date and an end date can be provided in order to limit the search of the history.\nIn response, the interface provides a list of changes with the effective date of the update."
},
{
"info": {
"name": "Retrieve account owner for an account by external reference",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/issuers/:issuerId/accounts/external-accounts/:issuerAccountExternalReference/account-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": "issuerAccountExternalReference",
"value": "",
"type": "path",
"description": "Issuer Account External Reference"
},
{
"name": "embed",
"value": "",
"type": "query",
"description": "Embedded Fields"
}
]
},
"docs": "The API allows information on the account owner to be retrieved.\nThe main input fields are:\n- The issuer ID\n- The account for which information is requested.\n\nIt is also possible to request additional data like addresses by using the embedded fields.\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 financial information by external reference",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/issuers/:issuerId/accounts/external-accounts/:issuerAccountExternalReference/balance",
"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 financial information of an account to be retrieved (not relevant for a debit card).\nThe main input fields requested by the API are:\n•\tThe issuer ID\n•\tThe account for which information is requested.\nIn response, different information is returned, such as account balance, sum of all operations (scheme operations, fees, ect) posted to the account (accepted amount), current open to buy amount (credit and prepaid accounts only)."
},
{
"info": {
"name": "Retrieve contract for an account by external reference",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/issuers/:issuerId/accounts/external-accounts/:issuerAccountExternalReference/contract",
"headers": [
{
"name": "WL-Correlation-ID",
"value": ""
},
{
"name": "WL-Origin",
"value": ""
},
{
"name": "WL-Username",
"value": ""
}
],
"params": [
{
"name": "relatedResourceIdentifiersOnly",
"value": "",
"type": "query",
"description": "If relatedResourceIdentifiersOnly is true, the API returns only identifiers related to the embedded resources (for example, if embedded fields cardContracts.cards are requested and relatedResourceIdentifiersOnly is true, only cardContractIdentifier in CardContract and cardIdentifier in Card will be returned). \nIf relatedResourceIdentifiersOnly is false, the API returns all resource information (for example, if embedded fields cardContracts.cards are requested and relatedResourceIdentifiersOnly is false, all information in CardContract and all information in Card will be returned).\nBy default, relatedResourceIdentifiersOnly is false."
},
{
"name": "relatedResourceBaseInfoOnly",
"value": "",
"type": "query",
"description": "relatedResourceBaseInfoOnly (cannot be used with relatedResourceIdentifiersOnly):
If relatedResourceBaseInfoOnly is true, the API returns only main information related to the embedded resources (for example, if embedded fields accounts and cardContracts are requested and relatedResourceBaseInfoOnly is true, only main information of Account and Card Contract will be returned).
The main information is as follows :
- For Account: accountIdentifier, root, status, accountOwnerIdentifier and accountGuarantorIdentifier
- For Card Contract: cardContractIdentifier, cardHolderIdentifier and status
- For Card: cardIdentifier, pan, maskedPan, expiryDate, panSequenceNumber, status, externalStatus, panReference and blockingReason
- For Customer: customerIdentifier, courtesyTitle, firstName and lastName
If relatedResourceBaseInfoOnly is false, the API returns all resource information (for example, if embedded fields accounts and cardContracts are requested and relatedResourceBaseInfoOnly is false, all information in Account and all information in CardContract will be returned).
By default, relatedResourceBaseInfoOnly is false."
},
{
"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": "embed",
"value": "",
"type": "query",
"description": "Embedded Fields"
}
]
},
"docs": "The API enables the consumer contract data for a given account to be retrieved.\nThe main input fields are:\n•\tThe issuer ID\n•\tThe account for which information is requested.\n\nIt is also possible:\n- to request additional data like accounts, cardContracts by using the embedded fields.\n- to return only identifiers related to the embedded resources"
},
{
"info": {
"name": "Retrieve corporate contract for an account by external reference (beta)",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/issuers/:issuerId/accounts/external-accounts/:issuerAccountExternalReference/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": "issuerAccountExternalReference",
"value": "",
"type": "path",
"description": "Issuer Account External Reference"
},
{
"name": "embed",
"value": "",
"type": "query",
"description": "Embedded Fields"
}
]
},
"docs": "The API allows the corporate contract detail of an account to be retrieved. \n\nThe main input fields requested by the API are:\n•\tThe issuer ID\n•\tThe account for which the corporate contract information is requested: It can be provided by using the account reference or the issuer account 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 companies (limited to 10"
},
{
"info": {
"name": "Retrieve account credit limit by external reference",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/issuers/:issuerId/accounts/external-accounts/:issuerAccountExternalReference/credit-limit",
"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 permanent credit limit for a given account to be retrieved."
},
{
"info": {
"name": "Update account credit limit by external reference",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/issuers/:issuerId/accounts/external-accounts/:issuerAccountExternalReference/credit-limit",
"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 permanent credit limit for a given account to be updated."
},
{
"info": {
"name": "List outgoing credit transfers for an account by external reference",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/issuers/:issuerId/accounts/external-accounts/:issuerAccountExternalReference/credit-transfers",
"headers": [
{
"name": "WL-Correlation-ID",
"value": ""
},
{
"name": "WL-Origin",
"value": ""
},
{
"name": "WL-Username",
"value": ""
}
],
"params": [
{
"name": "filter",
"value": "",
"type": "query",
"description": "Filtered Fields"
},
{
"name": "reimbursementTriggers",
"value": "",
"type": "query",
"description": "reimbursementTriggers - Parameter to filter reimbursement operations\nAvailable values : ON_DEMAND, CYCLIC (related to monthly cycle closure), DAILY, ON_TRANSACTION, ON_TERMINATION (on contract termination)"
},
{
"name": "periodStartDateTime",
"value": "",
"type": "query",
"description": "Period start date of credit transfers to include (format : yyyy-MM-ddTHH:mm:ssZ)"
},
{
"name": "periodEndDateTime",
"value": "",
"type": "query",
"description": "Period end date credit transfers to include (format : yyyy-MM-ddTHH:mm:ssZ)"
},
{
"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 credit transfers posted for an account to be retrieved.\nThis API applies to the credit cards domain.\nA credit transfer can be posted to an account to pay the due amount (for eg, self-payer).\nThe input parameters are:\n- The issuer ID \n- The involved account: it can be provided by using the account reference or the issuer external account reference,\n- Optionally the search period (start date / end date),\n\nIt is also possible to filter the reimbursement operations (on dem"
},
{
"info": {
"name": "List direct debits for an account by external reference",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/issuers/:issuerId/accounts/external-accounts/:issuerAccountExternalReference/direct-debits",
"headers": [
{
"name": "WL-Correlation-ID",
"value": ""
},
{
"name": "WL-Origin",
"value": ""
},
{
"name": "WL-Username",
"value": ""
}
],
"params": [
{
"name": "filter",
"value": "",
"type": "query",
"description": "Filtered Fields"
},
{
"name": "paymentTriggers",
"value": "",
"type": "query",
"description": "paymentTriggers - Parameter to filter payment operations\nAvailable values : ON_DEMAND, CYCLIC (related to monthly cycle closure), ON_TRANSACTION"
},
{
"name": "periodStartDateTime",
"value": "",
"type": "query",
"description": "Period start date of direct debit to include (format : yyyy-MM-ddTHH:mm:ssZ)"
},
{
"name": "periodEndDateTime",
"value": "",
"type": "query",
"description": "Period end date direct debit to include (format : yyyy-MM-ddTHH:mm:ssZ)"
},
{
"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 sepa and non sepa direct debit notes generated from an account to repay its due amount to be retrieved.\nThis API applies to the credit cards domain.\nThis API applies to the credit cards domain.\nThe input parameters are:\n- The issuer ID\n- The involved account: it can be provided by using the account reference or the issuer external account reference,\n- Optionally the search period (start date / end date),\n\nIt is also possible to filter the payment operations (on demand,"
},
{
"info": {
"name": "Cancel account delinquency by external reference",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/issuers/:issuerId/accounts/external-accounts/:issuerAccountExternalReference/cancel-delinquency",
"headers": [
{
"name": "WL-Correlation-ID",
"value": ""
},
{
"name": "WL-Origin",
"value": ""
},
{
"name": "WL-Username",
"value": ""
}
],
"params": [
{
"name": "issuerAccountExternalReference",
"value": "",
"type": "path",
"description": "issuerAccountExternalReference"
},
{
"name": "issuerId",
"value": "",
"type": "path",
"description": "issuerId"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "Filtered Fields"
}
]
},
"docs": "An account is in delinquency situation (the required minimum payment is overdue)\nThe API allows the delinquency situation of an account to be cancelled.\nAs an input, the account identifier is provided by using:\n•\tthe account reference generated by WL\n•\tor the issuer external account reference\nOptionally, the required overdue minimum payment can be cancelled. \nAs a result :\n•\tthe account is no more in delinquency situation\n•\tthe amount due (required overdue minimum payment) is cancelled if this h"
},
{
"info": {
"name": "Retrieve turnover information for an account by external reference (beta)",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/issuers/:issuerId/accounts/external-accounts/:issuerAccountExternalReference/turnover-information",
"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 returns current and historical turnover information of an account (for a monthly or annual turnover)."
},
{
"info": {
"name": "Retrieve list of turnover for an account by external reference",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/issuers/:issuerId/accounts/external-accounts/:issuerAccountExternalReference/turnovers",
"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": "turnoverType",
"value": "",
"type": "query",
"description": "turnoverType : DEFAULT, MEMBERSHIP_FEE. If the parameter is not provided, all turnovers are returned (if available)"
}
]
},
"docs": "This API returns a list of turnovers with the possibility to return only one type of turnover by providing the turnoverType as query parameter .\nFor each type of turnover, current turnover and historical data are returned.\nThe possible turnovers are : \n•\tthe turnover related to membership fee management (turnoverType=MEMBERSHIP_FEE). \nThis turnover :\n- is optional (depends on product configuration)\n- can be used for membership fee reimbursement (if any)\n- is calculated for a period based on the "
},
{
"info": {
"name": "List temporary credit limits for an account by external reference",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/issuers/:issuerId/accounts/external-accounts/:issuerAccountExternalReference/temporary-credit-limits",
"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": "all",
"value": "",
"type": "query",
"description": "By default return only active temporary Credit Limits"
}
]
},
"docs": "The API allows the temporary credit limits for a given account to be retrieved.\nIt is possible to request either only the active temporary credit limit or the history of temporary limits for the account."
},
{
"info": {
"name": "Create mandate by external reference",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/issuers/:issuerId/accounts/external-accounts/:issuerAccountExternalReference/create-mandate",
"headers": [
{
"name": "WL-Correlation-ID",
"value": ""
},
{
"name": "WL-Origin",
"value": ""
},
{
"name": "WL-Username",
"value": ""
}
],
"params": [
{
"name": "issuerAccountExternalReference",
"value": "",
"type": "path",
"description": "issuerAccountExternalReference"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "Filtered Fields"
},
{
"name": "issuerId",
"value": "",
"type": "path",
"description": "issuerId"
}
]
},
"docs": "The API allows to create a SEPA mandate for the given account by using issuer account external reference or the account reference (generated by WL). \n- For SEPA mandate successful creation in mandate management system, the Iban, Iban owner name and mandate signature date are to be provided. As a result, mandate is created in \"Active\" status and is ready to be used.\n- It is also possible to attach an existing SEPA mandate (explicitly created in mandate management system in advance) to a given acc"
},
{
"info": {
"name": "Cancel mandate by external reference",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/issuers/:issuerId/accounts/external-accounts/:issuerAccountExternalReference/cancel-mandate",
"headers": [
{
"name": "WL-Correlation-ID",
"value": ""
},
{
"name": "WL-Origin",
"value": ""
},
{
"name": "WL-Username",
"value": ""
}
],
"params": [
{
"name": "issuerAccountExternalReference",
"value": "",
"type": "path",
"description": "issuerAccountExternalReference"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "Filtered Fields"
},
{
"name": "issuerId",
"value": "",
"type": "path",
"description": "issuerId"
}
]
},
"docs": "The API allows to cancel SEPA mandate for the given account by using issuer account external reference or the account reference (generated by WL). \nThe SEPA mandate can be cancelled immediately or in the future at a date provided by the issuer.\n- For immediate cancellation, mandate is “Revoked” immediately in mandate management system.\n- For scheduled cancellation, mandate is not “Revoked” until the cancellation date is reached in mandate management system."
},
{
"info": {
"name": "Retrieve account",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/issuers/:issuerId/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": "accountReference",
"value": "",
"type": "path",
"description": "Account Reference"
},
{
"name": "embed",
"value": "",
"type": "query",
"description": "Embedded Fields"
}
]
},
"docs": "The \"retrieve account\" API allows the account details to be retrieved.\nThe main input fields are:\n- The issuer ID\n- The account for which the detail is requested: It can be provided by using the account reference or the issuer external account reference \n\nIt is also possible to request some additional data by using the embedded fields.\n\nIn return, the interface provides generic account information (mainly master data). For credit cards, payment mode, the due amount calculation is provided back."
},
{
"info": {
"name": "Update account parameters",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{{baseUrl}}/issuers/:issuerId/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": "accountReference",
"value": "",
"type": "path",
"description": "Account Reference"
}
]
},
"docs": "The \"update account parameters\" API allows the list of pre-defined parameters (attributes) of an account to be updated.\nThe main input fields requested by the API are:\n- The issuer ID\n- The account for which updates are required: It can be provided by using the account reference or the issuer external account reference\n- Parameters to be updated\n\nThe account information can be initially retrieved by using the retrieve Account API.\nThe updated parameters should be consistent with the initial prod"
},
{
"info": {
"name": "Retrieve account guarantor for an account",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/issuers/:issuerId/accounts/:accountReference/account-guarantor",
"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": "embed",
"value": "",
"type": "query",
"description": "Embedded Fields"
}
]
},
"docs": "The API allows information on the account guarantor to be retrieved.\nThe main input fields are:\n- The issuer ID\n- The account for which information is requested.\n\nIt is also possible to request additional data like addresses by using the embedded fields.\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 list of historic updates of an account",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/issuers/:issuerId/accounts/:accountReference/account-history",
"headers": [
{
"name": "WL-Correlation-ID",
"value": ""
},
{
"name": "WL-Origin",
"value": ""
},
{
"name": "WL-Username",
"value": ""
}
],
"params": [
{
"name": "filter",
"value": "",
"type": "query",
"description": "Filtered Fields"
},
{
"name": "issuerId",
"value": "",
"type": "path",
"description": "Issuer ID"
},
{
"name": "accountReference",
"value": "",
"type": "path",
"description": "Account Reference"
},
{
"name": "periodStartDateTime",
"value": "",
"type": "query",
"description": "Format : yyyy-MM-ddTHH:mm:ssZ"
},
{
"name": "periodEndDateTime",
"value": "",
"type": "query",
"description": "Format : yyyy-MM-ddTHH:mm:ssZ"
}
]
},
"docs": "The API allows the account update history of an account to be retrieved.\nThe main input fields requested by the API are:\n•\tThe issuer ID\n•\tThe account for which information is requested : It can be provided by using the account reference or the issuer account external reference.\nA start date and an end date can be provided in order to limit the search of the history.\nIn response, the interface provides a list of changes with the effective date of the update."
},
{
"info": {
"name": "Retrieve account owner for an account",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/issuers/:issuerId/accounts/:accountReference/account-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": "accountReference",
"value": "",
"type": "path",
"description": "Account Reference"
},
{
"name": "embed",
"value": "",
"type": "query",
"description": "Embedded Fields"
}
]
},
"docs": "The API allows information on the account owner to be retrieved.\nThe main input fields are:\n- The issuer ID\n- The account for which information is requested.\n\nIt is also possible to request additional data like addresses by using the embedded fields.\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": "Cancel account delinquency",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/issuers/:issuerId/accounts/:accountReference/cancel-delinquency",
"headers": [
{
"name": "WL-Correlation-ID",
"value": ""
},
{
"name": "WL-Origin",
"value": ""
},
{
"name": "WL-Username",
"value": ""
}
],
"params": [
{
"name": "accountReference",
"value": "",
"type": "path",
"description": "accountReference"
},
{
"name": "issuerId",
"value": "",
"type": "path",
"description": "issuerId"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "Filtered Fields"
}
]
},
"docs": "An account is in delinquency situation (the required minimum payment is overdue)\nThe API allows the delinquency situation of an account to be cancelled.\nAs an input, the account identifier is provided by using:\n•\tthe account reference generated by WL\n•\tor the issuer external account reference\nOptionally, the required overdue minimum payment can be cancelled. \nAs a result :\n•\tthe account is no more in delinquency situation\n•\tthe amount due (required overdue minimum payment) is cancelled if this h"
},
{
"info": {
"name": "Retrieve turnover information for an account (beta)",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/issuers/:issuerId/accounts/:accountReference/turnover-information",
"headers": [
{
"name": "WL-Correlation-ID",
"value": ""
},
{
"name": "WL-Origin",
"value": ""
},
{
"name": "WL-Username",
"value": ""
}
],
"params": [
{
"name": "filter",
"value": "",
"type": "query",
"description": "Filtered Fields"
},
{
"name": "accountReference",
"value": "",
"type": "path",
"description": "accountReference"
},
{
"name": "issuerId",
"value": "",
"type": "path",
"description": "Issuer ID"
}
]
},
"docs": "The API returns current and historical turnover information of an account (for a monthly or annual turnover)."
},
{
"info": {
"name": "Retrieve list of turnover for an account",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/issuers/:issuerId/accounts/:accountReference/turnovers",
"headers": [
{
"name": "WL-Correlation-ID",
"value": ""
},
{
"name": "WL-Origin",
"value": ""
},
{
"name": "WL-Username",
"value": ""
}
],
"params": [
{
"name": "filter",
"value": "",
"type": "query",
"description": "Filtered Fields"
},
{
"name": "accountReference",
"value": "",
"type": "path",
"description": "accountReference"
},
{
"name": "issuerId",
"value": "",
"type": "path",
"description": "Issuer ID"
},
{
"name": "turnoverType",
"value": "",
"type": "query",
"description": "turnoverType : DEFAULT, MEMBERSHIP_FEE. If the parameter is not provided, all turnovers are returned (if available)"
}
]
},
"docs": "This API returns a list of turnovers with the possibility to return only one type of turnover by providing the turnoverType as query parameter .\nFor each type of turnover, current turnover and historical data are returned.\nThe possible turnovers are : \n•\tthe turnover related to membership fee management (turnoverType=MEMBERSHIP_FEE). \nThis turnover :\n- is optional (depends on product configuration)\n- can be used for membership fee reimbursement (if any)\n- is calculated for a period based on the "
},
{
"info": {
"name": "Retrieve financial information",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/issuers/:issuerId/accounts/:accountReference/balance",
"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 financial information of an account to be retrieved (not relevant for a debit card).\nThe main input fields requested by the API are:\n•\tThe issuer ID\n•\tThe account for which information is requested.\nIn response, different information is returned, such as account balance, sum of all operations (scheme operations, fees, ect) posted to the account (accepted amount), current open to buy amount (credit and prepaid accounts only)."
},
{
"info": {
"name": "Retrieve contract for an account",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/issuers/:issuerId/accounts/:accountReference/contract",
"headers": [
{
"name": "WL-Correlation-ID",
"value": ""
},
{
"name": "WL-Origin",
"value": ""
},
{
"name": "WL-Username",
"value": ""
}
],
"params": [
{
"name": "relatedResourceIdentifiersOnly",
"value": "",
"type": "query",
"description": "If relatedResourceIdentifiersOnly is true, the API returns only identifiers related to the embedded resources (for example, if embedded fields cardContracts.cards are requested and relatedResourceIdentifiersOnly is true, only cardContractIdentifier in CardContract and cardIdentifier in Card will be returned). \nIf relatedResourceIdentifiersOnly is false, the API returns all resource information (for example, if embedded fields cardContracts.cards are requested and relatedResourceIdentifiersOnly is false, all information in CardContract and all information in Card will be returned).\nBy default, relatedResourceIdentifiersOnly is false."
},
{
"name": "relatedResourceBaseInfoOnly",
"value": "",
"type": "query",
"description": "relatedResourceBaseInfoOnly (cannot be used with relatedResourceIdentifiersOnly):
If relatedResourceBaseInfoOnly is true, the API returns only main information related to the embedded resources (for example, if embedded fields accounts and cardContracts are requested and relatedResourceBaseInfoOnly is true, only main information of Account and Card Contract will be returned).
The main information is as follows :
- For Account: accountIdentifier, root, status, accountOwnerIdentifier and accountGuarantorIdentifier
- For Card Contract: cardContractIdentifier, cardHolderIdentifier and status
- For Card: cardIdentifier, pan, maskedPan, expiryDate, panSequenceNumber, status, externalStatus, panReference and blockingReason
- For Customer: customerIdentifier, courtesyTitle, firstName and lastName
If relatedResourceBaseInfoOnly is false, the API returns all resource information (for example, if embedded fields accounts and cardContracts are requested and relatedResourceBaseInfoOnly is false, all information in Account and all information in CardContract will be returned).
By default, relatedResourceBaseInfoOnly is false."
},
{
"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": "embed",
"value": "",
"type": "query",
"description": "Embedded Fields"
}
]
},
"docs": "The API enables the consumer contract data for a given account to be retrieved.\nThe main input fields are:\n•\tThe issuer ID\n•\tThe account for which information is requested.\n\nIt is also possible:\n- to request additional data like accounts, cardContracts by using the embedded fields.\n- to return only identifiers related to the embedded resources"
},
{
"info": {
"name": "Retrieve corporate contract for an account (beta)",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/issuers/:issuerId/accounts/:accountReference/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": "accountReference",
"value": "",
"type": "path",
"description": "Account Reference"
},
{
"name": "embed",
"value": "",
"type": "query",
"description": "Embedded Fields"
}
]
},
"docs": "The API allows the corporate contract detail of an account to be retrieved. \n\nThe main input fields requested by the API are:\n•\tThe issuer ID\n•\tThe account for which the corporate contract information is requested: It can be provided by using the account reference or the issuer account 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 companies (limited to 10"
},
{
"info": {
"name": "Retrieve account credit limit",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/issuers/:issuerId/accounts/:accountReference/credit-limit",
"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 permanent credit limit for a given account to be retrieved."
},
{
"info": {
"name": "Update account credit limit",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/issuers/:issuerId/accounts/:accountReference/credit-limit",
"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 permanent credit limit for a given account to be updated."
},
{
"info": {
"name": "List outgoing credit transfers for an account",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/issuers/:issuerId/accounts/:accountReference/credit-transfers",
"headers": [
{
"name": "WL-Correlation-ID",
"value": ""
},
{
"name": "WL-Origin",
"value": ""
},
{
"name": "WL-Username",
"value": ""
}
],
"params": [
{
"name": "filter",
"value": "",
"type": "query",
"description": "Filtered Fields"
},
{
"name": "reimbursementTriggers",
"value": "",
"type": "query",
"description": "reimbursementTriggers - Parameter to filter reimbursement operations\nAvailable values : ON_DEMAND, CYCLIC (related to monthly cycle closure), DAILY, ON_TRANSACTION, ON_TERMINATION (on contract termination)"
},
{
"name": "periodStartDateTime",
"value": "",
"type": "query",
"description": "Period start date of credit transfers to include (format : yyyy-MM-ddTHH:mm:ssZ)"
},
{
"name": "periodEndDateTime",
"value": "",
"type": "query",
"description": "Period end date credit transfers to include (format : yyyy-MM-ddTHH:mm:ssZ)"
},
{
"name": "issuerId",
"value": "",
"type": "path",
"description": "Issuer ID"
},
{
"name": "accountReference",
"value": "",
"type": "path",
"description": "Account Reference"
}
]
},
"docs": "The API allows the list of credit transfers posted for an account to be retrieved.\nThis API applies to the credit cards domain.\nA credit transfer can be posted to an account to pay the due amount (for eg, self-payer).\nThe input parameters are:\n- The issuer ID \n- The involved account: it can be provided by using the account reference or the issuer external account reference,\n- Optionally the search period (start date / end date),\n\nIt is also possible to filter the reimbursement operations (on dem"
},
{
"info": {
"name": "List direct debits for an account",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/issuers/:issuerId/accounts/:accountReference/direct-debits",
"headers": [
{
"name": "WL-Correlation-ID",
"value": ""
},
{
"name": "WL-Origin",
"value": ""
},
{
"name": "WL-Username",
"value": ""
}
],
"params": [
{
"name": "filter",
"value": "",
"type": "query",
"description": "Filtered Fields"
},
{
"name": "paymentTriggers",
"value": "",
"type": "query",
"description": "paymentTriggers - Parameter to filter payment operations\nAvailable values : ON_DEMAND, CYCLIC (related to monthly cycle closure), ON_TRANSACTION"
},
{
"name": "periodStartDateTime",
"value": "",
"type": "query",
"description": "Period start date of direct debit to include (format : yyyy-MM-ddTHH:mm:ssZ)"
},
{
"name": "periodEndDateTime",
"value": "",
"type": "query",
"description": "Period end date direct debit to include (format : yyyy-MM-ddTHH:mm:ssZ)"
},
{
"name": "issuerId",
"value": "",
"type": "path",
"description": "Issuer ID"
},
{
"name": "accountReference",
"value": "",
"type": "path",
"description": "Account Reference"
}
]
},
"docs": "The API allows the list of sepa and non sepa direct debit notes generated from an account to repay its due amount to be retrieved.\nThis API applies to the credit cards domain.\nThe input parameters are:\n- The issuer ID\n- The involved account: it can be provided by using the account reference or the issuer external account reference,\n- Optionally the search period (start date / end date),\n\nIt is also possible to filter the payment operations (on demand, cyclic or on transaction)."
},
{
"info": {
"name": "List temporary credit limits for an account",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/issuers/:issuerId/accounts/:accountReference/temporary-credit-limits",
"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": "all",
"value": "",
"type": "query",
"description": "By default return only active temporary Credit Limits"
}
]
},
"docs": "The API allows the temporary credit limits for a given account to be retrieved.\nIt is possible to request either only the active temporary credit limit or the history of temporary limits for the account."
},
{
"info": {
"name": "Create mandate",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/issuers/:issuerId/accounts/:accountReference/create-mandate",
"headers": [
{
"name": "WL-Correlation-ID",
"value": ""
},
{
"name": "WL-Origin",
"value": ""
},
{
"name": "WL-Username",
"value": ""
}
],
"params": [
{
"name": "accountReference",
"value": "",
"type": "path",
"description": "accountReference"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "Filtered Fields"
},
{
"name": "issuerId",
"value": "",
"type": "path",
"description": "issuerId"
}
]
},
"docs": "The API allows to create a SEPA mandate for the given account by using issuer account external reference or the account reference (generated by WL). \n- For SEPA mandate successful creation in mandate management system, the Iban, Iban owner name and mandate signature date are to be provided. As a result, mandate is created in \"Active\" status and is ready to be used.\n- It is also possible to attach an existing SEPA mandate (explicitly created in mandate management system in advance) to a given acc"
},
{
"info": {
"name": "Cancel mandate",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/issuers/:issuerId/accounts/:accountReference/cancel-mandate",
"headers": [
{
"name": "WL-Correlation-ID",
"value": ""
},
{
"name": "WL-Origin",
"value": ""
},
{
"name": "WL-Username",
"value": ""
}
],
"params": [
{
"name": "accountReference",
"value": "",
"type": "path",
"description": "accountReference"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "Filtered Fields"
},
{
"name": "issuerId",
"value": "",
"type": "path",
"description": "issuerId"
}
]
},
"docs": "The API allows to cancel SEPA mandate for the given account by using issuer account external reference or the account reference (generated by WL). \nThe SEPA mandate can be cancelled immediately or in the future at a date provided by the issuer.\n- For immediate cancellation, mandate is “Revoked” immediately in mandate management system.\n- For scheduled cancellation, mandate is not “Revoked” until the cancellation date is reached in mandate management system."
}
]
}
],
"bundled": true
}