The tip included in the transaction. Only present when the transaction has a tip; omitted when there is no tip. The top-level amount and isoAmount already include the tip, so the amount without tip is isoAmount - tip.isoAmount.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Paybyrd","colors":{"primary":"#6319F0","light":"#A4ADFF","dark":"#6319F0"},"logo":{"light":"https://mintcdn.com/paybyrd/X3OHHz6EJVWhNTO3/images/logo-light-full.png?fit=max\u0026auto=format\u0026n=X3OHHz6EJVWhNTO3\u0026q=85\u0026s=35a8f83493759c89b1ee80db71265676","dark":"https://mintcdn.com/paybyrd/X3OHHz6EJVWhNTO3/images/logo-dark-full.png?fit=max\u0026auto=format\u0026n=X3OHHz6EJVWhNTO3\u0026q=85\u0026s=7d1a41429a1708ce79ff23f45f296959"},"favicon":"https://mintcdn.com/paybyrd/GOPy9l9hDJ70VNa1/images/Avatar-Square.png?fit=max\u0026auto=format\u0026n=GOPy9l9hDJ70VNa1\u0026q=85\u0026s=78f2ae4b46f5e013c30d747f9889aa80","background":{"color":{"light":"#f2f2f2","dark":"#2e2e2e"}},"navbar":{"links":[{"href":"https://www.paybyrd.com/","label":"Paybyrd"},{"href":"https://status.paybyrd.com/","label":"Status"}],"primary":{"type":"button","label":"Get started with Paybyrd","href":"https://backoffice.paybyrd.com/"}},"footer":{"socials":{"website":"https://www.paybyrd.com/"},"links":[{"header":"Mobile","items":[{"label":"Get the dashboard app","href":"/get-started/start-building"}]}]},"fonts":{"family":"DM Sans","weight":400,"source":"https://fonts.gstatic.com/s/dmsans/v17/rP2Yp2ywxg089UriI5-g7M8btVsD8Ck0q7u0-K6z8GXhnU0.woff2","format":"woff2"},"icons":{"library":"lucide"},"integrations":{"ga4":{"measurementId":"G-7PQTSPLP9K"}},"contextual":{"options":["copy","view","vscode","chatgpt","claude","mcp","add-mcp"],"display":"toc"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"paybyrd","hasAudioNarration":false,"actualSubdomain":"paybyrd","customDomains":["docs.paybyrd.com"],"gitSource":{"type":"github","owner":"paybyrd","repo":"paybyrd-api-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adfac3b1ec88bdf5ff40127","collectionId":"99135064-27cc-4e8f-a205-a81518acd153","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adfac3b1ec88bdf5ff40127"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6adfac3b1ec88bdf5ff40127","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"API Reference","count":30},{"language":"default","tag":"Payments API","count":26},{"language":"default","tag":"Payments","count":23},{"language":"default","tag":"Integrations","count":14},{"language":"default","tag":"Accept Payments","count":13},{"language":"default","tag":"Get started","count":8},{"language":"default","tag":"Manage Payments","count":8},{"language":"default","tag":"Transactions","count":8},{"language":"default","tag":"Webhooks","count":8},{"language":"default","tag":"Point of Sale","count":6}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/transactions/query","slug":"/api-reference/transactions/query","pageMetadata":{"title":"Query","description":"","deprecated":false,"version":null,"openapi":"/openapi.yml get /api/v2/transactions/{transactionId}","href":"/api-reference/transactions/query","autogeneratedByOpenApi":true},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Query","description":"","deprecated":false,"version":null,"openapi":"/openapi.yml get /api/v2/transactions/{transactionId}","href":"/api-reference/transactions/query","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Transactions"],"summary":"Query","description":"","operationId":"api-transactions-query","parameters":["c712a4c0-18c5-44d5-8ae2-2fce4f34316b"],"responses":{"200":"cb5d7265-5230-4359-93e9-a960c80e6249"},"deprecated":false,"method":"get","type":"path","servers":["72fd1cc1-663b-467d-beb5-358ad27a2640"],"security":["25788e77-5004-4d78-a9a1-daae3364455d"],"path":"/api/v2/transactions/{transactionId}","baseUrlOptions":["https://gateway.paybyrd.com"],"title":"Query","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"c712a4c0-18c5-44d5-8ae2-2fce4f34316b":{"name":"transactionId","in":"path","description":"The transaction identifier generated by Paybyrd.","schema":{"type":"string","isRequired":true,"description":"The transaction identifier generated by Paybyrd.","uniqueKey":"","typeLabel":"string"},"required":true}},"responses":{"cb5d7265-5230-4359-93e9-a960c80e6249":{"description":"200","content":{"application/json":{"examples":{"Result with shift and tip":{"title":"Result with shift and tip","value":{"amount":"42.50","isoAmount":4250,"brand":"VISA","code":"BYRD200","createdDate":"2026-05-12T18:04:38Z","currency":"EUR","description":"Operation successfully completed","externalCustomIdentifier":"8cb922ee-01cd-453d-90b9-b377e4f1d38b","externalSessionIdentifier":"f31a836d-42c6-41c7-b0d0-109d64efb133","externalTransactionIdentifier":"b1b2cf19-e9fe-4b7c-be1a-a12f0f8899f2","index":0,"initiatedFrom":"POS","operationType":"Payment","personId":10,"referencedTransactions":[],"status":"Success","subscriptionGuid":"5b16391d-b8b8-45c9-8aa3-4f6f3ce5a656","transactionDate":"2026-05-12T18:04:38Z","transactionId":"8cb922ee-01cd-453d-90b9-b377e4f1c3cb","acquirerResponseCode":"00","acquirerResponseMessage":"Authorized","shiftCode":"SHIFT-0001","tip":{"isoAmount":250,"amount":"2.50"}}},"Result without shift and tip":{"title":"Result without shift and tip","value":{"amount":"13.00","isoAmount":1300,"brand":"MASTER","code":"BYRD200","createdDate":"2021-06-01T01:21:41Z","currency":"EUR","description":"Operation successfully completed","externalCustomIdentifier":"33ff7bd9-1d6e-4bd0-bc2d-a4aef8614972","externalSessionIdentifier":"bda69b31-8a81-4779-801e-f7d6e5d3fa47","externalTransactionIdentifier":"dc3f1e75-0e4b-49c5-a68e-5adea241e749","index":0,"initiatedFrom":"PayByLink","operationType":"Capture","personId":10,"referencedTransactions":[{"amount":"13.00","isoAmount":1300,"capturedDate":"2021-05-31T22:04:31Z","createdDate":"2021-05-31T22:01:57Z","currency":"EUR","externalCustomIdentifier":"c9a625d4-d968-47a0-b237-e5d4f31dfcd4","index":1,"initiatedFrom":"PayByLink","operationType":"PreAuth","orderRef":"AMZ1962","personId":10,"subscriptionGuid":"5b16391d-b8b8-45c9-8aa3-4f6f3ce5a656","terminalId":"EM30X4X5X0","transactionDate":"2021-05-31T22:01:57Z","transactionId":"c9a625d4-d968-47a0-b237-e5d4f31dfcd4"}],"status":"Success","subscriptionGuid":"5b16391d-b8b8-45c9-8aa3-4f6f3ce5a656","transactionDate":"2021-06-01T01:21:41Z","transactionId":"33ff7bd9-1d6e-4bd0-bc2d-a4aef8614972","acquirerResponseCode":"00-I","acquirerResponseMessage":"Authorized","acquirerEntity":"11854","acquirerReference":"999999935"}}},"schema":{"type":"object","properties":{"amount":{"type":"string","description":"The transaction amount, including the tip when there is one.","example":"-1.00","uniqueKey":"amount","typeLabel":"string"},"isoAmount":{"type":"integer","description":"The transaction amount in minor units, including the tip when there is one.","example":-100,"format":"int64","uniqueKey":"isoAmount","typeLabel":"integer\u003cint64>"},"brand":{"type":"string","description":"The transaction brand.","example":"MASTER","uniqueKey":"brand","typeLabel":"string"},"code":{"type":"string","description":"Represents the Paybyrd code of the web request. To see more details check in [Return Codes](ref:appendix-return-codes) page.","example":"BYRD200","enum":["BYRD010","BYRD200","BYRD201","BYRD203","BYRD205","BYRD206","BYRD207","BYRD208","BYRD230","BYRD231","BYRD240","BYRD290","BYRD291","BYRD292","BYRD294","BYRD299","BYRD401","BYRD403","BYRD900","BYRD901","BYRD999"],"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"createdDate":{"type":"string","example":"2021-06-01T01:21:41Z","uniqueKey":"createdDate","typeLabel":"string"},"currency":{"type":"string","example":"EUR","uniqueKey":"currency","typeLabel":"string"},"description":{"type":"string","example":"Operation successfully completed","description":"Represents a textually the description of the Paybyrd code of the web request. To see more details check in [Return Codes](ref:appendix-return-codes) page","enum":["Request accepted","Operation successfully completed","Payment being processed. Waiting for shopper","An error occurred while processing the payment. Please query the transaction to confirm its status","Operation rejected","Operation blocked by velocity","Pending redirect","Payment canceled by the shopper","Payment already refunded","The refund amount exceeds the remaining balance of the original payment","Token is expired","An error occurred while pre processing the transaction. Please review your request and try again","An error occurred during while preparing transaction for acquiring. Please review your request and try again","No payment methods available for this operation. Please contact Paybyrd's support","Transaction could not be updated. Please review your request and try again","Operation could not be completed. Please review your request and try again","Resource access is forbidden","Resource access unauthorized","Invalid input","Resource not found","Operation failed"],"uniqueKey":"description","typeLabel":"enum\u003cstring>"},"externalCustomIdentifier":{"type":"string","example":"33ff7bd9-1d6e-4bd0-bc2d-a4aef8614972","uniqueKey":"externalCustomIdentifier","typeLabel":"string"},"externalSessionIdentifier":{"type":"string","example":"bda69b31-8a81-4779-801e-f7d6e5d3fa47","uniqueKey":"externalSessionIdentifier","typeLabel":"string"},"externalTransactionIdentifier":{"type":"string","example":"dc3f1e75-0e4b-49c5-a68e-5adea241e749","uniqueKey":"externalTransactionIdentifier","typeLabel":"string"},"index":{"type":"integer","description":"This value represents the transaction order in the timeline of the transaction.","example":4,"default":0,"uniqueKey":"index","typeLabel":"integer"},"initiatedFrom":{"type":"string","description":"Defines where the transaction was started from.","example":"Server","uniqueKey":"initiatedFrom","typeLabel":"string"},"operationType":{"type":"string","description":"Identifies what a kind of transaction is it.","example":"Refund","uniqueKey":"operationType","typeLabel":"string"},"personId":{"type":"integer","description":"Identify which merchant is the transaction owner.","example":10,"default":0,"uniqueKey":"personId","typeLabel":"integer"},"referencedTransactions":{"type":"array","items":{"type":"object","properties":{"transactionId":{"type":"string","description":"The unique identifier of the transaction.","example":"c9a625d4-d968-47a0-b237-e5d4f31dfcd4","format":"guid","uniqueKey":"referencedTransactions.items.[INDEX].transactionId","typeLabel":"string\u003cguid>"},"attempt":{"type":"integer","description":"The number of attempt that this transaction represents when associated to an order","example":1,"format":"int32","uniqueKey":"referencedTransactions.items.[INDEX].attempt","typeLabel":"integer\u003cint32>"},"index":{"type":"integer","description":"The position of this transaction in the list. You can order by this property if needed.","example":1,"uniqueKey":"referencedTransactions.items.[INDEX].index","typeLabel":"integer"},"amount":{"type":"string","description":"The transaction amount.","example":"13.00","uniqueKey":"referencedTransactions.items.[INDEX].amount","typeLabel":"string"},"isoAmount":{"type":"integer","description":"The transaction amount.","example":1300,"format":"int64","uniqueKey":"referencedTransactions.items.[INDEX].isoAmount","typeLabel":"integer\u003cint64>"},"acquirer":{"type":"string","description":"Indicates which acquirer the transaction was processed","example":"VALITOR","enum":["SIBS","VALITOR","BAMBORA","PPRO","PAYPAY","REDE","PROXYPAY","PAYPAL","PAYWORKS","FLOA","SIMULATED"],"uniqueKey":"referencedTransactions.items.[INDEX].acquirer","typeLabel":"enum\u003cstring>"},"brand":{"type":"string","description":"Represents the payment method brand of the transaction.","example":"VISA","enum":["VISA","MASTER","AMEX","DINERS","DISCOVER","JCB","ELO","VPAY","DANKORT","MBWAY","SIBS_MULTIBANCO","IDEAL","PAYPAL","MULTICAIXA_REF","SEPA","FLOA1XD","FLOA3X","FLOA4X"],"uniqueKey":"referencedTransactions.items.[INDEX].brand","typeLabel":"enum\u003cstring>"},"paymentMethod":{"type":"string","description":"Represents the payment method of the transaction.","example":"CARD","enum":["CARD","MBWAY","SIBS_MULTIBANCO","IDEAL","PAYPAL","MULTICAIXA_REF","SEPA","FLOA1XD","FLOA3X","FLOA4X"],"uniqueKey":"referencedTransactions.items.[INDEX].paymentMethod","typeLabel":"enum\u003cstring>"},"capturedDate":{"type":"string","example":"2021-05-31T22:04:31Z","uniqueKey":"referencedTransactions.items.[INDEX].capturedDate","typeLabel":"string"},"createdDate":{"type":"string","example":"2021-05-31T22:01:57Z","uniqueKey":"referencedTransactions.items.[INDEX].createdDate","typeLabel":"string"},"initiatedFrom":{"type":"string","description":"Represents the payment method of the transaction.","example":"CARD","enum":["CARD","MBWAY","SIBS_MULTIBANCO","IDEAL","PAYPAL","MULTICAIXA_REF","SEPA","FLOA1XD","FLOA3X","FLOA4X"],"uniqueKey":"referencedTransactions.items.[INDEX].initiatedFrom","typeLabel":"enum\u003cstring>"},"currency":{"type":"string","example":"EUR","uniqueKey":"referencedTransactions.items.[INDEX].currency","typeLabel":"string"},"externalCustomIdentifier":{"type":"string","example":"c9a625d4-d968-47a0-b237-e5d4f31dfcd4","uniqueKey":"referencedTransactions.items.[INDEX].externalCustomIdentifier","typeLabel":"string"},"operationType":{"type":"string","example":"PreAuth","uniqueKey":"referencedTransactions.items.[INDEX].operationType","typeLabel":"string"},"orderRef":{"type":"string","example":"AMZ1962","uniqueKey":"referencedTransactions.items.[INDEX].orderRef","typeLabel":"string"},"personId":{"type":"integer","example":10,"default":0,"uniqueKey":"referencedTransactions.items.[INDEX].personId","typeLabel":"integer"},"status":{"type":"string","example":"Paid","uniqueKey":"referencedTransactions.items.[INDEX].status","typeLabel":"string"},"subscriptionGuid":{"type":"string","example":"5b16391d-b8b8-45c9-8aa3-4f6f3ce5a656","uniqueKey":"referencedTransactions.items.[INDEX].subscriptionGuid","typeLabel":"string"},"terminalId":{"type":"string","example":"EM30X4X5X0","uniqueKey":"referencedTransactions.items.[INDEX].terminalId","typeLabel":"string"},"transactionDate":{"type":"string","example":"2021-05-31T22:01:57Z","uniqueKey":"referencedTransactions.items.[INDEX].transactionDate","typeLabel":"string"},"multicaixaExpress":{"type":"object","description":"Multicaixa Express payment details. Only present when the transaction brand is MULTICAIXAEXPRESS.","properties":{"deeplink":{"type":"string","format":"uri","description":"Direct deeplink for the MultiCaixa Express app.","example":"mcxwallet://purchase?qrref=000201010212260700032205203742530497325406300.105802AO5908ProxyPay6006Luanda61081000-10062430532fe4eeddd078343c391d6d10721233a3207034446304F577","uniqueKey":"referencedTransactions.items.[INDEX].multicaixaExpress.deeplink","typeLabel":"string\u003curi>"},"deeplinkRedirect":{"type":"string","format":"uri","description":"Redirect URL for mobile and browser flows to the MultiCaixa Express app.","example":"https://api.sandbox.proxypay.co.ao/deeplink/LTvDt6U2WiFU0Ds_TScsbSbULbbCIbB2zrZsAS3r96hq...","uniqueKey":"referencedTransactions.items.[INDEX].multicaixaExpress.deeplinkRedirect","typeLabel":"string\u003curi>"},"qrCodeUrl":{"type":"string","format":"uri","description":"QR Code image URL.","example":"https://api.sandbox.proxypay.co.ao/qrcode/LTvDt6U2WiFU0Ds_TScsbSbULbbCIbB2zrZsAS3r96hq...","uniqueKey":"referencedTransactions.items.[INDEX].multicaixaExpress.qrCodeUrl","typeLabel":"string\u003curi>"},"expiresAt":{"type":"string","format":"date-time","description":"Payment expiration timestamp in ISO 8601 format.","example":"2026-05-19T18:00:37","uniqueKey":"referencedTransactions.items.[INDEX].multicaixaExpress.expiresAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"referencedTransactions.items.[INDEX].multicaixaExpress","typeLabel":"object"}},"uniqueKey":"referencedTransactions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"referencedTransactions","typeLabel":"object[]"},"status":{"type":"string","example":"Success","uniqueKey":"status","typeLabel":"string"},"subscriptionGuid":{"type":"string","example":"5b16391d-b8b8-45c9-8aa3-4f6f3ce5a656","uniqueKey":"subscriptionGuid","typeLabel":"string"},"transactionDate":{"type":"string","example":"2021-06-01T01:21:41Z","uniqueKey":"transactionDate","typeLabel":"string"},"transactionId":{"type":"string","example":"33ff7bd9-1d6e-4bd0-bc2d-a4aef8614972","uniqueKey":"transactionId","typeLabel":"string"},"fingerPrint":{"type":"string","description":"This field represents the shopper FingerPrint in the Paybyrd's systems.","example":"V0010015818248598768349855188","uniqueKey":"fingerPrint","typeLabel":"string"},"acquirerResponseCode":{"type":"string","description":"The authorization host response code.","example":"00-I","uniqueKey":"acquirerResponseCode","typeLabel":"string"},"acquirerResponseMessage":{"type":"string","description":"The authorization host response message","example":"Authorized","uniqueKey":"acquirerResponseMessage","typeLabel":"string"},"acquirerEntity":{"type":"string","description":"The acquirer entity","example":11854,"uniqueKey":"acquirerEntity","typeLabel":"string"},"acquirerReference":{"type":"string","description":"The acquirer reference","example":999999935,"uniqueKey":"acquirerReference","typeLabel":"string"},"multicaixaExpress":{"type":"object","description":"Multicaixa Express payment details. Only present when the transaction brand is MULTICAIXAEXPRESS.","properties":{"deeplink":{"type":"string","format":"uri","description":"Deeplink used by Checkout to redirect the user to the Multicaixa Express app.","example":"mcxwallet://purchase?qrref=000201010212260700032205203742530497325406300.105802AO5908ProxyPay6006Luanda61081000-10062430532fe4eeddd078343c391d6d10721233a3207034446304F577","uniqueKey":"multicaixaExpress.deeplink","typeLabel":"string\u003curi>"},"deeplinkRedirect":{"type":"string","format":"uri","description":"Web URL fallback used by Checkout to redirect the user to the Multicaixa Express app.","example":"https://api.sandbox.proxypay.co.ao/deeplink/LTvDt6U2WiFU0Ds_TScsbSbULbbCIbB2zrZsAS3r96hq...","uniqueKey":"multicaixaExpress.deeplinkRedirect","typeLabel":"string\u003curi>"},"qrCodeUrl":{"type":"string","format":"uri","description":"URL of the QR code image used by Checkout for the Multicaixa Express payment.","example":"https://api.sandbox.proxypay.co.ao/qrcode/LTvDt6U2WiFU0Ds_TScsbSbULbbCIbB2zrZsAS3r96hq...","uniqueKey":"multicaixaExpress.qrCodeUrl","typeLabel":"string\u003curi>"},"expiresAt":{"type":"string","format":"date-time","description":"Expiration date and time of the payment request in ISO 8601 format.","example":"2026-05-19T18:00:37","uniqueKey":"multicaixaExpress.expiresAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"multicaixaExpress","typeLabel":"object"},"shiftCode":{"type":"string","description":"The code of the POS shift the transaction belongs to. Only present when the transaction is linked to a shift; omitted when there is no shift.","example":"SHIFT-0001","uniqueKey":"shiftCode","typeLabel":"string"},"tip":{"type":"object","description":"The tip included in the transaction. Only present when the transaction has a tip; omitted when there is no tip. The top-level `amount` and `isoAmount` already include the tip, so the amount without tip is `isoAmount - tip.isoAmount`.","properties":{"isoAmount":{"type":"integer","description":"The tip amount in minor units of the transaction currency.","example":250,"format":"int64","uniqueKey":"tip.isoAmount","typeLabel":"integer\u003cint64>"},"amount":{"type":"string","description":"The tip amount in major units, formatted like the top-level `amount` using the currency exponent (for example, EUR 250 is \"2.50\", JPY 300 is \"300\" and BHD 1250 is \"1.250\").","example":"2.50","uniqueKey":"tip.amount","typeLabel":"string"}},"uniqueKey":"tip","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"25788e77-5004-4d78-a9a1-daae3364455d":{"authByApiKey":{"type":"apiKey","in":"header","name":"x-api-key","scopes":[],"schemeName":"authByApiKey"}}},"servers":{"72fd1cc1-663b-467d-beb5-358ad27a2640":{"url":"https://gateway.paybyrd.com","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","scopes":[],"schemeName":"authByApiKey"},"schema":{"title":"x-api-key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"authByApiKey","name":"x-api-key"}],"title":"authByApiKey"}]},"originalFileLocation":"openapi.yml"},"subdomain":"paybyrd","siteName":"Paybyrd","title":"Query - Paybyrd","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-26T19:38:40.488Z","originalFileLocation":"api-reference/transactions/query.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Paybyrd\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/paybyrd/ZQOx_ixbIt0VLR4c/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/paybyrd/ZQOx_ixbIt0VLR4c/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/paybyrd/ZQOx_ixbIt0VLR4c/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/paybyrd/ZQOx_ixbIt0VLR4c/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/paybyrd/ZQOx_ixbIt0VLR4c/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/paybyrd/ZQOx_ixbIt0VLR4c/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/paybyrd/ZQOx_ixbIt0VLR4c/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/paybyrd/ZQOx_ixbIt0VLR4c/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/paybyrd/ZQOx_ixbIt0VLR4c/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Query - Paybyrd\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Paybyrd\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.paybyrd.com/api-reference/transactions/query\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://paybyrd.mintlify.app/_mintlify/api/og/v2?division=Transactions\u0026amp;title=Query\u0026amp;theme=482e40cfd6999bc2608c5e34\u0026amp;signature=a3beaed3953fb4c308fd9b546e1d180c5e7be6f1d205375d29a00744e8c5a047\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Query - Paybyrd\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://paybyrd.mintlify.app/_mintlify/api/og/v2?division=Transactions\u0026amp;title=Query\u0026amp;theme=482e40cfd6999bc2608c5e34\u0026amp;signature=a3beaed3953fb4c308fd9b546e1d180c5e7be6f1d205375d29a00744e8c5a047\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/paybyrd/ZQOx_ixbIt0VLR4c/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Paybyrd\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6319F0\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.paybyrd.com/api-reference/transactions/query\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/transactions/query.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.paybyrd.com/#organization\",\"name\":\"Paybyrd\",\"url\":\"https://docs.paybyrd.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/paybyrd/X3OHHz6EJVWhNTO3/images/logo-light-full.png?fit=max\u0026auto=format\u0026n=X3OHHz6EJVWhNTO3\u0026q=85\u0026s=35a8f83493759c89b1ee80db71265676\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.paybyrd.com#website\",\"name\":\"Paybyrd\",\"url\":\"https://docs.paybyrd.com\",\"publisher\":{\"@id\":\"https://docs.paybyrd.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.paybyrd.com/api-reference/transactions/query#webpage\",\"url\":\"https://docs.paybyrd.com/api-reference/transactions/query\",\"name\":\"Query\",\"dateModified\":\"2026-10-26T19:38:40.488Z\",\"isPartOf\":{\"@id\":\"https://docs.paybyrd.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.paybyrd.com/api-reference/transactions/query#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.paybyrd.com/api-reference/transactions/query#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Payments API\",\"item\":\"https://docs.paybyrd.com/api-reference/payments/create-payment\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Transactions\",\"item\":\"https://docs.paybyrd.com/api-reference/transactions/refund\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Query\",\"item\":\"https://docs.paybyrd.com/api-reference/transactions/query\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.paybyrd.com/api-reference/transactions/query#apireference\",\"headline\":\"Query\",\"name\":\"Query\",\"url\":\"https://docs.paybyrd.com/api-reference/transactions/query\",\"mainEntityOfPage\":{\"@id\":\"https://docs.paybyrd.com/api-reference/transactions/query#webpage\"},\"dateModified\":\"2026-10-26T19:38:40.488Z\",\"publisher\":{\"@id\":\"https://docs.paybyrd.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.paybyrd.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Paybyrd\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Paybyrd","nav":{"global":null,"tabs":[{"tab":"Get started","pages":[{"title":"Get started","href":"/introduction"}]},{"tab":"Payments","pages":[{"title":"Payments","href":"/accept-payments/how-it-works"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/embed/checkout"}]},{"tab":"API Reference","groups":[{"group":"API introduction","pages":[{"title":"API intro","href":"/api-reference/api-intro"},{"title":"Response code reference","href":"/api-reference/api-code-reference"},{"title":"Webhook API","href":"/api-reference/webhooks"}]},{"group":"Payments API","expanded":true,"pages":[{"group":"Payments","pages":[{"title":"Create Payment","deprecated":false,"version":null,"openapi":"/openapi.yml post /api/v2/payment","href":"/api-reference/payments/create-payment"},{"title":"Finish two-step card payment","deprecated":false,"version":null,"openapi":"/openapi.yml post /api/v2/payment/{transactionId}/pay","href":"/api-reference/payments/finish-two-step-card-payment"}]},{"group":"Transactions","pages":[{"title":"Refund","deprecated":false,"version":null,"openapi":"/openapi.yml post /api/v2/refund/{transactionId}","href":"/api-reference/transactions/refund"},{"title":"Release","deprecated":false,"version":null,"openapi":"/openapi.yml post /api/v2/release/{transactionId}","href":"/api-reference/transactions/release"},{"title":"Capture","deprecated":false,"version":null,"openapi":"/openapi.yml post /api/v2/capture/{transactionId}","href":"/api-reference/transactions/capture"},{"title":"Cancel","deprecated":false,"version":null,"openapi":"/openapi.yml post /api/v2/cancel/{transactionId}","href":"/api-reference/transactions/cancel"},{"title":"Adjust","description":"Changes the reserved amount before the capture occurs.","deprecated":false,"version":null,"openapi":"/openapi.yml post /api/v2/adjust/{transactionId}","href":"/api-reference/transactions/adjust"},{"title":"Query","deprecated":false,"version":null,"openapi":"/openapi.yml get /api/v2/transactions/{transactionId}","href":"/api-reference/transactions/query"},{"title":"Receipt","description":"Retrieve receipt data for POS transactions","deprecated":false,"version":null,"openapi":"/openapi.yml get /api/v2/transactions/{transactionId}/receipt","href":"/api-reference/transactions/receipt"},{"title":"Query by acquirer custom identifier","deprecated":false,"version":null,"openapi":"/openapi.yml get /api/v2/transactions?acquirerCustomId=${customIdentifier}","href":"/api-reference/transactions/query-by-acquirer-custom-identifier"}]},{"group":"Webhooks","pages":[{"title":"Setup URL","deprecated":true,"version":null,"openapi":"/openapi.yml put /api/v1/webhook","href":"/api-reference/webhooks/setup-url"},{"title":"Gets a webhook settings by its Id","deprecated":null,"version":null,"openapi":"/openapi.yml get /api/v2/webhooks/{webhookId}","href":"/api-reference/webhooks/gets-a-webhook-settings-by-its-id"},{"title":"Gets all webhook settings","deprecated":null,"version":null,"openapi":"/openapi.yml get /api/v2/webhooks","href":"/api-reference/webhooks/gets-all-webhook-settings"},{"title":"Creates a new webhook setting","deprecated":null,"version":null,"openapi":"/openapi.yml post /api/v2/webhooks","href":"/api-reference/webhooks/creates-a-new-webhook-setting"},{"title":"Updates a webhook setting url","deprecated":null,"version":null,"openapi":"/openapi.yml patch /api/v2/webhooks/{webhookId}/url","href":"/api-reference/webhooks/updates-a-webhook-setting-url"},{"title":"Enables a webhook setting","deprecated":null,"version":null,"openapi":"/openapi.yml post /api/v2/webhooks/{webhookId}/enable","href":"/api-reference/webhooks/enables-a-webhook-setting"},{"title":"Disables a webhook setting","deprecated":null,"version":null,"openapi":"/openapi.yml post /api/v2/webhooks/{webhookId}/disable","href":"/api-reference/webhooks/disables-a-webhook-setting"},{"title":"Updates a webhook setting url","deprecated":null,"version":null,"openapi":"/openapi.yml patch /api/v2/webhooks/{webhookId}/credentials","href":"/api-reference/webhooks/updates-a-webhook-setting-url-1"}]},{"group":"Paybylink","pages":[{"title":"resend","deprecated":false,"version":null,"openapi":"/openapi.yml post /api/v2/paybylink/{orderId}/resend","href":"/api-reference/paybylink/resend"}]},{"group":"Subscription","pages":[{"title":"Create","deprecated":false,"version":null,"openapi":"/openapi.yml post /api/v2/subscriptions","href":"/api-reference/subscription/create"}]},{"group":"Orders","pages":[{"title":"Create Order","deprecated":false,"version":null,"openapi":"/openapi.yml post /api/v2/orders","href":"/api-reference/orders/create-order"},{"title":"Query Order","deprecated":false,"version":null,"openapi":"/openapi.yml get /api/v2/orders/{orderId}","href":"/api-reference/orders/query-order"},{"title":"Cancel Order","deprecated":false,"version":null,"openapi":"/openapi.yml delete /api/v2/orders/{orderId}","href":"/api-reference/orders/cancel-order"}]},{"group":"Tokenization","pages":[{"title":"Get Token by reference","deprecated":false,"version":null,"openapi":"/openapi.yml get /api/v2/tokens","href":"/api-reference/tokenization/get-token-by-reference"},{"title":"Create Token","deprecated":false,"version":null,"openapi":"/openapi.yml post /api/v2/tokens","href":"/api-reference/tokenization/create-token"},{"title":"Get Token By Id","deprecated":false,"version":null,"openapi":"/openapi.yml get /api/v2/tokens/{tokenId}","href":"/api-reference/tokenization/get-token-by-id"}]}]},{"group":"Settlements API","pages":[{"group":"Settlement files","pages":[{"title":"List settlement files","deprecated":null,"version":null,"openapi":"/settlements-api.yml get /api/v1/SettlementFiles","href":"/api-reference/settlement-files/list-settlement-files"}]}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Query - Paybyrd","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DCDCdBVX.js","utils-ME8dDnLe.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-0e84ACsd.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-wgRBj-ia.js","snippetPresets-C11Sgb-o.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-C0lapOpP.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ZeRQV8fF.js","shallow-BupWh095.js","getApiPlaygroundDisplay-BnYQO2Ss.js","CodeSnippet-RKKOc8c_.js","CodeSnippets-Drf_m8wS.js","Page-Bevw23-4.js","getPastedJson-u6QiPzNZ.js","icon-Bb-CBSxO.js","MethodPill-F7l5AI7V.js","DuplicateIcon-IiAXkdSg.js","createIcon-FliI8EBc.js","DynamicMarkdown-B62XqCSI.js","SectionHeading-Dj31pT03.js","axios-vUo_bRtp.js","Markdown-BOgQCTwD.js","clsx-BIWXJmsZ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DKZWslLH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-UDqbR6xh.js"]}