{"items":[{"type":"link","label":"Statement","link":"/products/statements/v1/openapi","routeSlug":"/products/statements/v1/openapi","content":{"contentType":"overview","meta":{"name":"Statement"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/access/_bundle/products/statements/@v1/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/access/_bundle/products/statements/@v1/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"payload","title":"Payload","lang":"Payload"},{"key":"curl","title":"curl","lang":"curl"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"go","title":"Go","lang":"Go"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"csharp","title":"C#","lang":"C#"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://try.access.worldpay-bsh.securedataplatform.co.uk","description":"Test (Try)"},{"url":"https://access.worldpay-bsh.securedataplatform.co.uk","description":"Live"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Statement (1)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve your account statement and see individual entries for all credits and debits. Specify a date range and other optional filter values."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"__"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication header"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"  Authorization: {your_credentials}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"  Authorization: {your_credentials}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replace "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{your_credentials}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with your base64-encoded Basic Auth username and password given to you by your Worldpay Implementation Manager."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"must"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for any request you send to our Account APIs."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"__"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accept header"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"  Accept: application/vnd.worldpay.accounts.statements-v1+json\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"  Accept: application/vnd.worldpay.accounts.statements-v1+json\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We use the Accept header to identify which version of our API you are using. You must use the Accept header for any request you send to our Account APIs."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"__"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DNS whitelisting"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whitelist the following URLs:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://try.access.worldpay-bsh.securedataplatform.co.uk/"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://access.worldpay-bsh.securedataplatform.co.uk/"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please ensure you use DNS whitelisting, not explicit IP whitelisting. When you make a request within Access Worldpay, you should always cache the response returned."},"children":[]}]}]}]}],"sectionId":"/products/statements/v1/openapi"}],"sectionId":"/products/statements/v1/openapi"}]}]}},{"label":"Query account statement items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/statements/v1/openapi/other/getaccountstatement","routeSlug":"/products/statements/v1/openapi/other/getaccountstatement","metadata":{"seo":{"title":"Query account statement items","description":"Retrieve statement entries for an account number using the filter criteria."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAccountStatement","name":"Query account statement items","isWebhook":false,"pointer":"/paths/~1accounts~1statements/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query account statement items","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve statement entries for an account number using the filter criteria."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"accountNumber","in":"query","schemaId":"schema_463","description":"The account number.","required":true,"example":"0005553123712133"},{"name":"startDate","in":"query","schemaId":"schema_464","description":"An ISO 8601 date-time string. From date and time. Timespan between 'startDate' and 'endDate' shouldn't exceed 31 days. This should not be a date in the future.","required":true},{"name":"endDate","in":"query","schemaId":"schema_465","description":"An ISO 8601 date-time string. To date and time. Timespan between 'startDate' and 'endDate' shouldn't exceed 31 days. This should not be a date in the future.","required":true},{"name":"pageNumber","in":"query","schemaId":"schema_466","description":"The page number of the results. Default is 1 if no value is provided. This value specifies the exact page of each list of statements that you want to retrieve."},{"name":"pageSize","in":"query","schemaId":"schema_467","description":"Exact number of records per page to be shown. Max 500 items/rows. Value must be between 1-500. Default is 1 if no value is provided."},{"name":"fundingType","in":"query","schemaId":"schema_468","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit or debit operation. Value can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"credit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"debit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If no value is passed, the statement includes both credits and debits."},"children":[]}]}]}]},{"name":"transferType","in":"query","schemaId":"schema_469","description":"Type of the transaction used to filter out statement entries. Alphanumeric only. Special characters are restricted."},{"name":"countryCode","in":"query","schemaId":"schema_470","description":"ISO country code of the transaction."},{"name":"amount","in":"query","schemaId":"schema_471","description":"The transaction amount."},{"name":"transactionReference","in":"query","schemaId":"schema_472","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your unique reference for the payment request. This can be a \"like\" search (exact or partial match). Special characters are allowed. For the list, please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/reference/formatting#-transactionreference-format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"formatting guide"},"children":[]}]}]}]}]}],"pointer":"/paths/~1accounts~1statements/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_473","required":true},{"name":"WP-CorrelationId","in":"header","schemaId":"schema_474","description":"Optional ID to trace requests, if not provided, it is generated.","example":"15cd16b2-7b82-41cb-9b11-21be9dacad88"}],"pointer":"/paths/~1accounts~1statements/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/accounts/statements","servers":[{"url":"https://try.access.worldpay-bsh.securedataplatform.co.uk","description":"Test (Try)"},{"url":"https://access.worldpay-bsh.securedataplatform.co.uk","description":"Live"}],"parameters":{"path":[],"query":[{"name":"accountNumber","in":"query","required":true,"example":"0005553123712133","schemaId":"schema_463"},{"name":"startDate","in":"query","required":true,"example":"2022-05-01T15:16:30Z","schemaId":"schema_464"},{"name":"endDate","in":"query","required":true,"example":"2022-05-05T15:16:30Z","schemaId":"schema_465"},{"name":"pageNumber","in":"query","required":false,"schemaId":"schema_466"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_467"},{"name":"fundingType","in":"query","required":false,"schemaId":"schema_468"},{"name":"transferType","in":"query","required":false,"schemaId":"components/schemas/AlphanumericRestricted"},{"name":"countryCode","in":"query","required":false,"schemaId":"components/schemas/CountryCode"},{"name":"amount","in":"query","required":false,"schemaId":"schema_471"},{"name":"transactionReference","in":"query","required":false,"schemaId":"schema_472"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.worldpay.accounts.statements-v1+json","schemaId":"schema_473"},{"name":"WP-CorrelationId","in":"header","required":false,"example":"15cd16b2-7b82-41cb-9b11-21be9dacad88","schemaId":"schema_474"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500"],"pointer":"/accounts/statements","href":"other/getaccountstatement","openApiOperationId":"getAccountStatement","summary":"Query account statement items"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://try.access.worldpay-bsh.securedataplatform.co.uk","description":"Test (Try)"},{"url":"https://access.worldpay-bsh.securedataplatform.co.uk","description":"Live"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK response if the request is valid","mediaType":"application/vnd.worldpay.accounts.statements-v1+json","mediaTypes":["application/vnd.worldpay.accounts.statements-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.accounts.statements-v1+json":{"schemaId":"components/schemas/ExternalStatementResponse"}},"schemaId":"components/schemas/ExternalStatementResponse"},{"code":"400","description":"BAD REQUEST response if the request is not valid","mediaType":"application/vnd.worldpay.accounts.statements-v1+json","mediaTypes":["application/vnd.worldpay.accounts.statements-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.accounts.statements-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1statements/get/responses/400/content/application~1vnd.worldpay.accounts.statements-v1+json/examples/mandatoryFieldMissing","paths/~1accounts~1statements/get/responses/400/content/application~1vnd.worldpay.accounts.statements-v1+json/examples/noFutureDates","paths/~1accounts~1statements/get/responses/400/content/application~1vnd.worldpay.accounts.statements-v1+json/examples/dateIntervalLimitExceeded","paths/~1accounts~1statements/get/responses/400/content/application~1vnd.worldpay.accounts.statements-v1+json/examples/exceededMaxLimit"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1statements/get/responses/400/content/application~1vnd.worldpay.accounts.statements-v1+json/examples/mandatoryFieldMissing","paths/~1accounts~1statements/get/responses/400/content/application~1vnd.worldpay.accounts.statements-v1+json/examples/noFutureDates","paths/~1accounts~1statements/get/responses/400/content/application~1vnd.worldpay.accounts.statements-v1+json/examples/dateIntervalLimitExceeded","paths/~1accounts~1statements/get/responses/400/content/application~1vnd.worldpay.accounts.statements-v1+json/examples/exceededMaxLimit"]},{"code":"401","description":"UNAUTHORIZED response if credentials are invalid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MultiAuthErrorResponse","exampleIds":["paths/~1accounts~1statements/get/responses/401/content/application~1json/examples/accessDenied1","paths/~1accounts~1statements/get/responses/401/content/application~1json/examples/accessDenied2"]}},"schemaId":"components/schemas/MultiAuthErrorResponse","exampleIds":["paths/~1accounts~1statements/get/responses/401/content/application~1json/examples/accessDenied1","paths/~1accounts~1statements/get/responses/401/content/application~1json/examples/accessDenied2"]},{"code":"403","description":"FORBIDDEN response if Entitlements are not valid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1statements/get/responses/403/content/application~1json/examples/forbidden"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1statements/get/responses/403/content/application~1json/examples/forbidden"]},{"code":"404","description":"NOT FOUND response","mediaType":"application/vnd.worldpay.accounts.statements-v1+json","mediaTypes":["application/vnd.worldpay.accounts.statements-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.accounts.statements-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1statements/get/responses/404/content/application~1vnd.worldpay.accounts.statements-v1+json/examples/pageNotFound"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1statements/get/responses/404/content/application~1vnd.worldpay.accounts.statements-v1+json/examples/pageNotFound"]},{"code":"500","description":"Internal server error","mediaType":"application/vnd.worldpay.accounts.statements-v1+json","mediaTypes":["application/vnd.worldpay.accounts.statements-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.accounts.statements-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1statements/get/responses/500/content/application~1vnd.worldpay.accounts.statements-v1+json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1statements/get/responses/500/content/application~1vnd.worldpay.accounts.statements-v1+json/example"]}],"pointer":"/paths/~1accounts~1statements/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExternalStatementResponse","mediaTypes":["application/vnd.worldpay.accounts.statements-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.accounts.statements-v1+json":{"schemaId":"components/schemas/ExternalStatementResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1statements/get/responses/400/content/application~1vnd.worldpay.accounts.statements-v1+json/examples/mandatoryFieldMissing","paths/~1accounts~1statements/get/responses/400/content/application~1vnd.worldpay.accounts.statements-v1+json/examples/noFutureDates","paths/~1accounts~1statements/get/responses/400/content/application~1vnd.worldpay.accounts.statements-v1+json/examples/dateIntervalLimitExceeded","paths/~1accounts~1statements/get/responses/400/content/application~1vnd.worldpay.accounts.statements-v1+json/examples/exceededMaxLimit"],"mediaTypes":["application/vnd.worldpay.accounts.statements-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.accounts.statements-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1statements/get/responses/400/content/application~1vnd.worldpay.accounts.statements-v1+json/examples/mandatoryFieldMissing","paths/~1accounts~1statements/get/responses/400/content/application~1vnd.worldpay.accounts.statements-v1+json/examples/noFutureDates","paths/~1accounts~1statements/get/responses/400/content/application~1vnd.worldpay.accounts.statements-v1+json/examples/dateIntervalLimitExceeded","paths/~1accounts~1statements/get/responses/400/content/application~1vnd.worldpay.accounts.statements-v1+json/examples/exceededMaxLimit"]}}},{"code":"401","schemaId":"components/schemas/MultiAuthErrorResponse","exampleIds":["paths/~1accounts~1statements/get/responses/401/content/application~1json/examples/accessDenied1","paths/~1accounts~1statements/get/responses/401/content/application~1json/examples/accessDenied2"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MultiAuthErrorResponse","exampleIds":["paths/~1accounts~1statements/get/responses/401/content/application~1json/examples/accessDenied1","paths/~1accounts~1statements/get/responses/401/content/application~1json/examples/accessDenied2"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1statements/get/responses/403/content/application~1json/examples/forbidden"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1statements/get/responses/403/content/application~1json/examples/forbidden"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1statements/get/responses/404/content/application~1vnd.worldpay.accounts.statements-v1+json/examples/pageNotFound"],"mediaTypes":["application/vnd.worldpay.accounts.statements-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.accounts.statements-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1statements/get/responses/404/content/application~1vnd.worldpay.accounts.statements-v1+json/examples/pageNotFound"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1statements/get/responses/500/content/application~1vnd.worldpay.accounts.statements-v1+json/example"],"mediaTypes":["application/vnd.worldpay.accounts.statements-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.accounts.statements-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1statements/get/responses/500/content/application~1vnd.worldpay.accounts.statements-v1+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/getaccountstatement"}],"panels":[]}]},"httpPath":"/accounts/statements"}],"store":{"schemaStore":{"components/schemas/AlphanumericRestricted":{"id":"components/schemas/AlphanumericRestricted","kind":"json-schema","title":"AlphanumericRestricted","data":{"type":"string","pattern":"^[a-zA-Z0-9 ._-]*$"}},"components/schemas/CountryCode":{"id":"components/schemas/CountryCode","kind":"json-schema","title":"CountryCode","data":{"type":"string","minLength":2,"maxLength":2,"pattern":"^[a-zA-Z0-9]*$"}},"components/schemas/ErrorResponse":{"id":"components/schemas/ErrorResponse","kind":"json-schema","title":"ErrorResponse","data":{"type":"object","properties":{"httpStatusCode":{"type":"integer","format":"int32"},"customCode":{"type":"string","nullable":true},"message":{"type":"string","nullable":true},"errors":{"type":"object","items":{"$ref":"#/components/schemas/ErrorResponseItem"},"nullable":true}},"additionalProperties":false}},"components/schemas/ErrorResponseItem":{"id":"components/schemas/ErrorResponseItem","kind":"json-schema","title":"ErrorResponseItem","data":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"components/schemas/AltAuthErrorResponse":{"id":"components/schemas/AltAuthErrorResponse","kind":"json-schema","title":"AltAuthErrorResponse","data":{"type":"object","properties":{"errorName":{"type":"string","nullable":true},"message":{"type":"string","nullable":true}}}},"components/schemas/MultiAuthErrorResponse":{"id":"components/schemas/MultiAuthErrorResponse","kind":"json-schema","title":"MultiAuthErrorResponse","data":{"allOf":[{"$ref":"#/components/schemas/ErrorResponse"},{"$ref":"#/components/schemas/AltAuthErrorResponse"}]}},"components/schemas/ExternalAccountStatementItems":{"id":"components/schemas/ExternalAccountStatementItems","kind":"json-schema","title":"ExternalAccountStatementItems","data":{"type":"object","properties":{"transactionReference":{"description":"Your unique reference for the transaction.","type":"string","nullable":true},"transferType":{"description":"The transfer type.","type":"string","nullable":true},"amount":{"description":"The amount.","type":"number","format":"double"},"timestamp":{"description":"The posting date of the specific statement item.","type":"string","format":"date-time"},"fundingType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A credit or debit operation. Value can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"credit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"debit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","nullable":true},"rate":{"description":"The rate applied for FX conversion.","type":"number","format":"double","nullable":true},"cleared":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cleared balance or uncleared balance. Value can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"no"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","nullable":true},"description":{"description":"The description of this statement item.","type":"string","nullable":true},"statementItemId":{"description":"The statement identifier.","type":"string","format":"uuid"},"balance":{"description":"The balance that resulted from this statement item's transaction.","type":"number","format":"double"},"statementNumber":{"description":"The statement number.","type":"integer","format":"int64"},"narrative":{"description":"The reference to the specific transaction.","type":"string","nullable":true},"countryCode":{"description":"The country code.","type":"string","nullable":true},"originalCurrency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For statement items (debits/credits) with no FX conversion involved, originalCurrency value will be null."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In case an FX conversion is involved, then:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For debit items, originalCurrency shows the target currency."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For credit items, originalCurrency shows the source currency."},"children":[]}]}]}]}],"type":"string","nullable":true},"originalAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For statement items (debits/credits) with no FX conversion involved, originalAmount value will be null."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In case an FX conversion is involved, then:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For debit items, originalAmount shows the target amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For credit items, originalAmount shows the source amount."},"children":[]}]}]}]}],"type":"number","format":"double","nullable":true}},"additionalProperties":false}},"components/schemas/ExternalStatementResponse":{"id":"components/schemas/ExternalStatementResponse","kind":"json-schema","title":"ExternalStatementResponse","data":{"type":"object","properties":{"accountNumber":{"description":"The account number.","type":"string","nullable":true},"currency":{"description":"The currency, determined by the first item in the list. The currency is the same for all items.","type":"string","nullable":true},"accountStatementItems":{"description":"A collection of account statement items.","type":"array","items":{"$ref":"#/components/schemas/ExternalAccountStatementItems"},"nullable":true},"pageNumber":{"description":"The page number. Default is 1 if no value is provided. This value specifies the exact page of each list of statements that you want to retrieve.","type":"integer","format":"int32"},"pageSize":{"description":"The exact number of records per page to be shown. Max 500 items/rows. Value must be between 1-500. Default is 1 if no value is provided.","type":"integer","format":"int32"},"pageCount":{"description":"The total number of pages.","type":"integer","format":"int32"},"totalNumberOfRecords":{"description":"The total number of records.","type":"integer","format":"int32"}},"additionalProperties":false}},"schema_463":{"kind":"json-schema","data":{"type":"string","minLength":16,"maxLength":16},"id":"schema_463"},"schema_464":{"kind":"json-schema","data":{"type":"string","format":"date-time","example":"2022-05-01T15:16:30Z"},"id":"schema_464"},"schema_465":{"kind":"json-schema","data":{"type":"string","format":"date-time","example":"2022-05-05T15:16:30Z"},"id":"schema_465"},"schema_466":{"kind":"json-schema","data":{"type":"integer","format":"int32","minimum":1},"id":"schema_466"},"schema_467":{"kind":"json-schema","data":{"type":"integer","format":"int32","minimum":1,"maximum":500},"id":"schema_467"},"schema_468":{"kind":"json-schema","data":{"type":"string","enum":["credit","debit"]},"id":"schema_468"},"schema_469":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AlphanumericRestricted","maxLength":20},"id":"schema_469"},"schema_470":{"kind":"json-schema","data":{"$ref":"#/components/schemas/CountryCode","maxLength":2},"id":"schema_470"},"schema_471":{"kind":"json-schema","data":{"type":"number","format":"decimal"},"id":"schema_471"},"schema_472":{"kind":"json-schema","data":{"type":"string","maxLength":50},"id":"schema_472"},"schema_473":{"kind":"json-schema","data":{"type":"string","example":"application/vnd.worldpay.accounts.statements-v1+json"},"id":"schema_473"},"schema_474":{"kind":"json-schema","data":{"type":"string"},"id":"schema_474"}},"exampleStore":{"paths/~1accounts~1statements/get/responses/400/content/application~1vnd.worldpay.accounts.statements-v1+json/examples/mandatoryFieldMissing":{"value":{"httpStatusCode":400,"customCode":"STAB16","message":"There was an error in the request","errors":{"enddate":["endDate is mandatory"]}},"key":"mandatoryFieldMissing","summary":"mandatoryFieldMissing","id":"paths/~1accounts~1statements/get/responses/400/content/application~1vnd.worldpay.accounts.statements-v1+json/examples/mandatoryFieldMissing"},"paths/~1accounts~1statements/get/responses/400/content/application~1vnd.worldpay.accounts.statements-v1+json/examples/noFutureDates":{"value":{"httpStatusCode":400,"customCode":"STAB16","message":"There was an error in the request","errors":{"startdate":["Request date shouldn't be a future date"]}},"key":"noFutureDates","summary":"noFutureDates","id":"paths/~1accounts~1statements/get/responses/400/content/application~1vnd.worldpay.accounts.statements-v1+json/examples/noFutureDates"},"paths/~1accounts~1statements/get/responses/400/content/application~1vnd.worldpay.accounts.statements-v1+json/examples/dateIntervalLimitExceeded":{"value":{"httpStatusCode":400,"customCode":"STAB16","message":"There was an error in the request","errors":{"startdate":["Date interval limit exceeded in the request. Max interval is 31 days"]}},"key":"dateIntervalLimitExceeded","summary":"dateIntervalLimitExceeded","id":"paths/~1accounts~1statements/get/responses/400/content/application~1vnd.worldpay.accounts.statements-v1+json/examples/dateIntervalLimitExceeded"},"paths/~1accounts~1statements/get/responses/400/content/application~1vnd.worldpay.accounts.statements-v1+json/examples/exceededMaxLimit":{"value":{"httpStatusCode":400,"customCode":"STAB16","message":"There was an error in the request","errors":{"pagesize":["pageSize limit exceeded in the request. Maximum number of pageSize is 500"]}},"key":"exceededMaxLimit","summary":"exceededMaxLimit","id":"paths/~1accounts~1statements/get/responses/400/content/application~1vnd.worldpay.accounts.statements-v1+json/examples/exceededMaxLimit"},"paths/~1accounts~1statements/get/responses/401/content/application~1json/examples/accessDenied1":{"value":{"errorName":"accessDenied","message":"Access to the requested resource has been denied"},"key":"accessDenied1","summary":"accessDenied1","id":"paths/~1accounts~1statements/get/responses/401/content/application~1json/examples/accessDenied1"},"paths/~1accounts~1statements/get/responses/401/content/application~1json/examples/accessDenied2":{"value":{"httpStatusCode":401,"customCode":"STAU06","message":"Unauthorized request"},"key":"accessDenied2","summary":"accessDenied2","id":"paths/~1accounts~1statements/get/responses/401/content/application~1json/examples/accessDenied2"},"paths/~1accounts~1statements/get/responses/403/content/application~1json/examples/forbidden":{"value":{"httpStatusCode":403,"customCode":"STAF18","message":"Forbidden"},"key":"forbidden","summary":"forbidden","id":"paths/~1accounts~1statements/get/responses/403/content/application~1json/examples/forbidden"},"paths/~1accounts~1statements/get/responses/404/content/application~1vnd.worldpay.accounts.statements-v1+json/examples/pageNotFound":{"value":{"httpStatusCode":404,"customCode":"STAN15","message":"The requested page was not found. The page number requested is outside the value of the total number of pages."},"key":"pageNotFound","summary":"pageNotFound","id":"paths/~1accounts~1statements/get/responses/404/content/application~1vnd.worldpay.accounts.statements-v1+json/examples/pageNotFound"},"paths/~1accounts~1statements/get/responses/500/content/application~1vnd.worldpay.accounts.statements-v1+json/example":{"value":{"httpStatusCode":500,"customCode":"STAE00A","message":"Internal Server Error"},"id":"paths/~1accounts~1statements/get/responses/500/content/application~1vnd.worldpay.accounts.statements-v1+json/example"}},"securitySchemeStore":{"basicAuth":{"id":"basicAuth","type":"http","scheme":"basic"}},"servers":[{"url":"https://try.access.worldpay-bsh.securedataplatform.co.uk","description":"Test (Try)"},{"url":"https://access.worldpay-bsh.securedataplatform.co.uk","description":"Live"}],"specType":"openapi"},"options":{"jsonSamplesExpandLevel":7,"schemasExpansionLevel":1,"hideSchemaTitles":true,"hidePropertiesPrefix":true,"hideInfoMetadata":true,"codeSamples":{"languages":[{"lang":"Payload"},{"lang":"curl"},{"lang":"Python"},{"lang":"Java"},{"lang":"Node.js"},{"lang":"Go"},{"lang":"PHP"},{"lang":"Ruby"},{"lang":"C#"}]},"feedback":{"type":"sentiment","settings":{"label":"Do you like our page?","submitText":"Thanks for your feedback","comment":{"likeLabel":"What was most helpful?","dislikeLabel":"What can we improve?"}}},"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/access/_bundle/products/statements/@v1/openapi.json?download"},{"url":"/access/_bundle/products/statements/@v1/openapi.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Statement","description":"Retrieve your account statement and see individual entries for all credits and debits. Specify a date range and other optional filter values.\n\n__Authentication header__\n\n  ```\n    Authorization: {your_credentials}\n  ```\n  Replace `{your_credentials}` with your base64-encoded Basic Auth username and password given to you by your Worldpay Implementation Manager.\n  <br /> <br />\n  You **must** use the `Authorization` header for any request you send to our Account APIs.\n  <br /><br />\n  __Accept header__\n  ```\n    Accept: application/vnd.worldpay.accounts.statements-v1+json\n  ```\n\nWe use the Accept header to identify which version of our API you are using. You must use the Accept header for any request you send to our Account APIs.\n<br /><br />\n__DNS whitelisting__\n\nWhitelist the following URLs:\n* `https://try.access.worldpay-bsh.securedataplatform.co.uk/`\n* `https://access.worldpay-bsh.securedataplatform.co.uk/`\n\nPlease ensure you use DNS whitelisting, not explicit IP whitelisting. When you make a request within Access Worldpay, you should always cache the response returned.","category":["Accounts"],"business":["Enterprise"],"generated":false}},"baseSlug":"/products/statements/v1/openapi","routesMapping":{}}