{ "opencollection": "1.0.0", "info": { "name": "Worldline Card Issuing Account - AccountState Account - Offline Reservation API", "version": "2.41.1" }, "items": [ { "info": { "name": "Account - Offline Reservation", "type": "folder" }, "items": [ { "info": { "name": "List offline reservations for an account (beta)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/accounts/:accountReference/offline-reservations", "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": "Returnes list of active offline reservations for the given account. If True - returnes active and cancelled offline reservations" }, { "name": "periodStartDateTime", "value": "", "type": "query", "description": "Defines the start date and time of the period the reservations are requested. Format - yyyy-MM-ddTHH:mm:ssZ" }, { "name": "periodEndDateTime", "value": "", "type": "query", "description": "Defines the end date and time of the period the reservations are requested. Format - yyyy-MM-ddTHH:mm:ssZ" }, { "name": "page", "value": "", "type": "query", "description": "0" }, { "name": "offset", "value": "", "type": "query", "description": "100" } ] }, "docs": "The API allows the offline reservations of an account to be listed.\nEither only active offline reservations are listed or all" }, { "info": { "name": "Create an offline reservation (beta)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/accounts/:accountReference/offline-reservations", "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 a offline reservation on an account to be created.\nAn offline reservation is used to block funds on the account.\nAn offline reservation is relevant for any account having a credit limit and has an impact on the Open to Buy (decreased).\nAn offline reservation is also relevant for an account having a credit balance. The reserved amount of each call can't be higher than the own funds\nSeveral offline reservations can be created for an account and are considered to maintain (to increas" }, { "info": { "name": "List offline reservations for an account by external reference (beta)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/:issuerId/accounts/external-accounts/:issuerAccountExternalReference/offline-reservations", "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": "Returnes list of active offline reservations for the given account. If True - returnes active and cancelled offline reservations" }, { "name": "periodStartDateTime", "value": "", "type": "query", "description": "Defines the start date and time of the period the reservations are requested. Format - yyyy-MM-ddTHH:mm:ssZ" }, { "name": "periodEndDateTime", "value": "", "type": "query", "description": "Defines the end date and time of the period the reservations are requested. Format - yyyy-MM-ddTHH:mm:ssZ" }, { "name": "page", "value": "", "type": "query", "description": "0" }, { "name": "offset", "value": "", "type": "query", "description": "100" } ] }, "docs": "The API allows the offline reservations of an account to be listed.\nEither only active offline reservations are listed or all" }, { "info": { "name": "Create an offline reservation by external reference (beta)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/accounts/external-accounts/:issuerAccountExternalReference/offline-reservations", "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 a offline reservation on an account to be created.\nAn offline reservation is used to block funds on the account.\nAn offline reservation is relevant for any account having a credit limit and has an impact on the Open to Buy (decreased).\nAn offline reservation is also relevant for an account having a credit balance. The reserved amount of each call can't be higher than the own funds\nSeveral offline reservations can be created for an account and are considered to maintain (to increas" }, { "info": { "name": "Cancel an offline reservation (beta)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/accounts/:accountReference/offline-reservations/:reservationReference/cancel", "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": "reservationReference", "value": "", "type": "path", "description": "Reservation Reference" } ] }, "docs": "The API allows an offline reservation of an account to be cancelled.\nAn offline reservation cancellation has an impact on the Open to Buy (increased) and is considered to maintain (decrease) the total offline reservation of the account.\nThe main input fields are:\n- The issuer ID\n- The offline reservation reference/issuer offline reservation external reference to be cancelled\n- The reason of the cancellation" }, { "info": { "name": "Cancel an offline reservation by reservation external reference (beta)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/accounts/:accountReference/offline-reservations/external-offline-reservations/:issuerReservationExternalReference/cancel", "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": "issuerReservationExternalReference", "value": "", "type": "path", "description": "Issuer Reservation External Reference" } ] }, "docs": "The API allows an offline reservation of an account to be cancelled.\nAn offline reservation cancellation has an impact on the Open to Buy (increased) and is considered to maintain (decrease) the total offline reservation of the account.\nThe main input fields are:\n- The issuer ID\n- The offline reservation reference/issuer offline reservation external reference to be cancelled\n- The reason of the cancellation" }, { "info": { "name": "Cancel an offline reservation by account external reference (beta)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/accounts/external-accounts/:issuerAccountExternalReference/offline-reservations/:reservationReference/cancel", "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": "reservationReference", "value": "", "type": "path", "description": "Reservation Reference" } ] }, "docs": "The API allows an offline reservation of an account to be cancelled.\nAn offline reservation cancellation has an impact on the Open to Buy (increased) and is considered to maintain (decrease) the total offline reservation of the account.\nThe main input fields are:\n- The issuer ID\n- The offline reservation reference/issuer offline reservation external reference to be cancelled\n- The reason of the cancellation" }, { "info": { "name": "Cancel an offline reservation by reservation external reference by account external reference (beta)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/:issuerId/accounts/external-accounts/:issuerAccountExternalReference/offline-reservations/external-offline-reservations/:issuerReservationExternalReference/cancel", "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": "issuerReservationExternalReference", "value": "", "type": "path", "description": "Issuer Reservation External Reference" } ] }, "docs": "The API allows an offline reservation of an account to be cancelled.\nAn offline reservation cancellation has an impact on the Open to Buy (increased) and is considered to maintain (decrease) the total offline reservation of the account.\nThe main input fields are:\n- The issuer ID\n- The offline reservation reference/issuer offline reservation external reference to be cancelled\n- The reason of the cancellation" } ] } ], "bundled": true }