{"templateId":"markdown","versions":[{"version":"v1","label":"v1","link":"/products/payment-queries/query-by-date-range","default":true,"active":true,"folderId":"f48383ec"}],"sharedDataIds":{"sidebar":"sidebar-products/payment-queries/sidebars.yaml","current-catalog-info":"current-catalog-info-/products/payment-queries/openapi"},"props":{"metadata":{"markdoc":{"tagList":["partial","admonition","json-schema","tabs","tab","code-snippet"]},"custom_product":"Payment Queries","type":"markdown"},"seo":{"title":"Date range queries","description":"Worldpay for Developers - docs, code examples, resources and tools. Everything you need to build your omnichannel payment solution.","siteUrl":"https://docs.worldpay.com/access","image":"/access/assets/worldpay-logo-light.21b7daf79984773a9fcd7d4fbcb07ae5289dfffd6023c4c3dca720c7058e53dc.33f780a6.svg","keywords":"documentation, api, openapi, sdks, developer, payments, json, payouts, 3ds","jsonLd":{"@context":"https://schema.org","@type":"Organization","url":"https://docs.worldpay.com/access","name":"Worldpay"},"meta":[{"name":"google-site-verification","content":"zjziIKaP3ImsqsfhYnEBnq1R85UabiSwl7HTXuwtZuo"},{"name":"doc_product","content":"Access"},{"name":"doc_category","content":"Documentation"}],"llmstxt":{"hide":false,"sections":[{"title":"Payments API","description":"Payment orchestration API combining fraud assessment, 3ds authentication, SCA exemptions, Worldpay Token creation and a card or wallet based payment.","includeFiles":["products/payments/@20240601/**/*"],"excludeFiles":[]},{"title":"Payment Queries API","description":"Querying your payments data, based on a variety of parameters.","includeFiles":["products/payment-queries/@v1/**/*"],"excludeFiles":[]},{"title":"Card BIN Data API","description":"Provides detailed information about a card.","includeFiles":["products/card-bin/@v1/**/*"],"excludeFiles":[]},{"title":"3DS Authentication API","description":"Request 3DS authentication to protect against fraud, be SCA compliant and to shift liability using this standalone API.","includeFiles":["products/3ds/@v3/**/*"],"excludeFiles":[]},{"title":"FraudSight API","description":"Request a risk assessment and receive a response with an outcome (e.g. lowRisk) using this standalone API.","includeFiles":["products/fraudsight/@v1/**/*"],"excludeFiles":[]},{"title":"Checkout SDK","description":"Integrate using our clientside SDKs for both web and native devices. Benefit from SAQ-A/PCI-SSF compliance.","includeFiles":["products/checkout/web/@v2/**/*","products/checkout/ios/@v4/**/*","products/checkout/android/@v4/**/*","products/checkout/react-native/@v3/**/*","products/checkout/flutter/@v1/**/*"],"excludeFiles":[]},{"title":"Tokens API","description":"Minimizes the exposure of sensitive card details and increases the security of your customer's card details.","includeFiles":["products/tokens/@v3/**/*"],"excludeFiles":[]},{"title":"Card Payments API","description":"Request a card payment using this standalone API, requires separate requests for 3DS, Fraud assessment etc.","includeFiles":["products/card-payments/@v7/**/*"],"excludeFiles":[]},{"title":"Card Verifications API","description":"Verify your customer's card to maximize your authentication rates.","includeFiles":["products/card-verifications/@v6/**/*"],"excludeFiles":[]},{"title":"Account Payouts API","description":"Send funds to your customer's bank accounts and search for payouts using parameters.","includeFiles":["products/account-payouts/@20250101/**/*"],"excludeFiles":[]},{"title":"APMs","description":"Pay using eWallets, bank transfers, direct debits, local card schemes, Postpay and eInvoice/ Buy Now Pay Later.","includeFiles":["products/apms/@20240701/**/*"],"excludeFiles":[]},{"title":"Balance API","description":"Request your account details for a single account or all accounts under an entity.","includeFiles":["products/balance/@20250101/**/*"],"excludeFiles":[]},{"title":"Card Payouts API","description":"Send funds to your customer's cards.","includeFiles":["products/card-payouts/@v4/**/*"],"excludeFiles":[]},{"title":"Events (Webhooks)","description":"Receive status updates from Access Worldpay by setting up a webhook.","includeFiles":["products/events/@v1/**/*"],"excludeFiles":[]},{"title":"FX API","description":"Manage Foreign Exchange (FX) on your payments.","includeFiles":["products/fx/@v1/**/*"],"excludeFiles":[]},{"title":"Hosted Payment Pages (HPP) API","description":"Our low-code option to take payments securely at the lowest PCI compliance level - SAQ A.","includeFiles":["products/hosted-payment-pages/@v1/**/*"],"excludeFiles":[]},{"title":"Money Transfers API","description":"Money Transfer OCTs (Original Credit Transaction) allow funds to be pushed to an eligible card in 30 minutes or less.","includeFiles":["products/money-transfers/@v1/**/*"],"excludeFiles":[]},{"title":"Parties API","description":"Create parties, manage your payout instruments and beneficial owners and carry out identity verification checks.","includeFiles":["products/parties/@20250101/**/*"],"excludeFiles":[]},{"title":"SCA Exemptions API","description":"Maximize a frictionless checkout experience by using issuer data insights to apply exemptions.","includeFiles":["products/sca-exemptions/@v1/**/*"],"excludeFiles":[]},{"title":"Split Payments API","description":"Divide funds from a single payment amongst yourself and your parties/sellers.","includeFiles":["products/split-payments/@20250625/**/*"],"excludeFiles":[]},{"title":"Statements API","description":"Retrieve your account statement and see individual entries for all credits and debits.","includeFiles":["products/statements/@20250101/**/*"],"excludeFiles":[]},{"title":"Transfers API","description":"Transfer funds from source account to target account.","includeFiles":["products/transfers/@20250101/**/*"],"excludeFiles":[]},{"title":"Verified Tokens API","description":"Verified Tokens ensures that your customer's payment details are valid and CIT compliant when creating a token.","includeFiles":["products/verified-tokens/@v3/**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":["openapi"],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Last updated"]},": 17 October 2025 | ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/payment-queries/changelog/"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Change log"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"date-range-queries","__idx":0},"children":["Date range queries"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Query card payments within a specified date time range."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The API returns data for payments processed after 25 June 2024. For payments processed before then, you can ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/payment-queries/query-archive"},"children":["query for historical payments"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"date-range-request","__idx":1},"children":["Date range request"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Provide a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["startDate"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["endDate"]}," to query all payments within a date range. The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["startDate"]}," cannot be older than one year."," ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://try.access.worldpay.com/paymentQueries/payments?startDate={startDate}&endDate={endDate}&pageSize={pageSize}"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example","__idx":2},"children":["Example"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://try.access.worldpay.com/paymentQueries/payments?startDate=2023-02-12T21:30:20Z&endDate=2023-03-08T21:30:20Z&pageSize=20"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"filter-by-currency","__idx":3},"children":["Filter by currency"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Query for payments within a specified date time range filtered by the requested currency."," ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://try.access.worldpay.com/paymentQueries/payments?startDate={startDate}&endDate={endDate}&pageSize={pageSize}&currency={currency}"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-1","__idx":4},"children":["Example"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://try.access.worldpay.com/paymentQueries/payments?startDate=2024-04-06T21:30:20Z&endDate=2024-04-30T21:30:20Z&pageSize=20&currency=GBP"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"filter-by-minamount-maxamount","__idx":5},"children":["Filter by minAmount, maxAmount"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Query payments within a specified date time range filtered by the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["minAmount"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["maxAmount"]}," for a specific currency."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["minAmount"]}," - only payments with an amount above ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["minAmount"]}," are included"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["maxAmount"]}," - only payments with an amount below ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["maxAmount"]}," are included"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The amount uses an exponent rather than decimal delimiters."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If supplied:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["must be an integer greater than or equal to zero"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["you must supply the currency parameter"]}]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://try.access.worldpay.com/paymentQueries/payments?startDate={startDate}&endDate={endDate}&pageSize={pageSize}&minAmount={minAmount}&maxAmount={maxAmount}&currency={currency}"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-2","__idx":6},"children":["Example"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://try.access.worldpay.com/paymentQueries/payments?startDate=2023-02-12T21:30:20Z&endDate=2023-03-08T21:30:20Z&pageSize=20&minAmount=250&maxAmount=300&&currency=GBP"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"filter-by-last-four-digits","__idx":7},"children":["Filter by last four digits"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Query payments within a specified date time range filtered by the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["last4Digits"]}," of the card number."," ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://try.access.worldpay.com/paymentQueries/payments?startDate={startDate}&endDate={endDate}&pageSize={pageSize}&last4Digits={last4Digits}"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-3","__idx":8},"children":["Example"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://try.access.worldpay.com/paymentQueries/payments?startDate=2023-02-12T21:30:20Z&endDate=2023-03-08T21:30:20Z&pageSize=20&last4Digits=1111"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"filter-by-payment-event","__idx":9},"children":["Filter by payment event"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Query payments within a specified date time range filtered by one or more ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paymentEvents"]},"."," ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://try.access.worldpay.com/paymentQueries/payments?startDate={startDate}&endDate={endDate}&pageSize={pageSize}&receivedEvents={receivedEvents}"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-4","__idx":10},"children":["Example"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://try.access.worldpay.com/paymentQueries/payments?startDate=2023-02-12T21:30:20Z&endDate=2023-03-08T21:30:20Z&pageSize=20&receivedEvents=authorizationRequested,refundRequested"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"filter-by-entity-references","__idx":11},"children":["Filter by entity references"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Query payments within a specified date time range filtered by one or more ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["entityReferences"]}," (also known as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["entity"]},")."," ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://try.access.worldpay.com/paymentQueries/payments?startDate={startDate}&endDate={endDate}&pageSize={pageSize}&entityReferences={entityReferences}"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-5","__idx":12},"children":["Example"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://try.access.worldpay.com/paymentQueries/payments?startDate=2023-02-12T21:30:20Z&endDate=2023-03-08T21:30:20Z&pageSize=20&entityReferences=ref1,ref2"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"parameter-descriptions","__idx":13},"children":["Parameter descriptions"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["startDate"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An ISO 8601 date-time supplied as a string. Filters for payments that occurred after the specified date-time. Must be supplied alongside ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["endDate"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["endDate"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An ISO 8601 date-time supplied as a string. Filters for payments that occurred below the specified date-time. Must be supplied alongside ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["startDate"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pageSize"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["❌"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The maximum number of payments to be returned in the response. If supplied, must be a positive integer greater than 0 and less than or equal to 300.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," If not supplied, default value is 5."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["currency"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["❌"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The three digit ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/reference/supported-countries-currencies#iso-currency-codes"},"children":["currency code"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["minAmount"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["❌"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["This is a whole number with an exponent, e.g. if exponent is two, 250 is 2.50. You can find the relevant exponent in our ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/reference/supported-countries-currencies#iso-currency-codes"},"children":["currency table"]},".",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," If supplied, must be an integer greater than or equal to 0."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["maxAmount"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["❌"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["This is a whole number with an exponent, e.g. if exponent is two, 250 is 2.50. You can find the relevant exponent in our ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/reference/supported-countries-currencies#iso-currency-codes"},"children":["currency table"]},".",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," If supplied, must be an integer greater than or equal to 0."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["last4Digits"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["❌"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The last 4 digits of the card number. If supplied, must be a string with 4 digits."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["entityReferences"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["❌"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Merchant entity name. The request can be for a specific entity reference or can be grouped together as comma separated values. ",{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[" You might have supplied this as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["entity"]}," in your original payment request. "]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["receivedEvents"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["❌"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the event. The request can be for a specific event name or can be grouped together as comma separated values. Default value is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["All"]}," which includes all events.",{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["Possible event values"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["authorizationRequested"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["authorizationSucceeded"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["authorizationRefused"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["authorizationFailed"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["authorizationTimedOut"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["saleRequested"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["saleSucceeded"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["saleRefused"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["saleFailed"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["saleTimedOut"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cancellationRequested"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cancellationRequestSubmitted"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cancellationRequestSubmissionFailed"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cancellationRequestSubmissionTimedOut"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["settlementRequested"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["settlementRequestSubmitted"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["settlementRequestSubmissionFailed"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["settlementRequestSubmissionTimedOut"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["refundRequested"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["refundRequestSubmitted"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["refundRequestSubmissionFailed"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["refundRequestSubmissionTimedOut"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reversalRequested"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reversalRequestSubmitted"]}]}]}]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"response","__idx":14},"children":["Response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The response contains summary information about the payment associated with the request parameters. For detailed information about a payment you should run a ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/payment-queries/retrieve-by-payment-id"},"children":["query using the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paymentId"]}]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"response-schema","__idx":15},"children":["Response schema"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"openapi.yaml#/components/schemas/pq_querybydaterange_200_response"},"options":{"schemaExpansionLevel":0},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/pq_querybydaterange_200_response"},"paymentId":{"maxLength":36,"minLength":25,"pattern":"^[A-Za-z0-9_-]*$","type":"string","description":"Unique identifier generated by us for a single payment. Generated at authorization, and maintained through successive payment actions.","example":"pay4u_lHl2jobU5S1T2pWkq10"},"lastEvent":{"type":"string","description":"The last event received for the payment","example":"authorizationSucceeded","enum":["authorizationRequested","authorizationSucceeded","authorizationRefused","authorizationFailed","authorizationTimedOut","saleRequested","saleSucceeded","saleRefused","saleFailed","saleTimedOut","settlementRequested","settlementRequestSubmitted","settlementRequestSubmissionFailed","settlementRequestSubmissionTimedOut","refundRequested","refundRequestSubmitted","refundRequestSubmissionFailed","refundRequestSubmissionTimedOut","cancellationRequested","cancellationRequestSubmitted","cancellationRequestSubmissionFailed","cancellationRequestSubmissionTimedOut","reversalRequested","reversalRequestSubmitted","reversalRequestSubmissionFailed","reversalRequestSubmissionTimedOut"],"x-enumDescriptions":{"authorizationRequested":"Worldpay has received your authorization request.","authorizationSucceeded":"Your authorization request was successfully approved by the card issuer.","authorizationRefused":"Your authorization request was refused by the card issuer.","authorizationFailed":"Your authorization request failed.","authorizationTimedOut":"Your authorization request timed out.","saleRequested":"Worldpay has received your sale request.","saleSucceeded":"Your sale request was successfully approved by the card issuer.","saleRefused":"Your sale request was refused by the card issuer.","saleFailed":"Your sale request failed.","saleTimedOut":"Your sale request timed out.","settlementRequested":"Worldpay has received your settlement request.","settlementRequestSubmitted":"Your settlement request was successfully sent for processing.","settlementRequestSubmissionFailed":"Your settlement request failed.","settlementRequestSubmissionTimedOut":"Your settlement request timed out.","refundRequested":"Worldpay has received your refund request.","refundRequestSubmitted":"Your refund request was successfully sent for processing.","refundRequestSubmissionFailed":"We failed to process your refund request.","refundRequestSubmissionTimedOut":"Your refund request timed out.","cancellationRequested":"Worldpay has received your cancellation request.","cancellationRequestSubmitted":"Your cancellation request was successfully sent for processing.","cancellationRequestSubmissionFailed":"Your cancellation request failed.","cancellationRequestSubmissionTimedOut":"Your cancellation request timed out.","reversalRequested":"Worldpay has received your reversal request.","reversalRequestSubmitted":"Your reversal request was successfully sent for processing.","reversalRequestSubmissionFailed":"Your reversal request failed.","reversalRequestSubmissionTimedOut":"Your reversal request timed out."}},"fpanLastFour":{"pattern":"^[0-9]+$","type":"string","minLength":4,"maxLength":4,"example":"1111","description":"{% admonition type=\"warning\" name=\"Coming soon\" %}Preview only. Not yet available in production.{% /admonition %}\nThe last four digits of the actual card, where this was submitted in an authorization request that used a network token or a [mobile wallet](/products/wallets#submitting-card-metadata-to-worldpay) (encrypted or decrypted) `paymentInstrument`. Commonly referred to as the Funding Primary Account Number (FPAN)."},"paymentInstrument":{"type":"object","description":"An object that contains information about the payment type.","properties":{"type":{"enum":["card/plain","card/token","card/checkout","card/wallet+applepay","card/wallet+googlepay","card/networkToken","card/networkToken+applepay","card/networkToken+googlepay","card/network","card/plain+masked","card/network+masked"],"type":"string","description":"The type of payment instrument used for this payment."},"card":{"type":"object","description":"An object that contains information about the card used.","properties":{"number":{"type":"object","description":"An object that contains information about the card number.","properties":{"cardBin":{"pattern":"^[0-9*]+$","type":"string","description":"The card BIN (Bank Identification Number) is the first 6 or 8 digits of the card number, and can be used to identify the card issuer, the card brand(s) (e.g. Visa, Cartes Bancaires), and the country. Card BINs are used to route transactions, check card capabilities, and in fraud assessments.","example":"444433"},"last4Digits":{"pattern":"^[0-9*]+$","type":"string","description":"The last four digits of the card. Some characters may be obfuscated with a `*` if the PAN length is less than 16 characters.","example":"1111"},"fpanLastFour":{"$ref":"#/components/schemas/fpanLastFour"}}},"category":{"type":"string","description":"Whether the card is classed as a consumer card or a card for commercial use.","enum":["commercial","consumer"]},"countryCode":{"maxLength":2,"minLength":2,"pattern":"^[A-Z]+$","type":"string","description":"The [ISO 3166-1 Alpha-2 format](/products/reference/supported-countries-currencies#iso-country-codes) country code that the card was issued in. May return `N/A` where the country is unknown.","example":"GB"},"expiryDate":{"type":"object","description":"The expiry date of the card or network token (where the supplied paymentInstrument was `card/wallet+applepay`, `card/wallet+googlepay`, `card/networkToken`, `card/networkToken+applepay` or `card/networkToken+googlepay`).","properties":{"month":{"type":"integer"},"year":{"type":"integer"}}},"issuerName":{"type":"string","description":"The name of the card issuer.","example":"AN ISSUING BANK LTD"},"fundingType":{"type":"string","description":"How the card is funded.","enum":["credit","debit","prepaid","chargeCard","deferredDebit"]},"brand":{"type":"string","description":"The card brand that the transaction was processed with. Sometimes referred to as the network or scheme.","example":"visa"},"paymentAccountReference":{"type":"string","description":"The payment account reference (PAR) is a non-financial reference that uniquely identifies the underlying cardholder account. This allows you to correlate payments made from the same account with differing instruments (e.g. `card/plain` and `card/wallet+applepay`), where the same account funds the transaction. A PAR cannot be used to initiate a payment.","example":"Q1HJZ28RKA1EBL470G9XYG90R5D3E"}}}}},"pq_querybydaterange_200_response":{"required":["_links","_embedded"],"type":"object","properties":{"_links":{"required":["self"],"type":"object","description":"links to the pages.","properties":{"self":{"type":"object","description":"Self link to the page.","properties":{"href":{"type":"string","description":"First page as per the pageSize."}}},"next":{"type":"object","description":"Next page link if the response contains more pages.","properties":{"href":{"type":"string","description":"Second page as per the pageSize."}}}}},"_embedded":{"type":"object","properties":{"payments":{"type":"array","required":["timestamp","transactionReference","entity"],"description":"Array of payments within the date range.","items":{"type":"object","properties":{"timestamp":{"type":"string","description":"Payment initial authorization time."},"paymentId":{"$ref":"#/components/schemas/paymentId"},"transactionReference":{"type":"string","description":"A unique reference generated by you, used to identify a payment throughout its lifecycle."},"narrative":{"type":"object","description":"An object that contains identification and further details of the merchant.","properties":{"line1":{"type":"string","description":"First line of text that appears on your customer's statement."},"line2":{"type":"string","description":"Second line of text that appears on your customer's statement."}}},"transactionType":{"enum":["oneTime","cardOnFile","recurring"],"type":"string","description":"An object that contains transaction type."},"authorizationType":{"enum":["authorization","sale"],"type":"string","description":"An object that contains authorization type."},"entity":{"type":"string","description":"Merchant entity name."},"lastEvent":{"$ref":"#/components/schemas/lastEvent"},"scheme":{"required":["reference"],"type":"object","description":"An object containing information returned by the card scheme.","properties":{"reference":{"type":"string","description":"The reference returned by the scheme for this particular payment authorization.","example":"MCCOLXT1C0104  "}}},"issuer":{"required":["authorizationCode"],"type":"object","description":"An object containing information returned by the issuer.","properties":{"authorizationCode":{"pattern":"^[a-zA-Z0-9]+$","type":"string","description":"A code returned by the card issuer for a successful authorization. Used in reconciliation and dispute management.","example":"T31306"}}},"paymentInstrument":{"$ref":"#/components/schemas/paymentInstrument"},"value":{"required":["amount","currency"],"type":"object","description":"An object that contains payment amount and currency.","properties":{"amount":{"type":"integer","description":"This is a whole number including the currency exponent (e.g. GBP has an exponent of 2, so for £2.50 supply:`250`)."},"currency":{"type":"string","description":"The 3 digit currency code."}}},"_links":{"required":["self"],"type":"object","description":"link to retrieveByPaymentId.","properties":{"self":{"type":"object","description":"Self link to retrieveByPaymentId.","properties":{"href":{"type":"string","description":"RetrieveByPaymentId provides event history and next action links."}}}}}}}}}}}}}}},"schemaResolvedErrors":[]},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"response-examples","__idx":16},"children":["Response examples"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"label":"dateRange query without pageSize","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/responses/daterange-withoutpagesize.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\r\n  \"_links\":{\r\n    \"self\":{\r\n      \"href\":\"/paymentQueries/payments?startDate=2025-06-05T21:30:20Z&endDate=2025-07-08T21:30:20Z\"\r\n    },\r\n    \"next\": {\r\n      \"href\": \"/paymentQueries/payments?startDate=2025-06-06T14:21:20Z&endDate=2025-06-15T09:28:08.298Z&paymentId=payvu0l-laj9bUfU3a2pRkq20\"\r\n    }      \r\n  },\r\n  \"_embedded\":{\r\n    \"payments\":[\r\n      {\r\n        \"timestamp\":\"2025-06-07T12:09:36.984Z\",\r\n        \"paymentId\":\"pay4u_lHl2jobU5S1T2pWkq10\",\r\n        \"transactionReference\":\"Memory265-13/08/1876\",\r\n        \"transactionType\":\"oneTime\",\r\n        \"authorizationType\":\"authorization\",\r\n        \"entity\":\"default\",\r\n        \"paymentInstrument\":{\r\n          \"type\":\"card/plain\"\r\n        },\r\n        \"value\":{\r\n          \"currency\":\"GBP\",\r\n          \"amount\":500\r\n        },\r\n        \"_links\":{\r\n          \"self\":{\r\n            \"href\":\"/paymentQueries/payments/pay4u_lHl2jobU5S1T2pWkq10\"\r\n          }\r\n        }\r\n      },\r\n      {\r\n        \"timestamp\":\"2025-06-07T12:05:01.134Z\",\r\n        \"paymentId\":\"pay3f7oMDb3cCr2z-e_5L4vt0\",\r\n        \"transactionReference\":\"Memory266\",\r\n        \"transactionType\":\"oneTime\",\r\n        \"authorizationType\":\"sale\",\r\n        \"entity\":\"default\",\r\n        \"issuer\":{\r\n          \"authorizationCode\":\"948295\"\r\n        },\r\n        \"scheme\":{\r\n          \"reference\":\"060720116005062\"\r\n        },\r\n        \"paymentInstrument\":{\r\n          \"type\":\"card/plain+masked\",\r\n          \"card\":{\r\n            \"number\":{\r\n              \"last4Digits\":\"1111\",\r\n              \"cardBin\":\"444433\"\r\n            },\r\n            \"brand\":\"visa\",\r\n            \"expiryDate\":{\r\n              \"month\":5,\r\n              \"year\":2035\r\n            },\r\n            \"fundingType\":\"credit\",\r\n            \"issuerName\":\"A Card Issuer\",\r\n            \"paymentAccountReference\":\"Q1HJZ28RKA1EBL470G9XYG90R5D3E\",\r\n            \"category\":\"consumer\"\r\n          }\r\n        },\r\n        \"value\":{\r\n          \"currency\":\"GBP\",\r\n          \"amount\":500\r\n        },\r\n        \"_links\":{\r\n          \"self\":{\r\n            \"href\":\"/paymentQueries/payments/pay3f7oMDb3cCr2z-e_5L4vt0\"\r\n          }\r\n        }\r\n      },\r\n      {\r\n        \"timestamp\":\"2025-06-10T10:22:19.844Z\",\r\n        \"paymentId\":\"paydf5o-Db5cGREs-vT7L4vC0\",\r\n        \"transactionReference\":\"897b8357-0c45-4529-93ce-136dbeac562f\",\r\n        \"transactionType\":\"oneTime\",\r\n        \"authorizationType\":\"authorization\",\r\n        \"entity\":\"default\",\r\n        \"issuer\":{\r\n          \"authorizationCode\":\"478296\"\r\n        },\r\n        \"scheme\":{\r\n          \"reference\":\"060720116005062\"\r\n        },\r\n        \"paymentInstrument\":{\r\n          \"type\":\"card/network+masked\",\r\n          \"card\":{\r\n            \"number\":{\r\n              \"last4Digits\":\"9224\",\r\n              \"cardBin\":\"483196\"\r\n            },\r\n            \"brand\":\"visa\",\r\n            \"expiryDate\":{\r\n              \"month\":12,\r\n              \"year\":2028\r\n            },\r\n            \"countryCode\":\"SG\",\r\n            \"fundingType\":\"debit\",\r\n            \"issuerName\":\"Helios Bank\",\r\n            \"paymentAccountReference\":\"A00JZ28RKA5EBG470G4AYGV0R5D3D\",\r\n            \"category\":\"consumer\"\r\n          }\r\n        },\r\n        \"value\":{\r\n          \"currency\":\"GBP\",\r\n          \"amount\":250\r\n        },\r\n        \"_links\":{\r\n          \"self\":{\r\n            \"href\":\"/paymentQueries/payments/paydf5o-Db5cGREs-vT7L4vC0\"\r\n          }\r\n        }\r\n      },\r\n      {\r\n        \"timestamp\":\"2025-06-13T10:21:28.717Z\",\r\n        \"paymentId\":\"2a4d37cb-03b1-48c0-a588-dc1a00a83c5f\",\r\n        \"transactionReference\":\"93c3df1f-d5c9-4b6b-8f76-8334bae9b0e4\",\r\n        \"transactionType\":\"oneTime\",\r\n        \"authorizationType\":\"authorization\",\r\n        \"entity\":\"default\",\r\n        \"issuer\":{\r\n          \"authorizationCode\":\"737147\"\r\n        },\r\n        \"scheme\":{\r\n          \"reference\":\"060720116005062\"\r\n        },\r\n        \"paymentInstrument\":{\r\n          \"type\":\"card/network+masked\",\r\n          \"card\":{\r\n            \"number\":{\r\n              \"last4Digits\":\"9224\",\r\n              \"cardBin\":\"483196\"\r\n            },\r\n            \"brand\":\"visa\",\r\n            \"expiryDate\":{\r\n              \"month\":12,\r\n              \"year\":2028\r\n            },\r\n            \"countryCode\":\"SG\",\r\n            \"fundingType\":\"debit\",\r\n            \"issuerName\":\"Helios Bank\",\r\n            \"paymentAccountReference\":\"A00JZ28RKA5EBG470G4AYGV0R5D3D\",\r\n            \"category\":\"consumer\"\r\n          }\r\n        },\r\n        \"value\":{\r\n          \"currency\":\"GBP\",\r\n          \"amount\":250\r\n        },\r\n        \"_links\":{\r\n          \"self\":{\r\n            \"href\":\"/paymentQueries/payments/2a4d37cb-03b1-48c0-a588-dc1a00a83c5f\"\r\n          }\r\n        }\r\n      },\r\n      {\r\n        \"timestamp\":\"2025-06-14T10:21:12.755Z\",\r\n        \"paymentId\":\"e638cfbd-5df9-40da-9996-938bb636e299\",\r\n        \"transactionReference\":\"75c40ad1-3945-4c48-a6ad-043e346072be\",\r\n        \"transactionType\":\"oneTime\",\r\n        \"authorizationType\":\"authorization\",\r\n        \"entity\":\"default\",\r\n        \"issuer\":{\r\n          \"authorizationCode\":\"995350\"\r\n        },\r\n        \"scheme\":{\r\n          \"reference\":\"060720116005062\"\r\n        },\r\n        \"paymentInstrument\":{\r\n          \"type\":\"card/network+masked\",\r\n          \"card\":{\r\n            \"number\":{\r\n              \"last4Digits\":\"9224\",\r\n              \"cardBin\":\"483196\"\r\n            },\r\n            \"brand\":\"visa\",\r\n            \"expiryDate\":{\r\n              \"month\":12,\r\n              \"year\":2028\r\n            },\r\n            \"countryCode\":\"SG\",\r\n            \"fundingType\":\"debit\",\r\n            \"issuerName\":\"Helios Bank\",\r\n            \"paymentAccountReference\":\"A00JZ28RKA5EBG470G4AYGV0R5D3D\",\r\n            \"category\":\"consumer\"\r\n          }\r\n        },\r\n        \"value\":{\r\n          \"currency\":\"GBP\",\r\n          \"amount\":250\r\n        },\r\n        \"_links\":{\r\n          \"self\":{\r\n            \"href\":\"/paymentQueries/payments/e638cfbd-5df9-40da-9996-938bb636e299\"\r\n          }\r\n        }\r\n      }\r\n    ]\r\n  }\r\n}\r\n\r\n\r\n"},"children":[]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"dateRange query with pageSize","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/responses/daterange-withpagesize.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\r\n  \"_links\":{\r\n    \"self\":{\r\n      \"href\":\"/paymentQueries/payments?startDate=2025-06-05T21:30:20Z&endDate=2025-07-08T21:30:20Z&pageSize=3\"\r\n    },\r\n    \"next\": {\r\n      \"href\": \"/paymentQueries/payments?startDate=2025-06-13T10:21:28.717Z&endDate=2025-06-15T09:28:08.298Z&paymentId=2a4d37cb-03b1-48c0-a588-dc1a00a83c5f\"\r\n    }      \r\n  },\r\n  \"_embedded\":{\r\n    \"payments\":[\r\n      {\r\n        \"timestamp\":\"2025-06-07T12:09:36.984Z\",\r\n        \"paymentId\":\"pay4u_lHl2jobU5S1T2pWkq10\",\r\n        \"transactionReference\":\"Memory265-13/08/1876\",\r\n        \"transactionType\":\"oneTime\",\r\n        \"authorizationType\":\"authorization\",\r\n        \"entity\":\"default\",\r\n        \"paymentInstrument\":{\r\n          \"type\":\"card/plain\"\r\n        },\r\n        \"value\":{\r\n          \"currency\":\"GBP\",\r\n          \"amount\":500\r\n        },\r\n        \"_links\":{\r\n          \"self\":{\r\n            \"href\":\"/paymentQueries/payments/pay4u_lHl2jobU5S1T2pWkq10\"\r\n          }\r\n        }\r\n      },\r\n      {\r\n        \"timestamp\":\"2025-06-07T12:05:01.134Z\",\r\n        \"paymentId\":\"pay3f7oMDb3cCr2z-e_5L4vt0\",\r\n        \"transactionReference\":\"Memory266\",\r\n        \"transactionType\":\"oneTime\",\r\n        \"authorizationType\":\"sale\",\r\n        \"entity\":\"default\",\r\n        \"issuer\":{\r\n          \"authorizationCode\":\"948295\"\r\n        },\r\n        \"scheme\":{\r\n          \"reference\":\"060720116005062\"\r\n        },\r\n        \"paymentInstrument\":{\r\n          \"type\":\"card/plain+masked\",\r\n          \"card\":{\r\n            \"number\":{\r\n              \"last4Digits\":\"1111\",\r\n              \"cardBin\":\"444433\"\r\n            },\r\n            \"brand\":\"visa\",\r\n            \"expiryDate\":{\r\n              \"month\":5,\r\n              \"year\":2035\r\n            },\r\n            \"fundingType\":\"credit\",\r\n            \"issuerName\":\"A Card Issuer\",\r\n            \"paymentAccountReference\":\"Q1HJZ28RKA1EBL470G9XYG90R5D3E\",\r\n            \"category\":\"consumer\"\r\n          }\r\n        },\r\n        \"value\":{\r\n          \"currency\":\"GBP\",\r\n          \"amount\":500\r\n        },\r\n        \"_links\":{\r\n          \"self\":{\r\n            \"href\":\"/paymentQueries/payments/pay3f7oMDb3cCr2z-e_5L4vt0\"\r\n          }\r\n        }\r\n      },\r\n      {\r\n        \"timestamp\":\"2025-06-10T10:22:19.844Z\",\r\n        \"paymentId\":\"paydf5o-Db5cGREs-vT7L4vC0\",\r\n        \"transactionReference\":\"897b8357-0c45-4529-93ce-136dbeac562f\",\r\n        \"transactionType\":\"oneTime\",\r\n        \"authorizationType\":\"authorization\",\r\n        \"entity\":\"default\",\r\n        \"issuer\":{\r\n          \"authorizationCode\":\"478296\"\r\n        },\r\n        \"scheme\":{\r\n          \"reference\":\"060720116005062\"\r\n        },\r\n        \"paymentInstrument\":{\r\n          \"type\":\"card/network+masked\",\r\n          \"card\":{\r\n            \"number\":{\r\n              \"last4Digits\":\"9224\",\r\n              \"cardBin\":\"483196\"\r\n            },\r\n            \"brand\":\"visa\",\r\n            \"expiryDate\":{\r\n              \"month\":12,\r\n              \"year\":2028\r\n            },\r\n            \"countryCode\":\"SG\",\r\n            \"fundingType\":\"debit\",\r\n            \"issuerName\":\"Helios Bank\",\r\n            \"paymentAccountReference\":\"A00JZ28RKA5EBG470G4AYGV0R5D3D\",\r\n            \"category\":\"consumer\"\r\n          }\r\n        },\r\n        \"value\":{\r\n          \"currency\":\"GBP\",\r\n          \"amount\":250\r\n        },\r\n        \"_links\":{\r\n          \"self\":{\r\n            \"href\":\"/paymentQueries/payments/paydf5o-Db5cGREs-vT7L4vC0\"\r\n          }\r\n        }\r\n      }\r\n    ]\r\n  }\r\n}\r\n\r\n"},"children":[]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"dateRange query with currency filter","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/responses/daterange-currency.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\r\n  \"_links\":{\r\n    \"self\":{\r\n      \"href\":\"/paymentQueries/payments?startDate=2025-06-05T21:30:20Z&endDate=2025-07-08T21:30:20Z&currency=GBP&pageSize=2\"\r\n    },\r\n    \"next\": {\r\n      \"href\": \"/paymentQueries/payments?startDate=2025-06-06T14:21:20Z&endDate=2025-06-15T09:28:08.298Z&paymentId=payvu0l-laj9bUfU3a2pRkq20\"\r\n    }      \r\n  },\r\n  \"_embedded\":{\r\n    \"payments\":[\r\n      {\r\n        \"timestamp\":\"2025-06-07T12:05:01.134Z\",\r\n        \"paymentId\":\"pay3f7oMDb3cCr2z-e_5L4vt0\",\r\n        \"transactionReference\":\"Memory266\",\r\n        \"transactionType\":\"oneTime\",\r\n        \"authorizationType\":\"sale\",\r\n        \"entity\":\"default\",\r\n        \"issuer\":{\r\n          \"authorizationCode\":\"948295\"\r\n        },\r\n        \"scheme\":{\r\n          \"reference\":\"060720116005062\"\r\n        },\r\n        \"paymentInstrument\":{\r\n          \"type\":\"card/plain+masked\",\r\n          \"card\":{\r\n            \"number\":{\r\n              \"last4Digits\":\"1111\",\r\n              \"cardBin\":\"444433\"\r\n            },\r\n            \"brand\":\"visa\",\r\n            \"expiryDate\":{\r\n              \"month\":5,\r\n              \"year\":2035\r\n            },\r\n            \"fundingType\":\"credit\",\r\n            \"issuerName\":\"A Card Issuer\",\r\n            \"paymentAccountReference\":\"Q1HJZ28RKA1EBL470G9XYG90R5D3E\",\r\n            \"category\":\"consumer\"\r\n          }\r\n        },\r\n        \"value\":{\r\n          \"currency\":\"GBP\",\r\n          \"amount\":500\r\n        },\r\n        \"_links\":{\r\n          \"self\":{\r\n            \"href\":\"/paymentQueries/payments/pay3f7oMDb3cCr2z-e_5L4vt0\"\r\n          }\r\n        }\r\n      },\r\n      {\r\n        \"timestamp\":\"2025-06-10T10:22:19.844Z\",\r\n        \"paymentId\":\"paydf5o-Db5cGREs-vT7L4vC0\",\r\n        \"transactionReference\":\"897b8357-0c45-4529-93ce-136dbeac562f\",\r\n        \"transactionType\":\"oneTime\",\r\n        \"authorizationType\":\"authorization\",\r\n        \"entity\":\"default\",\r\n        \"issuer\":{\r\n          \"authorizationCode\":\"478296\"\r\n        },\r\n        \"scheme\":{\r\n          \"reference\":\"060720116005062\"\r\n        },\r\n        \"paymentInstrument\":{\r\n          \"type\":\"card/network+masked\",\r\n          \"card\":{\r\n            \"number\":{\r\n              \"last4Digits\":\"9224\",\r\n              \"cardBin\":\"483196\"\r\n            },\r\n            \"brand\":\"visa\",\r\n            \"expiryDate\":{\r\n              \"month\":12,\r\n              \"year\":2028\r\n            },\r\n            \"countryCode\":\"SG\",\r\n            \"fundingType\":\"debit\",\r\n            \"issuerName\":\"Helios Bank\",\r\n            \"paymentAccountReference\":\"A00JZ28RKA5EBG470G4AYGV0R5D3D\",\r\n            \"category\":\"consumer\"\r\n          }\r\n        },\r\n        \"value\":{\r\n          \"currency\":\"GBP\",\r\n          \"amount\":250\r\n        },\r\n        \"_links\":{\r\n          \"self\":{\r\n            \"href\":\"/paymentQueries/payments/paydf5o-Db5cGREs-vT7L4vC0\"\r\n          }\r\n        }\r\n      }\r\n    ]\r\n  }\r\n}\r\n\r\n"},"children":[]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"error","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/responses/invaliddaterange.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\r\n    \"errorName\": \"startDateTooOld\",\r\n    \"message\": \"Provided start date must not be older than 1 year.\"\r\n}"},"children":[]}]}]}]},"headings":[{"value":"Date range queries","id":"date-range-queries","depth":2},{"value":"Date range request","id":"date-range-request","depth":3},{"value":"Example","id":"example","depth":4},{"value":"Filter by currency","id":"filter-by-currency","depth":3},{"value":"Example","id":"example-1","depth":4},{"value":"Filter by minAmount, maxAmount","id":"filter-by-minamount-maxamount","depth":3},{"value":"Example","id":"example-2","depth":4},{"value":"Filter by last four digits","id":"filter-by-last-four-digits","depth":3},{"value":"Example","id":"example-3","depth":4},{"value":"Filter by payment event","id":"filter-by-payment-event","depth":3},{"value":"Example","id":"example-4","depth":4},{"value":"Filter by entity references","id":"filter-by-entity-references","depth":3},{"value":"Example","id":"example-5","depth":4},{"value":"Parameter descriptions","id":"parameter-descriptions","depth":3},{"value":"Response","id":"response","depth":3},{"value":"Response schema","id":"response-schema","depth":3},{"value":"Response examples","id":"response-examples","depth":3}],"frontmatter":{"seo":{"title":"Date range queries"}},"lastModified":"2025-09-22T09:15:26.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/payment-queries/query-by-date-range","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}