{"items":[{"type":"link","label":"Statements","link":"/products/statements/openapi","routeSlug":"/products/statements/openapi","content":{"contentType":"overview","meta":{"name":"Statements"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/access/_bundle/products/statements/@20250101/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/access/_bundle/products/statements/@20250101/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.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Statements (2025-01-01)","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 Statements API."},"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":"WP-Api-Version header"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"  WP-Api-Version: 2025-01-01\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"  WP-Api-Version: 2025-01-01\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 WP-Api-Version header to identify which version of our API you are using. You must use the WP-Api-Version 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.com/"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://access.worldpay.com/"},"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/openapi"}],"sectionId":"/products/statements/openapi"}]}]}},{"label":"Query account statement items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/statements/openapi/other/getstatements","routeSlug":"/products/statements/openapi/other/getstatements","metadata":{"seo":{"title":"Query account statement items","description":"Query account statement items"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetStatements","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":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"startDate","in":"query","schemaId":"schema_449","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_450","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":"accountNumber","in":"query","schemaId":"schema_451","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account number. You must use this if you are an Account Payout customer. You can use this for a Marketplaces flow."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partyReference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be provided. "},"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":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]}]},{"name":"partyReference","in":"query","schemaId":"schema_452","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your reference for this party, must be unique within an entity. Typically used for a Marketplaces flow and used to retrieve information about your onboarded party. Allowed values: a-z, A-Z, 0-9, spaces and hyphens."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partyReference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be provided. "},"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":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partyReference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided you must also include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"entity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]}]},{"name":"entity","in":"query","schemaId":"schema_453","description":"Used to route the request in Access Worldpay, created as part of on-boarding."},{"name":"currency","in":"query","schemaId":"schema_454","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/reference/supported-countries-currencies#iso-currency-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217 currency format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the account associated with the party."},"children":[]}]}]}]},{"name":"pageNumber","in":"query","schemaId":"schema_455","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_456","description":"Exact number of records per page to be shown. Max 500 items/rows. Value must be between 1-500. Default is 500 if no value is provided."},{"name":"fundingType","in":"query","schemaId":"schema_457","description":"Credit or debit operation. Value can be credit or debit. If no value is passed, the statement includes both credits and debits."},{"name":"transferType","in":"query","schemaId":"schema_458","description":"Type of the transaction used to filter out statement entries. Alphanumeric only. Special characters are restricted."},{"name":"countryCode","in":"query","schemaId":"schema_459","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country code specified in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/reference/supported-countries-currencies#iso-country-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 Alpha-2 code format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}]},{"name":"amount","in":"query","schemaId":"schema_460","description":"The transaction amount."},{"name":"transactionReference","in":"query","schemaId":"schema_461","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"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"formatting guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1accounts~1statements/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"WP-Api-Version","in":"header","schemaId":"schema_462","description":"Represents the version of the API.","required":true,"example":"2025-01-01"},{"name":"WP-CorrelationId","in":"header","schemaId":"schema_462","description":"Optional ID to trace requests, if not provided, it is generated.","example":"15cd16b2-7b82-41cb-9b11-21be9dacad88"},{"name":"WP-CallerId","in":"header","schemaId":"schema_462","description":"An ID used for logging purposes."},{"name":"Accept","in":"header","schemaId":"schema_462","description":"Accept header is optional and must be application/json if provided.","example":"application/json"}],"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.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"parameters":{"path":[],"query":[{"name":"startDate","in":"query","required":true,"example":"2022-05-01T15:16:30Z","schemaId":"schema_449"},{"name":"endDate","in":"query","required":true,"example":"2022-05-05T15:16:30Z","schemaId":"schema_450"},{"name":"accountNumber","in":"query","example":"0005553123712133","schemaId":"schema_451"},{"name":"partyReference","in":"query","example":"Hosaka2738491","schemaId":"schema_452"},{"name":"entity","in":"query","example":"default","schemaId":"schema_453"},{"name":"currency","in":"query","example":"GBP","schemaId":"schema_454"},{"name":"pageNumber","in":"query","schemaId":"schema_455"},{"name":"pageSize","in":"query","schemaId":"schema_456"},{"name":"fundingType","in":"query","schemaId":"schema_457"},{"name":"transferType","in":"query","schemaId":"schema_458"},{"name":"countryCode","in":"query","schemaId":"schema_459"},{"name":"amount","in":"query","schemaId":"schema_460"},{"name":"transactionReference","in":"query","schemaId":"schema_461"}],"querystring":[],"header":[{"name":"WP-Api-Version","in":"header","required":true,"example":"2025-01-01","schemaId":"schema_462"},{"name":"WP-CorrelationId","in":"header","example":"15cd16b2-7b82-41cb-9b11-21be9dacad88","schemaId":"schema_462"},{"name":"WP-CallerId","in":"header","schemaId":"schema_462"},{"name":"Accept","in":"header","example":"application/json","schemaId":"schema_462"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","204","400","401","403","404","500"],"pointer":"/accounts/statements","href":"other/getstatements","openApiOperationId":"GetStatements","summary":"Query account statement items"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","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/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExternalStatementResponseV2"}},"schemaId":"components/schemas/ExternalStatementResponseV2"},{"code":"204","description":"No content for valid request"},{"code":"400","description":"BAD REQUEST response if the request is not valid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExtendedAccessErrorResponse","exampleIds":["paths/~1accounts~1statements/get/responses/400/content/application~1json/examples/InvalidUser","paths/~1accounts~1statements/get/responses/400/content/application~1json/examples/noFutureDates","paths/~1accounts~1statements/get/responses/400/content/application~1json/examples/DateLimitIntervalExceeded","paths/~1accounts~1statements/get/responses/400/content/application~1json/examples/ExceededMaxLimit"]}},"schemaId":"components/schemas/ExtendedAccessErrorResponse","exampleIds":["paths/~1accounts~1statements/get/responses/400/content/application~1json/examples/InvalidUser","paths/~1accounts~1statements/get/responses/400/content/application~1json/examples/noFutureDates","paths/~1accounts~1statements/get/responses/400/content/application~1json/examples/DateLimitIntervalExceeded","paths/~1accounts~1statements/get/responses/400/content/application~1json/examples/ExceededMaxLimit"]},{"code":"401","description":"UNAUTHORIZED response if JWT is not valid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BaseAccessErrorResponse","exampleIds":["paths/~1accounts~1statements/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/BaseAccessErrorResponse","exampleIds":["paths/~1accounts~1statements/get/responses/401/content/application~1json/example"]},{"code":"403","description":"FORBIDDEN response if Entitlements are not valid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BaseAccessErrorResponse","exampleIds":["paths/~1accounts~1statements/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/BaseAccessErrorResponse","exampleIds":["paths/~1accounts~1statements/get/responses/403/content/application~1json/example"]},{"code":"404","description":"NOT FOUND response if the AccountNumber or Page was not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BaseAccessErrorResponse","exampleIds":["paths/~1accounts~1statements/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/BaseAccessErrorResponse","exampleIds":["paths/~1accounts~1statements/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BaseAccessErrorResponse","exampleIds":["paths/~1accounts~1statements/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/BaseAccessErrorResponse","exampleIds":["paths/~1accounts~1statements/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1accounts~1statements/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExternalStatementResponseV2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExternalStatementResponseV2"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/ExtendedAccessErrorResponse","exampleIds":["paths/~1accounts~1statements/get/responses/400/content/application~1json/examples/InvalidUser","paths/~1accounts~1statements/get/responses/400/content/application~1json/examples/noFutureDates","paths/~1accounts~1statements/get/responses/400/content/application~1json/examples/DateLimitIntervalExceeded","paths/~1accounts~1statements/get/responses/400/content/application~1json/examples/ExceededMaxLimit"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExtendedAccessErrorResponse","exampleIds":["paths/~1accounts~1statements/get/responses/400/content/application~1json/examples/InvalidUser","paths/~1accounts~1statements/get/responses/400/content/application~1json/examples/noFutureDates","paths/~1accounts~1statements/get/responses/400/content/application~1json/examples/DateLimitIntervalExceeded","paths/~1accounts~1statements/get/responses/400/content/application~1json/examples/ExceededMaxLimit"]}}},{"code":"401","schemaId":"components/schemas/BaseAccessErrorResponse","exampleIds":["paths/~1accounts~1statements/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BaseAccessErrorResponse","exampleIds":["paths/~1accounts~1statements/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/BaseAccessErrorResponse","exampleIds":["paths/~1accounts~1statements/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BaseAccessErrorResponse","exampleIds":["paths/~1accounts~1statements/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/BaseAccessErrorResponse","exampleIds":["paths/~1accounts~1statements/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BaseAccessErrorResponse","exampleIds":["paths/~1accounts~1statements/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/BaseAccessErrorResponse","exampleIds":["paths/~1accounts~1statements/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BaseAccessErrorResponse","exampleIds":["paths/~1accounts~1statements/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/getstatements"}],"panels":[]}]},"httpPath":"/accounts/statements"}],"store":{"schemaStore":{"components/schemas/BaseAccessErrorResponse":{"id":"components/schemas/BaseAccessErrorResponse","kind":"json-schema","title":"BaseAccessErrorResponse","data":{"type":"object","properties":{"errorName":{"type":"string","description":"Unique response code for this endpoint.","nullable":true},"message":{"type":"string","description":"Error message.","nullable":true},"headerName":{"type":"string","description":"Error message.","nullable":true}},"additionalProperties":false}},"components/schemas/ExtendedAccessErrorResponse":{"id":"components/schemas/ExtendedAccessErrorResponse","kind":"json-schema","title":"ExtendedAccessErrorResponse","data":{"type":"object","properties":{"errorName":{"type":"string","description":"Unique response code for this endpoint.","nullable":true},"message":{"type":"string","description":"Error message.","nullable":true},"headerName":{"type":"string","description":"Error message.","nullable":true},"validationErrors":{"type":"array","items":{"$ref":"#/components/schemas/ValidationErrors"},"description":"Collection of error details. This field may be omitted from the response depending on the nature of the error.","nullable":true}},"additionalProperties":false}},"components/schemas/ExternalAccountStatementItemsV2":{"id":"components/schemas/ExternalAccountStatementItemsV2","kind":"json-schema","title":"ExternalAccountStatementItemsV2","data":{"type":"object","properties":{"transactionReference":{"type":"string","description":"Your unique reference for the transaction.","nullable":true},"transferType":{"type":"string","description":"The transfer type.","nullable":true},"amount":{"type":"number","description":"The amount.","format":"double"},"timestamp":{"type":"string","description":"The posting date of the specific statement item.","format":"date-time"},"fundingType":{"type":"string","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":[]}]}]}],"nullable":true},"rate":{"type":"number","description":"The rate applied for FX conversion.","format":"double","nullable":true},"cleared":{"type":"string","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":[]}]}]}],"nullable":true},"description":{"type":"string","description":"The description of this statement item.","nullable":true},"statementItemId":{"type":"string","description":"The statement identifier.","format":"uuid"},"balance":{"type":"number","description":"The balance that resulted from this statement item's transaction.","format":"double"},"statementNumber":{"type":"integer","description":"The statement number.","format":"int64"},"narrative":{"$ref":"#/components/schemas/ExternalNarrativeV2"},"countryCode":{"type":"string","description":"The country code.","nullable":true},"originalCurrency":{"type":"string","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, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originalCurrency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 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, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originalCurrency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 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, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originalCurrency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" shows the source currency."},"children":[]}]}]}]}],"nullable":true},"originalAmount":{"type":"number","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, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 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, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 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, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" shows the source amount."},"children":[]}]}]}]}],"format":"double","nullable":true}},"additionalProperties":false}},"components/schemas/ExternalNarrativeV2":{"id":"components/schemas/ExternalNarrativeV2","kind":"json-schema","title":"ExternalNarrativeV2","data":{"type":"object","properties":{"line1":{"type":"string","nullable":true}},"additionalProperties":false}},"components/schemas/ExternalStatementResponseV2":{"id":"components/schemas/ExternalStatementResponseV2","kind":"json-schema","title":"ExternalStatementResponseV2","data":{"type":"object","properties":{"accountNumber":{"type":"string","description":"The account number.","nullable":true},"currency":{"type":"string","description":"The currency, determined by the first item in the list. The currency is the same for all items.","nullable":true},"accountStatementItems":{"type":"array","items":{"$ref":"#/components/schemas/ExternalAccountStatementItemsV2"},"description":"A collection of account statement items.","nullable":true},"pageNumber":{"type":"integer","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.","format":"int32"},"pageSize":{"type":"integer","description":"The exact number of records per page to be shown. Max 500 items/rows. Value must be between 1-500. Default is 500 if no value is provided.","format":"int32"},"pageCount":{"type":"integer","description":"The total number of pages.","format":"int32"},"totalNumberOfRecords":{"type":"integer","description":"The total number of records.","format":"int32"}},"additionalProperties":false}},"components/schemas/ValidationErrors":{"id":"components/schemas/ValidationErrors","kind":"json-schema","title":"ValidationErrors","data":{"type":"object","properties":{"errorName":{"type":"string","nullable":true},"message":{"type":"string","nullable":true},"queryParameter":{"type":"string","nullable":true}},"additionalProperties":false}},"schema_449":{"kind":"json-schema","data":{"type":"string","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.","format":"date-time","example":"2022-05-01T15:16:30Z"},"id":"schema_449"},"schema_450":{"kind":"json-schema","data":{"type":"string","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.","format":"date-time","example":"2022-05-05T15:16:30Z"},"id":"schema_450"},"schema_451":{"kind":"json-schema","data":{"maxLength":16,"minLength":16,"type":"string","description":"The account number.","example":"0005553123712133"},"id":"schema_451"},"schema_452":{"kind":"json-schema","data":{"maxLength":63,"minLength":3,"type":"string","description":"Your reference for this party, must be unique within an entity. Allowed values a-z, A-Z, 0-9, spaces and hyphens.","example":"Hosaka2738491"},"id":"schema_452"},"schema_453":{"kind":"json-schema","data":{"maxLength":36,"minLength":1,"type":"string","description":"Used to route the request in Access Worldpay, created as part of on-boarding.","example":"default"},"id":"schema_453"},"schema_454":{"kind":"json-schema","data":{"maxLength":3,"minLength":3,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/reference/supported-countries-currencies#iso-currency-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217 currency format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the account associated with the party"},"children":[]}]}]}],"example":"GBP"},"id":"schema_454"},"schema_455":{"kind":"json-schema","data":{"minLength":1,"type":"integer","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.","format":"int32"},"id":"schema_455"},"schema_456":{"kind":"json-schema","data":{"maxLength":500,"minLength":1,"type":"integer","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.","format":"int32"},"id":"schema_456"},"schema_457":{"kind":"json-schema","data":{"enum":["credit","debit"],"type":"string","description":"Credit or debit operation. Value can be credit or debit. If no value is passed, the statement includes both credits and debits."},"id":"schema_457"},"schema_458":{"kind":"json-schema","data":{"pattern":"^[a-zA-Z0-9 ._-]*$","description":"Type of the transaction used to filter out statement entries. Alphanumeric only. Special characters are restricted.","enum":["ACQUIRING SETTLEMENT","BANKIN","BANKIN_REFUND","BANKOUT","BENEFICIARY PAYOUT","BENEFICIARY_FUNDING","CHARGEBACK","COMMISSION","CORRECTION","CREDIT","DEBIT","DEDUCTION","EFTIN","EFTIN_REFUND","FFX PAYOUT","FFX PAYOUT RETURNED","FFX PAYOUT REVERSAL","FX DEAL","INTERNAL LIQUIDITY","LIQUIDITY","PAYIN","PAYIN_REFUND","PAYIN REVERSAL","PAYOUT","PAYOUT RETURNED","PAYOUT REVERSAL","REFUND","SPLIT PAYMENT","SPLIT PAYOUT","STREAMLINE TRANSFER"],"x-enumDescriptions":{"ACQUIRING SETTLEMENT":null,"BANKIN":"Non-US customers only","BANKIN_REFUND":"Non-US customers only","BANKOUT":"Non-US customers only","BENEFICIARY PAYOUT":"Used in Marketplaces","BENEFICIARY_FUNDING":"Used in Marketplaces","CHARGEBACK":"Used in Marketplaces","COMMISSION":"Used in Marketplaces","CORRECTION":null,"CREDIT":"Used in Marketplaces","DEBIT":"Used in Marketplaces","DEDUCTION":null,"EFTIN":null,"EFTIN_REFUND":null,"FFX PAYOUT":null,"FFX PAYOUT RETURNED":null,"FFX PAYOUT REVERSAL":null,"FX DEAL":null,"INTERNAL LIQUIDITY":null,"LIQUIDITY":null,"PAYIN":"US-merchants only","PAYIN_REFUND":"US-merchants only","PAYIN REVERSAL":null,"PAYOUT":"US-merchants only","PAYOUT RETURNED":null,"PAYOUT REVERSAL":null,"REFUND":null,"SPLIT PAYMENT":null,"SPLIT PAYOUT":null,"STREAMLINE TRANSFER":null}},"id":"schema_458"},"schema_459":{"kind":"json-schema","data":{"maxLength":2,"minLength":2,"pattern":"^[a-zA-Z0-9]*$","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country code specified in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/reference/supported-countries-currencies#iso-country-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 Alpha-2 code format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction."},"children":[]}]}]}]},"id":"schema_459"},"schema_460":{"kind":"json-schema","data":{"type":"number","description":"The transaction amount.","format":"double"},"id":"schema_460"},"schema_461":{"kind":"json-schema","data":{"maxLength":50,"minLength":1,"type":"string","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"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"formatting guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"id":"schema_461"},"schema_462":{"kind":"json-schema","data":{"type":"string"},"id":"schema_462"}},"exampleStore":{"paths/~1accounts~1statements/get/responses/400/content/application~1json/examples/InvalidUser":{"value":{"errorName":"urlContainsInvalidValue","message":"The URL contains a value or values that are invalid.","validationErrors":[{"errorName":"numberIsTooLarge","message":"AccountNumber is mandatory","queryParameter":"accountNumber"}]},"key":"InvalidUser","summary":"This example shows an invalid format error.","id":"paths/~1accounts~1statements/get/responses/400/content/application~1json/examples/InvalidUser"},"paths/~1accounts~1statements/get/responses/400/content/application~1json/examples/noFutureDates":{"value":{"errorName":"urlContainsInvalidValue","message":"The URL contains a value or values that are invalid.","validationErrors":[{"errorName":"fieldHasInvalidValue","message":"Request date shouldn't be a future date","queryParameter":"endDate"}]},"key":"noFutureDates","summary":"noFutureDates","id":"paths/~1accounts~1statements/get/responses/400/content/application~1json/examples/noFutureDates"},"paths/~1accounts~1statements/get/responses/400/content/application~1json/examples/DateLimitIntervalExceeded":{"value":{"errorName":"urlContainsInvalidValue","message":"The URL contains a value or values that are invalid.","validationErrors":[{"errorName":"fieldHasInvalidValue","message":"Date interval limit exceeded in the request. Max interval is 31 days","queryParameter":"startDate"}]},"key":"DateLimitIntervalExceeded","summary":"DateLimitIntervalExceeded","id":"paths/~1accounts~1statements/get/responses/400/content/application~1json/examples/DateLimitIntervalExceeded"},"paths/~1accounts~1statements/get/responses/400/content/application~1json/examples/ExceededMaxLimit":{"value":{"errorName":"urlContainsInvalidValue","message":"The URL contains a value or values that are invalid.","validationErrors":[{"errorName":"fieldHasInvalidValue","message":"pageSize limit exceeded in the request. Maximum number of pageSize is 500","queryParameter":"startDate"}]},"key":"ExceededMaxLimit","summary":"ExceededMaxLimit","id":"paths/~1accounts~1statements/get/responses/400/content/application~1json/examples/ExceededMaxLimit"},"paths/~1accounts~1statements/get/responses/401/content/application~1json/example":{"value":{"errorName":"accessDenied","message":"Access to the requested resource has been denied"},"id":"paths/~1accounts~1statements/get/responses/401/content/application~1json/example"},"paths/~1accounts~1statements/get/responses/403/content/application~1json/example":{"value":{"errorName":"forbidden","message":"AccessWorldpayId value not available in context"},"id":"paths/~1accounts~1statements/get/responses/403/content/application~1json/example"},"paths/~1accounts~1statements/get/responses/404/content/application~1json/example":{"value":{"errorName":"notFound","message":"The requested page was not found. The page number requested is outside the value of the total number of pages."},"id":"paths/~1accounts~1statements/get/responses/404/content/application~1json/example"},"paths/~1accounts~1statements/get/responses/500/content/application~1json/example":{"value":{"errorName":"internalServerError","message":"An internal server error occurred"},"id":"paths/~1accounts~1statements/get/responses/500/content/application~1json/example"}},"securitySchemeStore":{"BasicAuth":{"id":"BasicAuth","type":"http","scheme":"basic"}},"servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","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/@20250101/openapi.json?download"},{"url":"/access/_bundle/products/statements/@20250101/openapi.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Statements","description":"Retrieve your account statement and see individual entries for all credits and debits. Specify a date range and other optional filter values. \r\n  \r\n    __Authentication header__\r\n\r\n      ```\r\n        Authorization: {your_credentials}\r\n      ```\r\n      Replace `{your_credentials}` with your base64-encoded Basic Auth username and password given to you by your Worldpay Implementation Manager.\r\n      <br /> <br />\r\n      You **must** use the `Authorization` header for any request you send to our Statements API.\r\n      <br /><br />\r\n      __WP-Api-Version header__\r\n      ```\r\n        WP-Api-Version: 2025-01-01\r\n      ```\r\n\r\n    We use the WP-Api-Version header to identify which version of our API you are using. You must use the WP-Api-Version header for any request you send to our Account APIs.\r\n    <br /><br />\r\n    __DNS whitelisting__\r\n\r\n    Whitelist the following URLs:\r\n    * `https://try.access.worldpay.com/`\r\n    * `https://access.worldpay.com/`\r\n\r\n    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.","business":["Enterprise","Marketplaces"],"catalog-list":true,"category":["Accounts"],"generated":true}},"baseSlug":"/products/statements/openapi","routesMapping":{}}