{"openapi":"3.1.0","info":{"title":"Bezel API (proposal)","version":"0.1","description":"Every resource on this API behaves the same way. Read this page once and you can predict the\nshape of any endpoint you have not used yet, that is the point of it, and it is enforced by a\nconformance suite rather than by review.\n\n## Resources and paths\n\nA path is a collection and, where you are addressing one thing, its identifier:\n\n    /merchants                     the collection\n    /merchants/{merchantId}        one of them\n\nCollections are plural and kebab-case. There are no verbs in paths, no audience segments\n(`/enterprise/...`), and no nesting of independent resources, a payout is at `/payouts`, not\nunder the transaction it settles.\n\nPaths carry no mount point. You call `/merchants`; which internal prefix that forwards to is a\nproperty of the deployment, not of the API.\n\n## The operations\n\n| Request | Operation id | Returns |\n|---|---|---|\n| `GET /{collection}/{id}` | `get<Resource>` | one of them |\n| `GET /{collection}` | `query<Resources>` | a page of them |\n| `POST /{collection}` | `create<Resources>` | `<Prefix>CreateRsp`, what was created, plus anything creating it produced |\n| `POST /{collection}/{id}` | `actOn<Resource>` | `<Prefix>UpdateRsp`, the resource as the action left it |\n| `PUT /{collection}/{id}` | `replace<Resource>` | the view, a replacement returns what a read returns |\n| `PATCH /{collection}/{id}` | `update<Resource>` | `<Prefix>UpdateRsp`, the resource as it now stands, plus anything the update produced |\n| `PATCH /{collection}` | `update<Resources>` | the same, where the instance is named by a selector in the body |\n| `DELETE /{collection}/{id}` | `delete<Resource>` | |\n\nNot every resource offers all of them. A resource that cannot be created through the API, a\ndispute, an issuer transaction, has no `POST`, and says so in its overview.\n\nThe operation id is derived from the collection name, so you can predict it: `/issuer-transactions`\ngives `getIssuerTransaction` and `queryIssuerTransactions`.\n\n## Changes are fields, actions are a `type`, and neither is a verb in the path\n\nA change to what a resource holds is a `PATCH` of its fields. Something you do to a resource\nwhose effect goes beyond its fields, a business check, an account opened at a gateway, an email or\na webhook, is an action: a `POST` to the resource itself, with the body's `type` naming the action.\n\n    POST /merchants/mcht_01H8…\n    { \"type\": \"MchtCmdActivation\", \"suspended\": false, \"checkoutEnabled\": true }\n\nA create is the same idea on the collection: `POST /merchants` with a `type` saying which kind\nof merchant to make. The path names what is acted on, so a body never carries its own\nresource's identifier.\n\nThe discriminator value is always exactly the schema component name, so the `type` you send is\nthe schema you can look up. An unrecognised `type` on a request is a `400`. Forward compatibility\nis a response-side concern, see below.\n\n## Leaving a field out keeps it, `null` removes it\n\nAn update changes only what it sends. Where an update's groups are `…Patch` shapes, a field\nyou can remove is published as nullable, and `null` removes it:\n\n    PATCH /merchants/mcht_01H8…\n    { \"type\": \"MchtUpdateBranding\",\n      \"branding\": { \"type\": \"MchtBrandingPatchAttributes\", \"brandColour\": \"#0B7285\", \"logoAltText\": null } }\n\nThat sets the colour, removes the alt text, and leaves the logo and icon as they were. `null` on\na field that is not nullable is a `400`, never a quiet \"unchanged\". A list is replaced when it is\nsent, and `[]` empties it.\n\n## What a write answers with\n\nA write never makes you follow it with a read. It hands back the resource, and anything the\noperation produced that the resource does not hold:\n\n    POST /api-keys\n    { \"type\": \"ApiKeyCmdCreate\", \"displayName\": \"Reporting\", \"domain\": \"Merchant\" }\n\n    200\n    { \"type\": \"ApiKeyCreateRspIssued\",\n      \"created\": { \"type\": \"ApiKeyView\", \"apiKeyId\": \"key_9f2…\", \"last4\": \"f31a\", … },\n      \"secret\": \"sk_live_9f2Kd8QpLzXwR4mN\" }\n\nThe secret is on the response and nowhere else. It is not a field on the token that happens to\nbe null on every read, a field whose presence you have to learn from prose is a field you will\nget wrong, so the shape says when it is there.\n\nThe same on the way through:\n\n| Operation | Answers with | Carries |\n|---|---|---|\n| `POST` on a collection | `<Prefix>CreateRsp` | `created`, plus what creating produced |\n| `PATCH` | `<Prefix>UpdateRsp` | `updated`, plus what the update produced |\n| `POST` on one | `<Prefix>UpdateRsp` | `updated`, the resource as the action left it |\n| `PUT` | the view | nothing else, a replacement produces nothing of its own |\n\nBoth envelopes are tagged unions, and most have one arm today. That is deliberate: a new\noutcome arrives as a new arm, which is not a breaking change, whereas a new optional field on a\nflat body leaves you unable to tell which combinations are real.\n\n`created` and `updated` are named the same on every resource, so one helper reads any of them.\n\n## Naming one thing that has no identifier of yours\n\nNormally you address a resource by its identifier in the path. Some can also be named by a key\nyou already hold, an issuer transaction by the card and your own reference for the purchase,\nfor instance, when you never stored ours.\n\nThose go through a collection-level `PATCH`, with a tagged `selector` in the body:\n\n    PATCH /issuer-transactions\n    { \"type\": \"ItxnUpdateAttributes\",\n      \"selector\": { \"type\": \"ItxnSelectorCardReference\",\n                    \"cardReference\": \"dcard_9f2…\",\n                    \"referenceTransactionId\": \"booking-88213\",\n                    \"merchantId\": \"mcht_9f2…\" },\n      \"status\": \"Captured\" }\n\nThe reason it is a body rather than a path or a query is that one of these keys can contain a\ncard number, and a card number must never appear in a URL, URLs are logged, proxied and kept\nin browser history.\n\nA selector must match exactly one: none is a `404`, more than one is a `409`. It is a way of\nnaming an instance, never a way of changing several.\n\n## Doing many at once\n\nBulk work is a resource, not an array. `POST /transaction-batches` creates a batch, and the\nbatch is a thing you can read afterwards:\n\n    POST /transaction-batches\n    { \"type\": \"TranbatchCmdCreate\", \"transactions\": [ … ] }\n\nThis is because five hundred creates with three rejections is neither a success nor a failure.\nThe batch records what happened to each item, so a partial result is something you can read and\nact on rather than something you have to infer from a status code.\n\n## One read, and you choose how it pages\n\nThere is no `/search` twin. `GET /{collection}` carries the filters and the pagination the\ncollection serves, and you pick:\n\n| You want | Send |\n|---|---|\n| Offset pages | `?page=2&limit=50` |\n| Cursor pages | `?startingAfter=<id>&limit=50` (or `endingBefore` to go back) |\n| Free-text search | `?q=acme`, combines with either, and with filters |\n| Sorting | `?sort=-createdAt,updatedAt`, `-` for descending, in priority order |\n\nAsking for both paginations at once is a `400`, not a silently-preferred mode.\n\nA collection publishes only the paging parameters it serves. Most serve both; a list read\nwhole, such as a merchant's balances, takes `page` alone, and a list walked forward, such as\nyour exports, takes `startingAfter` alone. A paging parameter a collection does not publish\nis a `400` naming it, as any parameter it does not declare is.\n\nEach collection lists the fields it can be sorted by, and any other field is a `400` naming them. A collection\nwith no `sort` parameter returns its own fixed order.\n\nCounts come back in the body rather than in headers, because generated clients drop headers:\n\n    { \"data\": [ … ],\n      \"hasMore\": true,\n      \"nextStartingAfter\": \"mcht_01H8…\",   // cursor mode\n      \"totalCount\": 412,\n      \"page\": 1, \"totalPages\": 9 }         // offset mode\n\n## Getting a spreadsheet out\n\nEvery collection read renders as CSV as well as JSON. Ask for it with `Accept`:\n\n    GET /transactions?status=Settled&sort=-createdAt&limit=200\n    Accept: text/csv\n\nFilters and sorting work exactly as they do for JSON, because it is the same read. Choose the\ncolumns, in the order you want them, with `columns`:\n\n    GET /refunds?columns=RefundId,AmountsAmount,SettledAt\n    Accept: text/csv\n\nThe available columns are on each resource as an enum, `RfndColumn`, `TranColumn`, and they\nare the view's own fields, so anything you can read in JSON you can have as a column. Nested\nobjects flatten one level (`AmountsAmount`); arrays do not become columns, because a row holds\none value, so export the sub-collection instead. A field that is one of several shapes, a\nrefund's `subject`, is not a column either. A customer is a consumer or an organisation, so its\nCSV has a column for every field of both, after a `Type` column naming which each row is; a\nfield the row's shape lacks is empty. Without `columns` you get every column, in the enum's order.\n\n`columns` applies to CSV only. Sent with `application/json` it is a `400`, because a JSON\nresponse with a caller-chosen field list is a response this document could not describe.\n\nA CSV response is a **page**, and the same `limit` applies as for JSON. It is the same read, so it\nholds what the JSON page holds: a field you may not read in JSON, a customer's name or email\naddress without access to customers' personal details, is empty in CSV. It is written exactly as\nan export of the list writes it, cell for cell. A page too large to write in the request, which\nonly a large `limit` over wide rows comes near, is a `400` saying so: ask for a smaller `limit`, or\nexport the whole list.\n\nFor every row of a list at once, of any size, export it: `POST /exports` with the collection as\nthe `source` and the list's own query parameters, and the file is answered at once when it is\nsmall or written in the background when it is not. For every row with totals, run a report.\nThere are four, transactions or refunds over a period, one payout's contents and a merchant's\nsettlement, and the answer is the report itself:\n\n    POST /reports\n    { \"type\": \"RprtCmdTransactions\",\n      \"merchantId\": \"mcht_9f2…\",\n      \"from\": \"2026-09-01T00:00:00+10:00\",\n      \"to\": \"2026-10-01T00:00:00+10:00\",\n      \"timeZone\": \"+10:00\" }\n\nNothing is stored, so there is nothing to poll and nothing to read back.\n\n## Getting a file out\n\nA document the platform has already rendered and stored is served as the file itself, under its own\nmedia type, not inside JSON. A loan statement's CSV, PDF and XML are read this way:\n\n    GET /loan-statements/{loanStatementId}/documents/Pdf\n    Accept: application/pdf\n\n`Content-Disposition` names the file. An `Accept` that matches none of the operation's media types,\n`application/json` for one, is a `406` with an empty body.\n\n## Reading a sub-collection in context\n\nSome things belong to something else and are worth reading from it:\n\n    GET /transactions/{transactionId}/refunds\n    GET /transactions/{transactionId}/refunds/{refundId}\n    GET /transactions/{transactionId}/disputes\n    GET /transactions/{transactionId}/disputes/{disputeId}\n\nand the same four under `/issuer-transactions/{issuerTransactionId}`, because a refund of a card\nthe platform issued is a refund like any other.\n\nThese are **reads**. The refund itself is created at `POST /refunds` naming the transaction, and\nits address is `/refunds/{refundId}`, that is what a webhook sends you and what to store. The\npaths above are for reading in context and return the same `RfndView` you get anywhere else.\n\nThe parent is checked rather than assumed: asking for a refund of one transaction under a\ndifferent one is a `404`, not a redirect and not a shrug.\n\n## Identifiers\n\nEvery identifier carries a prefix naming what it identifies, `mcht_`, `cust_`, `tran_`,\n`psrc_`, `ordr_`, `loan_`, `payout_`, `dcard_`, `itxn_`. Passing an identifier of the wrong\nkind is a `400`, not a `404`: you are told you sent the wrong kind of id rather than that the\nthing does not exist.\n\nTreat ids as opaque strings. The prefix is a contract; the rest is not.\n\n## Enumerations\n\nEnumerated values are `PascalCase`, `AwaitingActivation`, `AmericanExpress`, `LostOrStolen`.\nNo spaces, no snake_case, no empty strings. Codes defined by an external standard keep that\nstandard's casing: currencies are `AUD`, countries are `AU`.\n\n**Decode unknown values rather than failing on them.** Enumerations that appear in responses\ncarry an `Unknown` member. A value your client does not recognise is a state added since your\nintegration was written, not a protocol error, and treating it as one is the most common way\nan integration breaks on a release it did not need to care about.\n\n## Money\n\nA single amount is an `IsoCurrencyAmount`, the amount in the currency's minor units, and the\ncurrency:\n\n    { \"minorCurrencyUnits\": 5000, \"currency\": \"AUD\" }\n\nSeveral amounts that necessarily share a currency are grouped, with the currency stated once:\n\n    { \"currency\": \"AUD\", \"authorised\": 5000, \"captured\": 5000, \"refunded\": 2000, \"fee\": 145 }\n\nA bare integer amount with no currency to interpret it does not appear anywhere on this API.\n\n## Dates and times\n\nTimestamps are ISO-8601 with an offset, and are named for what happened: `createdAt`,\n`capturedAt`, `authorisedAt`. Dates without a time, a settlement date, are `YYYY-MM-DD`.\n\n## Errors\n\nEvery operation returns the same error shape. A `400` means the request was wrong, a\nmalformed id, an unknown command `type`, both paginations at once. A `403` means your\ncredentials are valid but do not carry the authority the operation requires.\n\n## Card data\n\nCard numbers never reach this service in the clear. Requests carrying them go through the PCI\nvault, which is transparent to you: you call the same path with the card number, and the\nservice receives a token. Responses that return card data are encrypted under a key you\nnominate with the `Encryption-Key-Name` request header, and the response carries\n`Encryption-Key`.\n\n## Credentials\n\nEach resource states the credentials it accepts, an API secret key, or a JWT for a merchant,\nmarketplace, admin or customer session. Beyond authentication, each *operation* requires an\nauthority, shown on the operation itself."},"tags":[{"name":"Card issuer","description":"Digital cards are issued against a loan and drawn down as they are used. A card is issued, may be\ncancelled, and carries limits that can be changed while it is active.\n\n**The platform issues the card number on both networks.** You say which loan the card draws against,\nwho it is for, for how long and for how much. The platform produces a Mastercard number, and allocates\na UATP number from its own UATP range, so no create carries a card number.\n\nWhich cards you can see follows from which loans you can see: a card has no scope of its own, so\n`loanId` on the query is both a filter and the access model.\n\nCard details are handled by the PCI vault: a UATP card's number is allocated there and never\nreaches this service in the clear.\n\n**Reads are redacted.** A card comes back with its last four and its brand, never its number, so\nthere is nothing here to decrypt, and the `Encryption-Key-Name` header is accepted and answered with\nno key. It is carried because a read that returns card data would need it, and no read does yet: the\nplatform's unredacted call hands back **vault tokens** for the PAN and the CVV, which is a\nvault-to-vault exchange rather than something you can use. An unredacted read fit for an integrator is\nrecorded as a platform gap."},{"name":"Identity","description":"What the platform knows about a phone number or an email address that has been sent a one-time code:\nwhether it is verified, whether the outstanding code has expired, how many attempts have failed, and\nthe code itself.\n\n**A record is keyed by the contact detail.** It exists before any customer does, a code is sent to a\nphone number, and only later does that number belong to somebody. So this is not a view of a customer,\nand there is no `cust_` to read it by.\n\n**The read includes the live code.** Anyone holding it can pass the verification, which is why this\nwhole collection is platform administrators only.\n\n**Resetting clears the failed attempts and issues a new code.** That is what to do for someone locked\nout by failed attempts, or whose code never arrived."},{"name":"Customers","description":"Turning a business into an organisation customer, in two steps.\n\n**Check the business, then accept an owner.** The first step asks the registry about an ABN and comes\nback with the business's details and its beneficial owners; the second names one of those owners and\ncreates the organisation customer with that person as its first delegate.\n\n**The token carries everything between the steps.** Send it back on the second call, it holds what\nthe check established, and it is also what authorises both calls. There is nothing to read here: the\ntoken is the handle, and losing it means starting again.\n\n**The check can come back saying the business is already a customer.** Nothing to create then, link\nthe person to the existing customer through `/delegates` instead.\n\n**The registry's words are the registry's.** `status`, `dateRegistered` and `businessType` are\nstrings the provider gave us, and the date is not reliably formatted between providers. Show them to a\nperson; do not branch on them."},{"name":"Marketplaces","description":"What a marketplace earns on payments its sub-merchants take, the revenue share, credited to a merchant\nentity the marketplace owns.\n\n**These point the opposite way from a merchant's fees.** `/merchants` carries what the platform charges\nthe merchant; this carries what the marketplace earns. `marketplaceMerchantId` is where the earnings\nland, and it is a merchant record belonging to the marketplace itself.\n\n**One structure usually covers every sub-merchant.** Leave `subMerchantId` out and it applies to all of\nthem; add structures naming particular sub-merchants for the ones negotiated separately, and the\nplatform takes the most specific match.\n\n**There is no list.** The platform can find a structure by its identifier and by the sub-merchant it\ncovers, and it cannot page them, so keep the identifier the create hands back. Reading them all is\nrecorded as an outstanding gap in the migration guide."},{"name":"Merchants","description":"A merchant is a business that takes payments on the platform. Merchants are onboarded, activated\nonce their business details are verified, and may be suspended or closed.\n\nA merchant of type `ServiceProvider` receives money without selling, a supplier being paid\nthrough the platform rather than a business taking payments."},{"name":"Payment sources","description":"A payment source is a stored means of payment held against a customer, a card, a bank account\nfor direct debit, or a PayTo agreement. The `type` on the body tells you which you have.\n\nCard details go through the PCI vault: you send the card number, the vault tokenises it, and the\nclear number never reaches this service.\n\nA **temporary** card is for one payment and is owned by the merchant rather than by a customer,\nit never appears in a customer's wallet, and it is how a guest checkout takes a card."},{"name":"Transactions","description":"A transaction is a payment taken from a customer on behalf of a merchant. It is authorised, then\ncaptured, immediately by default, or later if you asked to authorise only, and may then be\nrefunded in full or in part.\n\n**A transaction is not an order.** The order is the commerce record, what was bought and what is\nowed; the transaction is one attempt to collect against it, and one order can have several if the\nfirst fails or the order is paid in instalments. A transaction need not have an order at all: name\none when the platform is holding the line items, omit it when you only need to take a payment.\n\nCapturing and cancelling are changes to the transaction, so they are a `PATCH`. Refunding creates\na refund and transferring creates a transfer, so those are a `POST` on `/refunds` and\n`/transfers`.\n\nA card payment that triggers a 3DS challenge is completed by patching the transaction with the\nchallenge result."},{"name":"Filters","description":"A filter catalogue says which filters one list offers this caller: each filter's name and label, the operators it\ntakes with the exact query parameter each is sent as, and how a person finds a value to give it. Read one to build\nan Add Filter menu without hard-coding a list's parameters.\n\n**A catalogue is per caller.** A filter the caller could give only one value, such as the merchant filter for a\nmerchant's own user, is left out, as is a filter over data the caller may not see. A catalogue is read with its\nlist's own authority: a caller that cannot read the list is answered as though it had no catalogue.\n\n**Values come from the catalogue, never from another collection.** A `Listed` filter carries its options. A\n`Referenced` filter's values, a merchant say, are found through `/filter-catalogues/{filterCatalogueId}/filter-values`, which\nruns that collection's search under the list's authority and answers each with its id and label only, so a caller\nthat may read transactions and not merchants still finds a merchant to filter by. Pass `value` instead of `q` to\nread the labels of values already chosen.\n\nThe parameters themselves carry an `x-filter` extension in the document, naming the filter, the operator and the\nkind, for a client generated without a call. The catalogue is what to offer; the document is what can be sent."},{"name":"Orders","description":"An order is the commerce record, what was bought, for how much, by whom. A transaction is the\nattempt to collect money against it. One order may have several transactions if the first attempt\nfails or the order is paid in instalments.\n\nCreate an order when you want the platform to hold the line items and the amount owed; go\nstraight to a transaction when you only need to take a payment.\n\n**To pay an order**, create a transaction naming it: `POST /transactions` with the `orderId` and\na payment token. The token decides how the money is taken, card, Apple Pay, direct debit, PayTo\nand the rest are all variants of creating one.\n\n**To let the payer do it themselves**, create the order with `OrdrCmdCreateInvoice` and you get a\npayment link back with it. The link is a bearer credential: whoever holds it can read and pay the\norder, and the token is returned exactly once. Reissue it with the `paymentLink` group on the\n`PATCH`, which supersedes the last one."},{"name":"Loans","description":"A loan is a revolving facility a borrower draws against and repays. Its balances, the limit, what\nis used, what is available, what is reserved and what is pending, are always in one currency, so\nthe currency is stated once.\n\n**Opening a loan takes two calls.** `POST` with `LoanCmdApply` and you get an **offer**: the terms\nthe platform will lend on, signed with an `offerToken`. Send that offer back with\n`LoanCmdAcceptOffer` and the loan opens. The two steps exist because a borrower has to be shown\nthe terms and agree to them, and there is no way to skip the agreement.\n\n**Movements are not here** a drawdown or a card charge is a `/loan-transactions`. This\ncollection is the loan itself: its status, its terms, and what it currently owes.\n\n**A trading account carries a metadata template**, the rules its card transactions' metadata must\nmeet. It is set on the application, comes back in the offer, which signs it, and is read under the\nloan's `specification`. `LoanUpdateTradingAccount` replaces it whole. A template is checked when it\nis set, and one that fails is refused with 400 naming the path at fault.\n\n**A loan's statement settings are a sub-resource.** `GET /loans/{loanId}/statement-settings`\nreads which documents its statements produce, who they are mailed to and how the attachment is\nencrypted. `PATCH` with `LoanUpdateStatementSettings` replaces them whole, and\n`LoanUpdateClearStatementSettings` deletes them. All three need `Loans_Update`; the transfer secret\nis write-only."},{"name":"Payouts","description":"A payout is money the platform sent to a merchant's bank account. Payouts are raised on the merchant's\nschedule; you can also raise one by hand.\n\n`amounts` carries what moved and the merchant's balance either side of it, `closingBalance` is\n`openingBalance` less `amount`, which is the arithmetic a reconciliation checks. What the payout is\n*made of* is `composition`, broken down by entry type, and it is present on a by-id read only.\n\n`status` is the external status: a payout whose first payment attempt failed reads as `InTransit` while\nthe platform retries, not `Pending`. When a payout has not arrived, `disbursement.attempts` is the\nfield that says why.\n\nA paid payout has a statement. The documents made for it, and where each got to, are at\n`GET /payouts/{payoutId}/documents`, and the statement itself, as the file, is at `GET /payouts/{payoutId}/documents/{format}`.\n`PATCH` makes the statement again or mails it again."},{"name":"FX rates","description":"An FX rate set is a set of exchange rates an enterprise maintains. It is addressed by its\n`fxrset_` identifier; `rateSetCode` is the natural key the enterprise chose at creation, unchangeable,\nand unique only within that enterprise.\n\nEvery rate is two-sided: `bidRate` applies when the customer sells the base currency and `askRate` when\nthey buy it. The gap between them is the spread, which is why a single rate would not do.\n\nRates are decimal strings, not JSON numbers. A rate rounded to a double is a rate that does not\nreproduce.\n\n`crossCurrency` is how a pair the set does not quote directly is priced. `GET\n/fx-rate-sets/{fxRateSetId}/rates`\nprices one pair and reports the legs it crossed through; the set read returns only the pairs the set\nquotes directly, so ask the sub-read rather than doing the arithmetic yourself."},{"name":"Webhooks","description":"A webhook subscription delivers platform events to an endpoint you control.\n\nDeliveries are signed with the subscription's secret so you can verify they came from us. The\nsecret is write-only: send it on create, rotate it by sending a new one on update, and it is\nnever returned.\n\n`consecutiveFailures`, `lastDeliveryAt` and `lastDeliveryStatus` say how the endpoint has been\ndoing, read from its deliveries. The platform does not suspend a subscription on its own: a\nsubscription is suspended only when you suspend it, and resuming it sends what it held."},{"name":"Payment tokens","description":"A payment token authorises one payment of a stated amount. Issue one from your checkout, then\npresent it to take the payment.\n\nThis is the one collection that accepts a publishable key, because it is called from the\nbrowser. That is also why a token names the amount it is good for: a credential that can reach\nthe page cannot be trusted to name its own price.\n\nThere is one create variant per payment method, saved source, card, Apple Pay, Google Pay,\nnetwork token, bank account, PayTo, and everything downstream refers to the token rather than\nrepeating the method.\n\n**A token has no status and cannot be listed.** It is a short-lived authorisation, not a record of a\ncheckout attempt: it is used once, and what happened is on the `/transactions` it produced. Reading\none back tells you what it charges and what it pays with, and nothing about its life.\n\nTo ask what a payment would cost before issuing a token, use `/surcharge-quotes`."},{"name":"Reference data","description":"Reference data is what the platform keeps so it can validate what you send: the Australian and New\nZealand bank-branch registers, and BIN groups.\n\nLook a branch up before you send a bank account, an Australian one by its BSB, a New Zealand one by the\nfirst six digits of the account number. A lookup matches at most one branch, and no match means the\nregister does not have it rather than that the account is invalid.\n\nBIN groups used to be here and are now `/bin-groups`: a group is a stored entity with an identifier, and\nthis collection is for questions.\n\n`RefCmdListIndustries` returns the industries the platform recognises with their ISO 18245 category\ncodes. `industry` is a string on every business profile, and this is where you find out which strings it\naccepts.\n\nLoading a register is **bulk and it does not merge**. Send the whole register."},{"name":"Ledgers and journals","description":"A system ledger is one of the platform's own books. Read them to reconcile: every movement the platform\nmakes lands in one, and a balance you cannot explain is explained here.\n\nManual entries exist for corrections, and each records why it was made."},{"name":"Enterprises","description":"An enterprise is the party that holds the platform contract. Marketplaces, merchants, loan\nproducts and service tokens all sit under exactly one, and nothing crosses between them.\n\nMost integrations never touch this collection: a merchant or marketplace credential is already\nscoped to one enterprise and cannot read another."},{"name":"Parties","description":"An organisation is a business's legal record: its registration, its registered office, how it is\nreached, who owns it and the documents it is evidenced by. It is shared: a merchant, an organisation\ncustomer and an owner that are the same business in one enterprise are one organisation, and each\nnames it by `organisationId`.\n\nA caller reads the organisations of its own scope: a merchant its own, its customers' and every owner\nreached from either; a marketplace its merchants' and its own settings'; an enterprise every one in\nit. One outside the scope reads as not found. Customer and delegate sign-ins read none.\n\nOnly the contact can be changed here, and it is replaced whole. The registration and the owners follow\nthe merchant, customer or verification that states them. Because every tenant reading an organisation sees\nits contact, a merchant changes only its own organisation's and a marketplace only its merchants' and its\nsettings'; an enterprise changes any in it. A change to any other organisation reads as not found.\n\nA merchant, an organisation customer or a loan facility may be created as an organisation you read here,\nby its `organisationId`, instead of from business details; a merchant or an organisation customer may be\nmoved to another the same way, with `MchtUpdateOrganisation` or `CustUpdateOrganisation`."},{"name":"Operations","description":"A queue is a stream the platform drains internally. Webhook delivery is the first; the list is discovered\nrather than declared, so a queue this documentation has never heard of will still appear.\n\n**This is an operator surface.** It describes the estate rather than any one merchant, and is not scoped to\none, which is why it is administrator-only. A merchant asking whether its webhook arrived is asking about a\ndelivery, and that is on the subscription, under `/webhooks/{webhookId}/deliveries`.\n\nA read is a **live measurement, not a stored record**: nothing is kept and asking twice gives two answers.\n\n`backlog` and `lagSeconds` are the two numbers to watch, and they say different things. A backlog is how\nmuch is waiting; a lag is how long it has been waiting. A queue with a large backlog and no lag is busy and\nkeeping up. A queue with a small backlog and a growing lag has something stuck at the front of it.\n\n`members` and `silentMembers` are a pair, and the second is the interesting one. A member registers when a\nprocess starts and is only removed when something asks, so a process that dies leaves its registration\nbehind until it is swept. `silentMembers` is how much of `members` is residue rather than capacity.\n\n**A dead letter is a message a consumer could not handle**, kept exactly as published. Replaying one puts it\nback on the queue unchanged, to be offered to whoever is draining; it is the fix, not a note that the fix is\nneeded. Replay is safe to repeat: a consumer that still cannot handle the message will dead-letter it again\nrather than stop."},{"name":"Reporting","description":"A report dataset is something a dashboard can ask questions of: the dimensions it can be grouped and\nfiltered by, the measures it adds up, and the time grains it buckets by. Read one to render a report builder\nwithout hard-coding anything, then ask it a question with `POST /report-queries`.\n\n**A filter is always filled from a lookup, never typed.** A dimension whose `lookup` is `Search` is found by\ntyping part of a name into `dimension-values`; what comes back is the value to filter by, with the name beside\nit. That is how a merchant filter works: search `Acme`, pick `Acme Pty Ltd`, filter by its `mcht_` id.\nThe values page by cursor: pass `nextStartingAfter` back as `startingAfter` for the next page.\n\nOnly the dimensions this caller may see are listed, and a dataset this caller may not read is not listed at all.\n\nA caller no tenant bounds, the platform's own staff, is shown only the datasets of the reporting areas it holds:\n`ReportsAcquiring_Query` for payments, funds and finance, `ReportsLending_Query`, `ReportsCustomers_Query` and\n`ReportsOperations_Query` for Cube health. A dataset outside them answers as one that does not exist, as does a\nquestion narrowed to a tenant outside the caller's reach."},{"name":"Settlement","description":"A merchant invoice is what the platform charged a merchant for a period, and what has been paid against\nit.\n\nReading one invoice fills in `items` and `billing`; a listing leaves them out. `manualPayment` is how a\nperson pays it without a stored source.\n\n`status` is a ladder, not a flag: `Outstanding` → `NearDue` → `Due` → `Overdue`, and payment is\nrequired from `Due`. `payments` is every attempt at paying it, and it is where to look before marking\nan invoice paid by hand, an `MinvPaymentInProgress` at the end of that list means a direct debit is\nin flight and you would be double-crediting."},{"name":"Simulations","description":"A simulation makes the platform do something its scheduler would normally do, so a test does not have\nto wait. Test environments only.\n\nTwo exist: establish a pay plan, and take its next instalment. Both run the real code path with the\n\"is it due yet\" check switched off, so everything downstream of them happens for real, the transfer,\nthe transaction, the webhooks.\n\nNothing is recorded. The response says the platform did it and to which pay plan; what came of it is\nvisible through `/transactions` and the webhooks it fired."}],"servers":[{"url":"https://api.tst.au.apgpay.dev","description":"Test"}],"paths":{"/cards/{cardId}":{"get":{"tags":["Card issuer"],"description":"Return one digital card.","operationId":"getCard","parameters":[{"name":"cardId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Encryption-Key-Name","in":"header","description":"Name of the caller's registered public encryption key, used to encrypt sensitive card data in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{"Encryption-Key":{"description":"Encryption key for decrypting the sensitive card data in this response.","required":false,"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardView","description":"A digital card."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"CreditCards","action":"Read"},"description":"Requires the `query` action on `creditCards` for the supplied runtime context","action":"query","resource":"creditCards"}},"patch":{"tags":["Card issuer"],"description":"Update a digital card's mutable attributes.","operationId":"updateCard","parameters":[{"name":"cardId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"CreditCards","action":"Update"},"description":"Requires the `update` action on `creditCards` for the supplied runtime context","action":"update","resource":"creditCards"}}},"/cards":{"get":{"tags":["Card issuer"],"description":"Return a page of digital cards. Supply `page` for offset pagination or `startingAfter` for cursor pagination, and `q` to search. The filters combine with each other and with `q` by AND. `GET /filter-catalogues/cards` lists those this caller can use. A cursor continues only the walk that issued it: sent with different filters, `q` or `sort`, it is refused with 400.","operationId":"queryCards","parameters":[{"name":"q","in":"query","description":"Search. Matches a card id, the card's last four digits, the card user's name or email address, the creator or the provider's identifier. No card number is ever matched. An id, an email address, a phone number and any value listed as matched exactly match exactly; any other term matches without regard to case from the start of a value (or of any word in it, beside a longer word of the term), or anywhere in it from three characters, every word of it somewhere; a term that matches nothing so is read again with typos tolerated. Closest matches come first unless `sort` is given.","required":false,"schema":{"type":"string","maxLength":100}},{"name":"page","in":"query","description":"Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"endingBefore","in":"query","description":"Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"Fields to sort by, comma-delimited, in priority order. Prefix a field with `-` for descending.","required":false,"explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/CardSort"}}},{"name":"status","in":"query","description":"Only cards whose status is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/CardStatus"},{"type":"array","items":{"$ref":"#/components/schemas/CardStatus"}}]},"x-filter":{"filter":"status","operator":"In","kind":"Enum"}},{"name":"cardId","in":"query","description":"Only cards whose identifier is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"cardId","operator":"In","kind":"Id"}},{"name":"loanId","in":"query","description":"Only cards whose loan is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"loanId","operator":"In","kind":"Id"}},{"name":"last4","in":"query","description":"Filter by the last four digits of the card number.","required":false,"schema":{"type":"string"},"x-filter":{"filter":"last4","operator":"Equals","kind":"Text"}},{"name":"excludeExpired","in":"query","description":"Leave out cards outside their validity window.","required":false,"schema":{"type":"boolean"},"x-filter":{"filter":"excludeExpired","operator":"Equals","kind":"Boolean"}},{"name":"Encryption-Key-Name","in":"header","description":"Name of the caller's registered public encryption key, used to encrypt sensitive card data in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{"Encryption-Key":{"description":"Encryption key for decrypting the sensitive card data in this response.","required":false,"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardPage"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"CreditCards","action":"Read"},"description":"Requires the `query` action on `creditCards` for the supplied runtime context","action":"query","resource":"creditCards"}},"post":{"tags":["Card issuer"],"description":"Issue a digital card against a loan. The network is selected by the body's `type`.","operationId":"createCards","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"CreditCards","action":"Create"},"description":"Requires the `create` action on `creditCards` for the supplied runtime context","action":"create","resource":"creditCards"}}},"/issuer-transactions/{issuerTransactionId}":{"get":{"tags":["Card issuer"],"description":"Return one issuer transaction.","operationId":"getIssuerTransaction","parameters":[{"name":"issuerTransactionId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItxnView","description":"An issuer transaction, a card authorisation and its subsequent capture, refunds and disputes."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"IssuerTransactions","action":"Read"},"description":"Requires the `query` action on `issuerTransactions` for the supplied runtime context","action":"query","resource":"issuerTransactions"}},"patch":{"tags":["Card issuer"],"description":"Capture, void, dispute, refund or adjust an issuer transaction, or append metadata to it.","operationId":"updateIssuerTransaction","parameters":[{"name":"issuerTransactionId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItxnUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItxnUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"IssuerTransactions","action":"Update"},"description":"Requires the `update` action on `issuerTransactions` for the supplied runtime context","action":"update","resource":"issuerTransactions"}}},"/issuer-transactions":{"get":{"tags":["Card issuer"],"description":"Return a page of issuer transactions. Supply `page` for offset pagination or `startingAfter` for cursor pagination, and `q` to search. The filters combine with each other and with `q` by AND. `GET /filter-catalogues/issuer-transactions` lists those this caller can use. A cursor continues only the walk that issued it: sent with different filters, `q` or `sort`, it is refused with 400.","operationId":"queryIssuerTransactions","parameters":[{"name":"q","in":"query","description":"Search. Matches a transaction id, the id of its loan or card, the card's last four digits, the reference transaction id, the acquiring or supplier merchant's name, the traveller's name, the supplier's invoice number, the Conferma deployment id or the agency delivery note number. No card number is ever matched. An id, an email address, a phone number and any value listed as matched exactly match exactly; any other term matches without regard to case from the start of a value (or of any word in it, beside a longer word of the term), or anywhere in it from three characters, every word of it somewhere; a term that matches nothing so is read again with typos tolerated. Matches come newest first unless `sort` is given.","required":false,"schema":{"type":"string","maxLength":100}},{"name":"page","in":"query","description":"Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"endingBefore","in":"query","description":"Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"Fields to sort by, comma-delimited, in priority order. Prefix a field with `-` for descending.","required":false,"explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/ItxnSort"}}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/ItxnColumn"}}},{"name":"status","in":"query","description":"Only transactions whose status is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/ItxnStatus"},{"type":"array","items":{"$ref":"#/components/schemas/ItxnStatus"}}]},"x-filter":{"filter":"status","operator":"In","kind":"Enum"}},{"name":"transactionId","in":"query","description":"Only transactions whose identifier is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"transactionId","operator":"In","kind":"Text"}},{"name":"referenceTransactionId","in":"query","description":"Find a transaction by your own reference for the purchase.","required":false,"schema":{"type":"string"},"x-filter":{"filter":"referenceTransactionId","operator":"Equals","kind":"Text"}},{"name":"loanId","in":"query","description":"Only transactions whose card's loan is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"loanId","operator":"In","kind":"Id"}},{"name":"cardId","in":"query","description":"Only transactions whose card is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"cardId","operator":"In","kind":"Id"}},{"name":"network","in":"query","description":"Only transactions whose scheme is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/ItxnNetwork"},{"type":"array","items":{"$ref":"#/components/schemas/ItxnNetwork"}}]},"x-filter":{"filter":"network","operator":"In","kind":"Enum"}},{"name":"settlementMerchantId","in":"query","description":"Only transactions whose settlement merchant is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"settlementMerchantId","operator":"In","kind":"Id"}},{"name":"customerId","in":"query","description":"Only transactions whose borrowing customer is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"customerId","operator":"In","kind":"Id"}},{"name":"auditNumber","in":"query","description":"The scheme's own trace number, what a scheme file is matched against.","required":false,"schema":{"type":"string"},"x-filter":{"filter":"auditNumber","operator":"Equals","kind":"Text"}},{"name":"approvalCode","in":"query","description":"The approval code the platform allocated.","required":false,"schema":{"type":"string"},"x-filter":{"filter":"approvalCode","operator":"Equals","kind":"Text"}},{"name":"last4","in":"query","description":"Filter by the last four digits of the card number.","required":false,"schema":{"type":"string"},"x-filter":{"filter":"last4","operator":"Equals","kind":"Text"}},{"name":"currency","in":"query","description":"Only transactions whose currency is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/IsoCurrency"},{"type":"array","items":{"$ref":"#/components/schemas/IsoCurrency"}}]},"x-filter":{"filter":"currency","operator":"In","kind":"Currency"}},{"name":"createdAfter","in":"query","description":"Only transactions whose creation time is at or after this ISO-8601 timestamp.","required":false,"schema":{"type":"string","format":"date-time"},"x-filter":{"filter":"created","operator":"After","kind":"Instant"}},{"name":"createdBefore","in":"query","description":"Only transactions whose creation time is before, and not at, this ISO-8601 timestamp.","required":false,"schema":{"type":"string","format":"date-time"},"x-filter":{"filter":"created","operator":"Before","kind":"Instant"}},{"name":"capturedAfter","in":"query","description":"Only transactions whose capture time is at or after this ISO-8601 timestamp.","required":false,"schema":{"type":"string","format":"date-time"},"x-filter":{"filter":"captured","operator":"After","kind":"Instant"}},{"name":"capturedBefore","in":"query","description":"Only transactions whose capture time is before, and not at, this ISO-8601 timestamp.","required":false,"schema":{"type":"string","format":"date-time"},"x-filter":{"filter":"captured","operator":"Before","kind":"Instant"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItxnPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"CreditCards","action":"Read"},"description":"Requires the `query` action on `creditCards` for the supplied runtime context","action":"query","resource":"creditCards"}},"patch":{"tags":["Card issuer"],"description":"Change one issuer transaction, named by a selector rather than by its identifier. The selector must match exactly one.","operationId":"updateIssuerTransactions","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItxnSelectorUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItxnUpdateOutcome"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"IssuerTransactions","action":"Update"},"description":"Requires the `update` action on `issuerTransactions` for the supplied runtime context","action":"update","resource":"issuerTransactions"}}},"/issuer-transactions/{issuerTransactionId}/refunds":{"get":{"tags":["Card issuer"],"description":"Return a page of the refunds issued against this transaction. This is the only address an issuing refund has.","operationId":"queryIssuerTransactionRefunds","parameters":[{"name":"issuerTransactionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"q","in":"query","description":"Search. Matches a refund id or the reference refund id. An id matches exactly; any other term matches without regard to case from the start of a value (or of any word in it, beside a longer word of the term), or anywhere in it from three characters, every word of it somewhere. Typos are not tolerated, and matches keep the list's order.","required":false,"schema":{"type":"string","maxLength":100}},{"name":"page","in":"query","description":"1-based page number.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"status","in":"query","description":"Filter by refund status. Repeat the parameter to supply several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/ItxnRefundStatus"},{"type":"array","items":{"$ref":"#/components/schemas/ItxnRefundStatus"}}]}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItxnRefundPage"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"IssuerTransactions","action":"Read"},"description":"Requires the `query` action on `issuerTransactions` for the supplied runtime context","action":"query","resource":"issuerTransactions"}}},"/issuer-transactions/{issuerTransactionId}/refunds/{refundId}":{"get":{"tags":["Card issuer"],"description":"Return one refund of this transaction. A refund that does not belong to this issuerTransaction is a 404, not a redirect.","operationId":"getIssuerTransactionRefund","parameters":[{"name":"issuerTransactionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"refundId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItxnRefund","description":"A refund issued against a card authorisation."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"IssuerTransactions","action":"Read"},"description":"Requires the `query` action on `issuerTransactions` for the supplied runtime context","action":"query","resource":"issuerTransactions"}}},"/issuer-transactions/{issuerTransactionId}/disputes":{"get":{"tags":["Card issuer"],"description":"Return a page of the disputes raised against this transaction.","operationId":"queryIssuerTransactionDisputes","parameters":[{"name":"issuerTransactionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"q","in":"query","description":"Search. Matches a dispute id, the reference dispute id or the reason. An id matches exactly; any other term matches without regard to case from the start of a value (or of any word in it, beside a longer word of the term), or anywhere in it from three characters, every word of it somewhere. Typos are not tolerated, and matches keep the list's order.","required":false,"schema":{"type":"string","maxLength":100}},{"name":"page","in":"query","description":"1-based page number.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"outcome","in":"query","description":"Filter by dispute outcome. Repeat the parameter to supply several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/ItxnDisputeOutcome"},{"type":"array","items":{"$ref":"#/components/schemas/ItxnDisputeOutcome"}}]}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItxnDisputePage"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"IssuerTransactions","action":"Read"},"description":"Requires the `query` action on `issuerTransactions` for the supplied runtime context","action":"query","resource":"issuerTransactions"}}},"/issuer-transactions/{issuerTransactionId}/disputes/{disputeId}":{"get":{"tags":["Card issuer"],"description":"Return one dispute of this transaction. A dispute that does not belong to this issuerTransaction is a 404, not a redirect.","operationId":"getIssuerTransactionDispute","parameters":[{"name":"issuerTransactionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"disputeId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItxnDispute"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"IssuerTransactions","action":"Read"},"description":"Requires the `query` action on `issuerTransactions` for the supplied runtime context","action":"query","resource":"issuerTransactions"}}},"/contact-verifications":{"get":{"tags":["Identity"],"description":"Read the verification state of a phone number, an email address, or both. At least one is required: the platform looks a record up by its key and cannot page them all.","operationId":"queryContactVerifications","parameters":[{"name":"page","in":"query","description":"1-based page number.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/CvrfColumn"}}},{"name":"phoneNumber","in":"query","description":"E.164 format, e.g. +61400000000. At least one of `phoneNumber` and `emailAddress` is required.","required":false,"schema":{"type":"string"}},{"name":"emailAddress","in":"query","description":"At least one of `phoneNumber` and `emailAddress` is required.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CvrfPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"MerchantCustomers","action":"Read"},"description":"Requires the `query` action on `merchantCustomers` for the supplied runtime context","action":"query","resource":"merchantCustomers"},"x-required-one-of":[["phoneNumber"],["emailAddress"]]},"patch":{"tags":["Identity"],"description":"Reset the verification held against one contact detail: clears the failed attempts and issues a new code.","operationId":"updateContactVerifications","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CvrfUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CvrfUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"MerchantCustomers","action":"Update"},"description":"Requires the `update` action on `merchantCustomers` for the supplied runtime context","action":"update","resource":"merchantCustomers"}}},"/customer-api-keys":{"post":{"tags":["Identity"],"description":"Issue an API key to a customer. The key is on the response and nowhere else, ever.","operationId":"createCustomerApiKeys","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustkeyCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Custkey"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"MerchantCustomers","action":"Update"},"description":"Requires the `update` action on `merchantCustomers` for the supplied runtime context","action":"update","resource":"merchantCustomers"}}},"/issuer-refunds/{issuerRefundId}":{"get":{"tags":["Card issuer"],"description":"Return one refund of an issued-card transaction.","operationId":"getIssuerRefund","parameters":[{"name":"issuerRefundId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItxnRefund","description":"A refund issued against a card authorisation."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Customer JWT | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"IssuerTransactions","action":"Read"},"description":"Requires the `query` action on `issuerTransactions` for the supplied runtime context","action":"query","resource":"issuerTransactions"}},"patch":{"tags":["Card issuer"],"description":"Append free-form data to a refund. Merged with what is there, the refund's own record is the platform's, not yours.","operationId":"updateIssuerRefund","parameters":[{"name":"issuerRefundId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IrfndUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IrfndUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Customer JWT | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"IssuerTransactions","action":"Update"},"description":"Requires the `update` action on `issuerTransactions` for the supplied runtime context","action":"update","resource":"issuerTransactions"}}},"/issuer-refunds":{"post":{"tags":["Card issuer"],"description":"Refund a captured issuer transaction, naming it by selector rather than by identifier.","operationId":"createIssuerRefunds","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IrfndCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IrfndOutcome"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Customer JWT | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"IssuerTransactions","action":"Orchestrate"},"description":"Requires the `orchestrate` action on `issuerTransactions` for the supplied runtime context","action":"orchestrate","resource":"issuerTransactions"}}},"/organisation-prospects":{"post":{"tags":["Customers"],"description":"Check a business, or accept one of its owners and create the customer. The token decides which step you are on, and it is the credential for both: neither asks for a permission.","operationId":"createOrganisationProspects","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OprosCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OprosRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"description":"Required action depends on the request variant","variants":[{"description":"Check a business on its prospect token","schema":"OprosCmdCheckBusiness","tokenAnchored":true},{"description":"Accept an owner and create the customer on its prospect token","schema":"OprosCmdAcceptOwner","tokenAnchored":true}]}}},"/kyc-identifications":{"post":{"tags":["Identity"],"description":"Put a person through an identity check. Which person is decided by the credential you present.","operationId":"createKycIdentifications","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KycidCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KycidResult"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Customer JWT | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"MerchantCustomers","action":"Update"},"description":"Requires the `update` action on `merchantCustomers` for the supplied runtime context","action":"update","resource":"merchantCustomers"}}},"/marketplace-fee-structures/{marketplaceFeeStructureId}":{"get":{"tags":["Marketplaces"],"description":"Return one fee structure, with the rates on it and whether it is earning.","operationId":"getMarketplaceFeeStructure","parameters":[{"name":"marketplaceFeeStructureId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MktpfeestructView","description":"What a marketplace earns on payments taken by one of its sub-merchants, or by all of them."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Marketplaces","action":"Read"},"description":"Requires the `query` action on `marketplaces` for the supplied runtime context","action":"query","resource":"marketplaces"}},"patch":{"tags":["Marketplaces"],"description":"Replace the rates, change who it covers, or stop earning on it. One change per call.","operationId":"updateMarketplaceFeeStructure","parameters":[{"name":"marketplaceFeeStructureId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MktpfeestructUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MktpfeestructUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Marketplaces","action":"Update"},"description":"Requires the `update` action on `marketplaces` for the supplied runtime context","action":"update","resource":"marketplaces"}}},"/marketplace-fee-structures":{"post":{"tags":["Marketplaces"],"description":"Add a fee structure to a marketplace, for one sub-merchant or for all of them.","operationId":"createMarketplaceFeeStructures","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MktpfeestructCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MktpfeestructCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Marketplaces","action":"Update"},"description":"Requires the `update` action on `marketplaces` for the supplied runtime context","action":"update","resource":"marketplaces"}}},"/issuer-disputes/{issuerDisputeId}":{"get":{"tags":["Card issuer"],"description":"Return one dispute against an issued-card transaction.","operationId":"getIssuerDispute","parameters":[{"name":"issuerDisputeId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItxnDispute"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Customer JWT | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"IssuerTransactions","action":"Read"},"description":"Requires the `query` action on `issuerTransactions` for the supplied runtime context","action":"query","resource":"issuerTransactions"}}},"/issuer-disputes":{"post":{"tags":["Card issuer"],"description":"Raise a dispute against an issuer transaction, naming it by selector rather than by identifier.","operationId":"createIssuerDisputes","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdspCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdspOutcome"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Customer JWT | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"IssuerTransactions","action":"Orchestrate"},"description":"Requires the `orchestrate` action on `issuerTransactions` for the supplied runtime context","action":"orchestrate","resource":"issuerTransactions"}}},"/merchants/{merchantId}":{"get":{"tags":["Merchants"],"description":"Return one merchant.","operationId":"getMerchant","parameters":[{"name":"merchantId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MchtView"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Merchants","action":"Read"},"description":"Requires the `query` action on `merchants` for the supplied runtime context","action":"query","resource":"merchants"}},"post":{"tags":["Merchants"],"description":"Do something to a merchant whose effect goes beyond its fields: check and activate it, submit it for review, onboard it at the gateway, suspend it or turn its checkout off or on, or change its Apple Pay domains. Selected by the body's `type`. Every action reads the merchant first, under `Merchants_Query`, and answers with the merchant as it now stands.","operationId":"actOnMerchant","parameters":[{"name":"merchantId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MchtCmdAction"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MchtUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"description":"Required action depends on the request variant","variants":[{"description":"Activate the merchant","schema":"MchtCmdActivate","actions":[{"grant":{"resource":"Merchants","action":"Verify"},"resource":"merchants","action":"verify"}]},{"description":"Submit for onboarding review","schema":"MchtCmdSubmitForReview","actions":[{"grant":{"resource":"Merchants","action":"Activate"},"resource":"merchants","action":"activate"}]},{"description":"Register Apple Pay domains","schema":"MchtCmdRegisterApplePay","actions":[{"grant":{"resource":"Merchants","action":"Update"},"resource":"merchants","action":"update"}]},{"description":"Unregister Apple Pay domains","schema":"MchtCmdUnregisterApplePay","actions":[{"grant":{"resource":"Merchants","action":"Update"},"resource":"merchants","action":"update"}]},{"description":"Suspend, unsuspend, or turn checkout off or on","schema":"MchtCmdActivation","actions":[{"grant":{"resource":"Merchants","action":"Activate"},"resource":"merchants","action":"activate"}]},{"description":"Onboard at the gateway","schema":"MchtCmdOnboard","actions":[{"grant":{"resource":"Merchants","action":"Activate"},"resource":"merchants","action":"activate"}]}]}},"patch":{"tags":["Merchants"],"description":"Update a merchant's attributes, one group at a time. Selected by the body's `type`. A field left out keeps its value, and `null` removes one the merchant can be without (D36). Every update reads the merchant first, under `Merchants_Query`.","operationId":"updateMerchant","parameters":[{"name":"merchantId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MchtUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MchtUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"description":"Required action depends on the request variant","variants":[{"description":"Change the business profile","schema":"MchtUpdateBusinessProfile","actions":[{"grant":{"resource":"Merchants","action":"Update"},"resource":"merchants","action":"update"}]},{"description":"Change the payout settings","schema":"MchtUpdatePayoutSettings","actions":[{"grant":{"resource":"Merchants","action":"UpdateFinancials"},"resource":"merchantFinancials","action":"update"}]},{"description":"Change the billing settings","schema":"MchtUpdateBillingSettings","actions":[{"grant":{"resource":"Merchants","action":"UpdateFinancials"},"resource":"merchantFinancials","action":"update"}]},{"description":"Change the branding","schema":"MchtUpdateBranding","actions":[{"grant":{"resource":"Merchants","action":"Update"},"resource":"merchants","action":"update"}]},{"description":"Change the order settings","schema":"MchtUpdateOrderSettings","actions":[{"grant":{"resource":"Merchants","action":"Update"},"resource":"merchants","action":"update"}]},{"description":"Change the metadata","schema":"MchtUpdateMetadata","actions":[{"grant":{"resource":"Merchants","action":"Update"},"resource":"merchants","action":"update"}]},{"description":"Change the organisation","schema":"MchtUpdateOrganisation","actions":[{"grant":{"resource":"Merchants","action":"Update"},"resource":"merchants","action":"update"}]}]}}},"/merchants":{"get":{"tags":["Merchants"],"description":"Return a page of merchants. Supply `page` for offset pagination or `startingAfter` for cursor pagination, and `q` to search. With `q` the merchants page by `page` only: `startingAfter` and `endingBefore` are refused with 400, and so are several `marketplaceId` or `enterpriseId` values or either left out. `GET /filter-catalogues/merchants` lists the filters this caller can use. A cursor continues only the walk that issued it: sent with different filters, `q` or `sort`, it is refused with 400.","operationId":"queryMerchants","parameters":[{"name":"q","in":"query","description":"Free-text search. Supplying it engages the search index; omit it to filter only.","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"endingBefore","in":"query","description":"Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"Fields to sort by, comma-delimited, in priority order. Prefix a field with `-` for descending.","required":false,"explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/MchtSort"}}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/MchtColumn"}}},{"name":"status","in":"query","description":"Only merchants whose status is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/MchtStatus"},{"type":"array","items":{"$ref":"#/components/schemas/MchtStatus"}}]},"x-filter":{"filter":"status","operator":"In","kind":"Enum"}},{"name":"referenceMerchantId","in":"query","description":"Only merchants whose merchant reference is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"referenceMerchantId","operator":"In","kind":"Text"}},{"name":"marketplaceId","in":"query","description":"Only merchants whose marketplace is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"marketplaceId","operator":"In","kind":"Id"}},{"name":"marketplaceIdNot","in":"query","description":"Leave out merchants whose marketplace is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"marketplaceId","operator":"NotIn","kind":"Id"}},{"name":"enterpriseId","in":"query","description":"Only merchants whose enterprise is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"enterpriseId","operator":"In","kind":"Id"}},{"name":"enterpriseIdNot","in":"query","description":"Leave out merchants whose enterprise is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"enterpriseId","operator":"NotIn","kind":"Id"}},{"name":"payoutsEnabled","in":"query","description":"Only merchants with payouts turned on, or only those with them turned off. Reads `payoutSettings.payoutsEnabled`.","required":false,"schema":{"type":"boolean"},"x-filter":{"filter":"payoutsEnabled","operator":"Equals","kind":"Boolean"}},{"name":"createdAfter","in":"query","description":"Only merchants whose creation time is at or after this ISO-8601 timestamp.","required":false,"schema":{"type":"string","format":"date-time"},"x-filter":{"filter":"created","operator":"After","kind":"Instant"}},{"name":"createdBefore","in":"query","description":"Only merchants whose creation time is at or before this ISO-8601 timestamp.","required":false,"schema":{"type":"string","format":"date-time"},"x-filter":{"filter":"created","operator":"Before","kind":"Instant"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MchtPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Merchants","action":"Read"},"description":"Requires the `query` action on `merchants` for the supplied runtime context","action":"query","resource":"merchants"}},"post":{"tags":["Merchants"],"description":"Onboard a merchant into a marketplace, as a seller or as a supplier. Selected by the body's `type`.","operationId":"createMerchants","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MchtCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MchtCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Merchants","action":"Create"},"description":"Requires the `create` action on `merchants` for the supplied runtime context","action":"create","resource":"merchants"}},"patch":{"tags":["Merchants"],"description":"Advance every merchant with outstanding gateway onboarding. Test environments only, a 400 in production.","operationId":"updateMerchants","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MchtCollectionUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MchtOnboardingSweep"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Merchants","action":"Verify"},"description":"Requires the `verify` action on `merchants` for the supplied runtime context","action":"verify","resource":"merchants"}}},"/merchants/{merchantId}/apple-pay-registrations":{"get":{"tags":["Merchants"],"description":"Return the merchant's Apple Pay web registration, or say that there is none.","operationId":"getMerchantApplePayRegistration","parameters":[{"name":"merchantId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MchtApplePay"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Merchants","action":"Read"},"description":"Requires the `query` action on `merchants` for the supplied runtime context","action":"query","resource":"merchants"}}},"/customers/{customerId}":{"get":{"tags":["Customers"],"description":"Return one customer.","operationId":"getCustomer","parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustView"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"MerchantCustomers","action":"Read"},"description":"Requires the `query` action on `merchantCustomers` for the supplied runtime context","action":"query","resource":"merchantCustomers"}},"patch":{"tags":["Customers"],"description":"Update a customer's mutable attributes.","operationId":"updateCustomer","parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"MerchantCustomers","action":"Update"},"description":"Requires the `update` action on `merchantCustomers` for the supplied runtime context","action":"update","resource":"merchantCustomers"}}},"/customers":{"get":{"tags":["Customers"],"description":"Return a page of customers. Supply `page` for offset pagination or `startingAfter` for cursor pagination, and `q` to search. `GET /filter-catalogues/customers` lists the filters this caller can use. A cursor continues only the walk that issued it: sent with different filters, `q` or `sort`, it is refused with 400.","operationId":"queryCustomers","parameters":[{"name":"q","in":"query","description":"Free-text search. Supplying it engages the search index; omit it to filter only.","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"endingBefore","in":"query","description":"Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"Fields to sort by, comma-delimited, in priority order. Prefix a field with `-` for descending.","required":false,"explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/CustSort"}}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/CustColumn"}}},{"name":"merchantId","in":"query","description":"Only customers whose merchant is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"merchantId","operator":"In","kind":"Id"}},{"name":"email","in":"query","description":"Only customers whose email address is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"email","operator":"In","kind":"Text"}},{"name":"name","in":"query","description":"Only customers whose name contains this text.","required":false,"schema":{"type":"string"},"x-filter":{"filter":"name","operator":"Contains","kind":"Text"}},{"name":"createdAfter","in":"query","description":"Only customers whose creation time is at or after this ISO-8601 timestamp.","required":false,"schema":{"type":"string","format":"date-time"},"x-filter":{"filter":"created","operator":"After","kind":"Instant"}},{"name":"createdBefore","in":"query","description":"Only customers whose creation time is at or before this ISO-8601 timestamp.","required":false,"schema":{"type":"string","format":"date-time"},"x-filter":{"filter":"created","operator":"Before","kind":"Instant"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"MerchantCustomers","action":"Read"},"description":"Requires the `query` action on `merchantCustomers` for the supplied runtime context","action":"query","resource":"merchantCustomers"}},"post":{"tags":["Customers"],"description":"Create a customer, a consumer or an organisation, or refresh one already held under the same details. Selected by the body's `type`. A customer signing itself up before it is verified is held to `MerchantCustomers_UpsertMinimal` instead.","operationId":"createCustomers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Public Token | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"MerchantCustomers","action":"Upsert"},"description":"Requires the `upsert` action on `merchantCustomers` for the supplied runtime context","action":"upsert","resource":"merchantCustomers"}}},"/sources/{sourceId}":{"get":{"tags":["Payment sources"],"description":"Return one payment source.","operationId":"getSource","parameters":[{"name":"sourceId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PsrcView"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"CustomerPaymentSources","action":"Read"},"description":"Requires the `query` action on `customerPaymentSources` for the supplied runtime context","action":"query","resource":"customerPaymentSources"}},"delete":{"tags":["Payment sources"],"description":"Remove a stored payment source.","operationId":"deleteSource","parameters":[{"name":"sourceId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":""},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"CustomerPaymentSources","action":"Delete"},"description":"Requires the `delete` action on `customerPaymentSources` for the supplied runtime context","action":"delete","resource":"customerPaymentSources"}},"patch":{"tags":["Payment sources"],"description":"Replace a card's verification code, or lift a block the platform placed on it. Selected by the body's `type`.","operationId":"updateSource","parameters":[{"name":"sourceId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PsrcUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PsrcUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"description":"Required action depends on the request variant","variants":[{"description":"Replace a card's verification code","schema":"PsrcUpdateCvc","actions":[{"grant":{"resource":"CustomerPaymentSources","action":"Update"},"resource":"customerPaymentSources","action":"update"}]},{"description":"Lift a block on a card","schema":"PsrcUpdateRemoveBlock","actions":[{"grant":{"resource":"BlockedCard","action":"Update"},"resource":"blockedCard","action":"update"}]}]}}},"/sources":{"get":{"tags":["Payment sources"],"description":"Return a page of payment sources. Name whose sources: `customerId` or `customerDelegateId` is required, a source belongs to a payer and the platform does not page them across payers. Supply `page` for offset pagination or `startingAfter` for cursor pagination, and `q` to search. The filters combine with each other and with `q` by AND. `GET /filter-catalogues/sources` lists those this caller can use. A cursor continues only the walk that issued it: sent with different filters, `q` or `sort`, it is refused with 400. One issued before the list named its walks resumes as it did.","operationId":"querySources","parameters":[{"name":"q","in":"query","description":"Search. Matches a payment source id, a card's last four digits, a direct debit's account name or email address, or a PayTo account name. No card or account number is ever matched. An id, an email address, a phone number and any value listed as matched exactly match exactly; any other term matches without regard to case from the start of a value (or of any word in it, beside a longer word of the term), or anywhere in it from three characters, every word of it somewhere; a term that matches nothing so is read again with typos tolerated. Closest matches come first unless `sort` is given.","required":false,"schema":{"type":"string","maxLength":100}},{"name":"page","in":"query","description":"Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"endingBefore","in":"query","description":"Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"Fields to sort by, comma-delimited, in priority order. Prefix a field with `-` for descending.","required":false,"explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/PsrcSort"}}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/PsrcColumn"}}},{"name":"customerId","in":"query","description":"Filter by the customer the source belongs to.","required":false,"schema":{"type":"string"},"x-filter":{"filter":"customerId","operator":"Equals","kind":"Id"}},{"name":"merchantId","in":"query","description":"Filter by the merchant that owns the source. Temporary sources are merchant-owned.","required":false,"schema":{"type":"string"},"x-filter":{"filter":"merchantId","operator":"Equals","kind":"Id"}},{"name":"usageScope","in":"query","description":"Filter by what the source may be used for.","required":false,"schema":{"$ref":"#/components/schemas/PsrcScope"},"x-filter":{"filter":"usageScope","operator":"Equals","kind":"Enum"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PsrcPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"CustomerPaymentSources","action":"Read"},"description":"Requires the `query` action on `customerPaymentSources` for the supplied runtime context","action":"query","resource":"customerPaymentSources"}},"post":{"tags":["Payment sources"],"description":"Store a payment source. What kind is selected by the body's `type`. A card, bank account or PayTo agreement stored with `scope` `Billing` is the merchant's billing source, and needs `MerchantFinancials_Update` as the billing commands do.","operationId":"createSources","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PsrcCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PsrcCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"description":"Required action depends on the request variant","variants":[{"description":"Store a customer's card","schema":"PsrcCmdCreateCard","actions":[{"grant":{"resource":"CustomerPaymentSources","action":"Create"},"resource":"customerPaymentSources","action":"create"}]},{"description":"Store a card for one payment","schema":"PsrcCmdCreateTemporaryCard","actions":[{"grant":{"resource":"TemporaryPaymentSources","action":"Create"},"resource":"temporaryPaymentSources","action":"create"}]},{"description":"Store the merchant's billing card","schema":"PsrcCmdCreateBillingCard","actions":[{"grant":{"resource":"Merchants","action":"UpdateFinancials"},"resource":"merchantFinancials","action":"update"}]},{"description":"Store a customer's bank account","schema":"PsrcCmdCreateDirectDebit","actions":[{"grant":{"resource":"CustomerPaymentSources","action":"Create"},"resource":"customerPaymentSources","action":"create"}]},{"description":"Store the merchant's billing bank account","schema":"PsrcCmdCreateBillingDirectDebit","actions":[{"grant":{"resource":"Merchants","action":"UpdateFinancials"},"resource":"merchantFinancials","action":"update"}]},{"description":"Store a customer's PayTo agreement","schema":"PsrcCmdCreatePayTo","actions":[{"grant":{"resource":"CustomerPaymentSources","action":"Create"},"resource":"customerPaymentSources","action":"create"}]}]}}},"/blocked-cards":{"get":{"tags":["Payment sources"],"description":"Return the card-block audit, newest first. One card can appear several times, a row is an event, not a card.","operationId":"queryBlockedCards","parameters":[{"name":"q","in":"query","description":"Search. Matches a blocked card id, the id of the transaction that raised the block, the card's last four digits or the block's narrative. An id, an email address, a phone number and any value listed as matched exactly match exactly; any other term matches without regard to case from the start of a value (or of any word in it, beside a longer word of the term), or anywhere in it from three characters, every word of it somewhere; a term that matches nothing so is read again with typos tolerated. Closest matches come first unless `sort` is given.","required":false,"schema":{"type":"string","maxLength":100}},{"name":"page","in":"query","description":"Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"endingBefore","in":"query","description":"Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"Fields to sort by, comma-delimited, in priority order. Prefix a field with `-` for descending.","required":false,"explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/BcardSort"}}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/BcardColumn"}}},{"name":"marketplaceId","in":"query","description":"Narrow to one marketplace. Overridden by your credential where it names one.","required":false,"schema":{"type":"string"}},{"name":"merchantId","in":"query","description":"Narrow to these merchants. Repeat the parameter.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]}},{"name":"customerId","in":"query","description":"Narrow to these customers. Repeat the parameter.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]}},{"name":"transactionId","in":"query","description":"Narrow to the blocks raised against these transactions.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]}},{"name":"last4","in":"query","description":"Narrow to one card, by its last four digits.","required":false,"schema":{"type":"string"}},{"name":"cardBrand","in":"query","description":"Narrow to these card brands. Repeat the parameter.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/CardBrand"},{"type":"array","items":{"$ref":"#/components/schemas/CardBrand"}}]}},{"name":"event","in":"query","description":"Narrow to these events. Repeat the parameter.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/BcardEvent"},{"type":"array","items":{"$ref":"#/components/schemas/BcardEvent"}}]}},{"name":"createdFrom","in":"query","description":"Events at or after this instant.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"createdTo","in":"query","description":"Events strictly before this instant.","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BcardPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"BlockedCard","action":"Read"},"description":"Requires the `query` action on `blockedCard` for the supplied runtime context","action":"query","resource":"blockedCard"}}},"/blocked-cards/{blockedCardId}":{"patch":{"tags":["Payment sources"],"description":"Lift the block on a card. Answers with the `Removed` event it appended, not the row you addressed.","operationId":"updateBlockedCard","parameters":[{"name":"blockedCardId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BcardUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BcardUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"BlockedCard","action":"Update"},"description":"Requires the `update` action on `blockedCard` for the supplied runtime context","action":"update","resource":"blockedCard"}}},"/transactions/{transactionId}":{"get":{"tags":["Transactions"],"description":"Return one transaction.","operationId":"getTransaction","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranView","description":"A transaction, a payment taken from a customer on behalf of a merchant."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Transactions","action":"Read"},"description":"Requires the `query` action on `transactions` for the supplied runtime context","action":"query","resource":"transactions"}},"patch":{"tags":["Transactions"],"description":"Capture or cancel an authorisation. Selected by the body's `type`.","operationId":"updateTransaction","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"description":"Required action depends on the request variant","variants":[{"description":"Capture an authorisation","schema":"TranUpdateCapture","actions":[{"grant":{"resource":"Transactions","action":"Pay"},"resource":"transactions","action":"pay"}]},{"description":"Release an authorisation","schema":"TranUpdateCancel","actions":[{"grant":{"resource":"Transactions","action":"Delete"},"resource":"transactions","action":"delete"}]}]}}},"/transactions":{"get":{"tags":["Transactions"],"description":"Return a page of transactions. Supply `page` for offset pagination or `startingAfter` for cursor pagination, and `q` to search. The filters combine with each other and with `q` by AND. `GET /filter-catalogues/transactions` lists those this caller can use. A cursor continues only the walk that issued it: sent with different filters, `q` or `sort`, it is refused with 400.","operationId":"queryTransactions","parameters":[{"name":"q","in":"query","description":"Search. Matches a transaction id, the id of its order or payout, or the reference transaction id, within the creation window the other filters give, the last 30 days by default. An id, an email address, a phone number and any value listed as matched exactly match exactly; any other term matches without regard to case from the start of a value (or of any word in it, beside a longer word of the term), or anywhere in it from three characters, every word of it somewhere; a term that matches nothing so is read again with typos tolerated. Matches come newest first unless `sort` is given.","required":false,"schema":{"type":"string","maxLength":100}},{"name":"page","in":"query","description":"Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"endingBefore","in":"query","description":"Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"Fields to sort by, comma-delimited, in priority order. Prefix a field with `-` for descending.","required":false,"explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/TranSort"}}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/TranColumn"}}},{"name":"status","in":"query","description":"Only transactions whose status is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/TranStatus"},{"type":"array","items":{"$ref":"#/components/schemas/TranStatus"}}]},"x-filter":{"filter":"status","operator":"In","kind":"Enum"}},{"name":"statusNot","in":"query","description":"Leave out transactions whose status is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/TranStatus"},{"type":"array","items":{"$ref":"#/components/schemas/TranStatus"}}]},"x-filter":{"filter":"status","operator":"NotIn","kind":"Enum"}},{"name":"merchantId","in":"query","description":"Only transactions whose merchant is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"merchantId","operator":"In","kind":"Id"}},{"name":"merchantIdNot","in":"query","description":"Leave out transactions whose merchant is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"merchantId","operator":"NotIn","kind":"Id"}},{"name":"customerId","in":"query","description":"Only transactions whose customer is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"customerId","operator":"In","kind":"Id"}},{"name":"customerIdNot","in":"query","description":"Leave out transactions whose customer is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"customerId","operator":"NotIn","kind":"Id"}},{"name":"customerIdAbsent","in":"query","description":"`true` for only transactions with no customer, `false` for only those with one.","required":false,"schema":{"type":"boolean"},"x-filter":{"filter":"customerId","operator":"Absent","kind":"Id"}},{"name":"orderId","in":"query","description":"Only transactions whose order is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"orderId","operator":"In","kind":"Id"}},{"name":"orderIdNot","in":"query","description":"Leave out transactions whose order is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"orderId","operator":"NotIn","kind":"Id"}},{"name":"referenceOrderId","in":"query","description":"Filter by your own reference for the order.","required":false,"schema":{"type":"string","maxLength":200},"x-filter":{"filter":"referenceOrderId","operator":"Equals","kind":"Text"}},{"name":"payoutId","in":"query","description":"Only transactions whose payout is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"payoutId","operator":"In","kind":"Id"}},{"name":"payoutIdNot","in":"query","description":"Leave out transactions whose payout is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"payoutId","operator":"NotIn","kind":"Id"}},{"name":"payoutIdAbsent","in":"query","description":"`true` for only transactions with no payout, `false` for only those with one.","required":false,"schema":{"type":"boolean"},"x-filter":{"filter":"payoutId","operator":"Absent","kind":"Id"}},{"name":"refunded","in":"query","description":"Only transactions with a refund against them, or only those without.","required":false,"schema":{"type":"boolean"},"x-filter":{"filter":"refunded","operator":"Equals","kind":"Boolean"}},{"name":"currency","in":"query","description":"Only transactions whose currency is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/IsoCurrency"},{"type":"array","items":{"$ref":"#/components/schemas/IsoCurrency"}}]},"x-filter":{"filter":"currency","operator":"In","kind":"Currency"}},{"name":"currencyNot","in":"query","description":"Leave out transactions whose currency is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/IsoCurrency"},{"type":"array","items":{"$ref":"#/components/schemas/IsoCurrency"}}]},"x-filter":{"filter":"currency","operator":"NotIn","kind":"Currency"}},{"name":"amount","in":"query","description":"Only transactions of exactly this amount, in minor units of their currency.","required":false,"schema":{"type":"integer","format":"int64"},"x-filter":{"filter":"amount","operator":"Equals","kind":"Amount"}},{"name":"amountAtLeast","in":"query","description":"Only transactions whose amount, in minor units of its currency, is at least this.","required":false,"schema":{"type":"integer","format":"int64"},"x-filter":{"filter":"amount","operator":"AtLeast","kind":"Amount"}},{"name":"amountAtMost","in":"query","description":"Only transactions whose amount, in minor units of its currency, is at most this.","required":false,"schema":{"type":"integer","format":"int64"},"x-filter":{"filter":"amount","operator":"AtMost","kind":"Amount"}},{"name":"amountAbove","in":"query","description":"Only transactions whose amount, in minor units of its currency, is more than this.","required":false,"schema":{"type":"integer","format":"int64"},"x-filter":{"filter":"amount","operator":"Above","kind":"Amount"}},{"name":"amountBelow","in":"query","description":"Only transactions whose amount, in minor units of its currency, is less than this.","required":false,"schema":{"type":"integer","format":"int64"},"x-filter":{"filter":"amount","operator":"Below","kind":"Amount"}},{"name":"createdAfter","in":"query","description":"Only transactions whose creation time is at or after this ISO-8601 timestamp.","required":false,"schema":{"type":"string","format":"date-time"},"x-filter":{"filter":"created","operator":"After","kind":"Instant"}},{"name":"createdBefore","in":"query","description":"Only transactions whose creation time is at or before this ISO-8601 timestamp.","required":false,"schema":{"type":"string","format":"date-time"},"x-filter":{"filter":"created","operator":"Before","kind":"Instant"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Transactions","action":"Read"},"description":"Requires the `query` action on `transactions` for the supplied runtime context","action":"query","resource":"transactions"}},"post":{"tags":["Transactions"],"description":"Take a payment. How the money is taken was decided when the payment token was created.","operationId":"createTransactions","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Orders","action":"Pay"},"description":"Requires the `pay` action on `orders` for the supplied runtime context","action":"pay","resource":"orders"}}},"/transactions/{transactionId}/refunds":{"get":{"tags":["Transactions"],"description":"Return a page of the refunds issued against this transaction. With `status`, the refunds of those statuses are paged by `page` only: `startingAfter` and `endingBefore` are refused with 400.","operationId":"queryTransactionRefunds","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"q","in":"query","description":"Search. Matches a refund id, the id of the transaction or order it refunds, or the gateway's refund id. An id, an email address, a phone number and any value listed as matched exactly match exactly; any other term matches without regard to case from the start of a value (or of any word in it, beside a longer word of the term), or anywhere in it from three characters, every word of it somewhere; a term that matches nothing so is read again with typos tolerated. Closest matches come first unless `sort` is given.","required":false,"schema":{"type":"string","maxLength":100}},{"name":"page","in":"query","description":"Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"endingBefore","in":"query","description":"Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"status","in":"query","description":"Filter by refund status. Repeat the parameter to supply several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/RfndStatus"},{"type":"array","items":{"$ref":"#/components/schemas/RfndStatus"}}]}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RfndPage"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Transactions","action":"Read"},"description":"Requires the `query` action on `transactions` for the supplied runtime context","action":"query","resource":"transactions"}}},"/transactions/{transactionId}/refunds/{refundId}":{"get":{"tags":["Transactions"],"description":"Return one refund of this transaction. A refund that does not belong to this transaction is a 404, not a redirect.","operationId":"getTransactionRefund","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"refundId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RfndView","description":"A refund of part or all of a transaction."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Transactions","action":"Read"},"description":"Requires the `query` action on `transactions` for the supplied runtime context","action":"query","resource":"transactions"}}},"/transactions/{transactionId}/disputes":{"get":{"tags":["Transactions"],"description":"Return a page of the disputes raised against this transaction. A transaction's disputes are few and read as one list, so they page by `page` only: `startingAfter` and `endingBefore` are refused with 400, with or without `q`.","operationId":"queryTransactionDisputes","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"q","in":"query","description":"Search. Matches a dispute id, the id of the transaction or order it disputes, or the gateway's dispute id, the reason or the state. An id, an email address, a phone number and any value listed as matched exactly match exactly; any other term matches without regard to case from the start of a value (or of any word in it, beside a longer word of the term), or anywhere in it from three characters, every word of it somewhere; a term that matches nothing so is read again with typos tolerated. Closest matches come first unless `sort` is given.","required":false,"schema":{"type":"string","maxLength":100}},{"name":"page","in":"query","description":"1-based page number.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"status","in":"query","description":"Filter by dispute status. Repeat the parameter to supply several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/DisputeStatus"},{"type":"array","items":{"$ref":"#/components/schemas/DisputeStatus"}}]}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputePage"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Transactions","action":"Read"},"description":"Requires the `query` action on `transactions` for the supplied runtime context","action":"query","resource":"transactions"}}},"/transactions/{transactionId}/disputes/{disputeId}":{"get":{"tags":["Transactions"],"description":"Return one dispute of this transaction. A dispute that does not belong to this transaction is a 404, not a redirect.","operationId":"getTransactionDispute","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"disputeId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeView","description":"A cardholder's challenge to a transaction, and the platform's response to it."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Transactions","action":"Read"},"description":"Requires the `query` action on `transactions` for the supplied runtime context","action":"query","resource":"transactions"}}},"/filter-catalogues":{"get":{"tags":["Filters"],"description":"Return every filter catalogue this caller may read, one per list. Each is read with its list's own authority, as `x-required-action` lists them, and a list the caller cannot read is not listed.","operationId":"queryFilterCatalogues","parameters":[{"name":"page","in":"query","description":"1-based page number.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/FcatColumn"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FcatPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"description":"Required action depends on `filterCatalogueId`","parameter":"filterCatalogueId","values":[{"value":"transactions","description":"List the `transactions` list's catalogue","actions":[{"grant":{"resource":"Transactions","action":"Read"},"resource":"transactions","action":"query"}]},{"value":"loans","description":"List the `loans` list's catalogue","actions":[{"grant":{"resource":"Loans","action":"Read"},"resource":"loans","action":"query"}]},{"value":"orders","description":"List the `orders` list's catalogue","actions":[{"grant":{"resource":"Orders","action":"Read"},"resource":"orders","action":"query"}]},{"value":"refunds","description":"List the `refunds` list's catalogue","actions":[{"grant":{"resource":"Refunds","action":"Read"},"resource":"refunds","action":"query"}]},{"value":"payouts","description":"List the `payouts` list's catalogue","actions":[{"grant":{"resource":"Merchants","action":"ReadFinancials"},"resource":"merchantFinancials","action":"query"}]},{"value":"disputes","description":"List the `disputes` list's catalogue","actions":[{"grant":{"resource":"Disputes","action":"Read"},"resource":"disputes","action":"query"}]},{"value":"sources","description":"List the `sources` list's catalogue","actions":[{"grant":{"resource":"CustomerPaymentSources","action":"Read"},"resource":"customerPaymentSources","action":"query"}]},{"value":"issuer-transactions","description":"List the `issuer-transactions` list's catalogue","actions":[{"grant":{"resource":"IssuerTransactions","action":"Read"},"resource":"issuerTransactions","action":"query"}]},{"value":"issuer-transaction-exceptions","description":"List the `issuer-transaction-exceptions` list's catalogue","actions":[{"grant":{"resource":"IssuerTransactionDiscrepancies","action":"Read"},"resource":"issuerTransactionDiscrepancies","action":"query"}]},{"value":"cards","description":"List the `cards` list's catalogue","actions":[{"grant":{"resource":"CreditCards","action":"Read"},"resource":"creditCards","action":"query"}]},{"value":"loan-facilities","description":"List the `loan-facilities` list's catalogue","actions":[{"grant":{"resource":"LoanFacilities","action":"Read"},"resource":"loanFacilities","action":"query"}]},{"value":"loan-products","description":"List the `loan-products` list's catalogue","actions":[{"grant":{"resource":"LoanProducts","action":"Read"},"resource":"loanProducts","action":"query"}]},{"value":"loan-agreements","description":"List the `loan-agreements` list's catalogue","actions":[{"grant":{"resource":"LoanMasterAgreements","action":"Read"},"resource":"loanMasterAgreements","action":"query"}]},{"value":"loan-transactions","description":"List the `loan-transactions` list's catalogue","actions":[{"grant":{"resource":"LoanTransactions","action":"Read"},"resource":"loanTransactions","action":"query"}]},{"value":"loan-statements","description":"List the `loan-statements` list's catalogue","actions":[{"grant":{"resource":"LoanStatements","action":"Read"},"resource":"loanStatements","action":"query"}]},{"value":"webhooks","description":"List the `webhooks` list's catalogue","actions":[{"grant":{"resource":"WebhookSubscriptions","action":"Read"},"resource":"webhookSubscriptions","action":"query"}]},{"value":"settlement-entries","description":"List the `settlement-entries` list's catalogue","actions":[{"grant":{"resource":"Merchants","action":"ReadFinancials"},"resource":"merchantFinancials","action":"query"}]},{"value":"journal-entries","description":"List the `journal-entries` list's catalogue","actions":[{"grant":{"resource":"SystemJournalEntries","action":"Read"},"resource":"systemJournalEntries","action":"query"}]},{"value":"merchant-invoices","description":"List the `merchant-invoices` list's catalogue","actions":[{"grant":{"resource":"Merchants","action":"ReadFinancials"},"resource":"merchantFinancials","action":"query"}]},{"value":"merchants","description":"List the `merchants` list's catalogue","actions":[{"grant":{"resource":"Merchants","action":"Read"},"resource":"merchants","action":"query"}]},{"value":"customers","description":"List the `customers` list's catalogue","actions":[{"grant":{"resource":"MerchantCustomers","action":"Read"},"resource":"merchantCustomers","action":"query"}]},{"value":"enterprises","description":"List the `enterprises` list's catalogue","actions":[{"grant":{"resource":"Enterprises","action":"Read"},"resource":"enterprises","action":"query"}]},{"value":"marketplaces","description":"List the `marketplaces` list's catalogue","actions":[{"grant":{"resource":"Marketplaces","action":"Read"},"resource":"marketplaces","action":"query"}]},{"value":"users","description":"List the `users` list's catalogue","actions":[{"grant":{"resource":"Users","action":"Read"},"resource":"users","action":"query"}]},{"value":"roles","description":"List the `roles` list's catalogue","actions":[{"grant":{"resource":"Roles","action":"Read"},"resource":"roles","action":"query"}]},{"value":"files","description":"List the `files` list's catalogue","actions":[{"grant":{"resource":"Merchants","action":"ReadKyb"},"resource":"merchantKyb","action":"query"}]}]}}},"/filter-catalogues/{filterCatalogueId}":{"get":{"tags":["Filters"],"description":"Return one list's filter catalogue for this caller, by the list's collection name, such as `transactions` or `loans`, read with that list's own authority. A list the caller cannot read answers 404.","operationId":"getFilterCatalogue","parameters":[{"name":"filterCatalogueId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Fcat"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"description":"Required action depends on `filterCatalogueId`","parameter":"filterCatalogueId","values":[{"value":"transactions","description":"Read the `transactions` list's catalogue","actions":[{"grant":{"resource":"Transactions","action":"Read"},"resource":"transactions","action":"query"}]},{"value":"loans","description":"Read the `loans` list's catalogue","actions":[{"grant":{"resource":"Loans","action":"Read"},"resource":"loans","action":"query"}]},{"value":"orders","description":"Read the `orders` list's catalogue","actions":[{"grant":{"resource":"Orders","action":"Read"},"resource":"orders","action":"query"}]},{"value":"refunds","description":"Read the `refunds` list's catalogue","actions":[{"grant":{"resource":"Refunds","action":"Read"},"resource":"refunds","action":"query"}]},{"value":"payouts","description":"Read the `payouts` list's catalogue","actions":[{"grant":{"resource":"Merchants","action":"ReadFinancials"},"resource":"merchantFinancials","action":"query"}]},{"value":"disputes","description":"Read the `disputes` list's catalogue","actions":[{"grant":{"resource":"Disputes","action":"Read"},"resource":"disputes","action":"query"}]},{"value":"sources","description":"Read the `sources` list's catalogue","actions":[{"grant":{"resource":"CustomerPaymentSources","action":"Read"},"resource":"customerPaymentSources","action":"query"}]},{"value":"issuer-transactions","description":"Read the `issuer-transactions` list's catalogue","actions":[{"grant":{"resource":"IssuerTransactions","action":"Read"},"resource":"issuerTransactions","action":"query"}]},{"value":"issuer-transaction-exceptions","description":"Read the `issuer-transaction-exceptions` list's catalogue","actions":[{"grant":{"resource":"IssuerTransactionDiscrepancies","action":"Read"},"resource":"issuerTransactionDiscrepancies","action":"query"}]},{"value":"cards","description":"Read the `cards` list's catalogue","actions":[{"grant":{"resource":"CreditCards","action":"Read"},"resource":"creditCards","action":"query"}]},{"value":"loan-facilities","description":"Read the `loan-facilities` list's catalogue","actions":[{"grant":{"resource":"LoanFacilities","action":"Read"},"resource":"loanFacilities","action":"query"}]},{"value":"loan-products","description":"Read the `loan-products` list's catalogue","actions":[{"grant":{"resource":"LoanProducts","action":"Read"},"resource":"loanProducts","action":"query"}]},{"value":"loan-agreements","description":"Read the `loan-agreements` list's catalogue","actions":[{"grant":{"resource":"LoanMasterAgreements","action":"Read"},"resource":"loanMasterAgreements","action":"query"}]},{"value":"loan-transactions","description":"Read the `loan-transactions` list's catalogue","actions":[{"grant":{"resource":"LoanTransactions","action":"Read"},"resource":"loanTransactions","action":"query"}]},{"value":"loan-statements","description":"Read the `loan-statements` list's catalogue","actions":[{"grant":{"resource":"LoanStatements","action":"Read"},"resource":"loanStatements","action":"query"}]},{"value":"webhooks","description":"Read the `webhooks` list's catalogue","actions":[{"grant":{"resource":"WebhookSubscriptions","action":"Read"},"resource":"webhookSubscriptions","action":"query"}]},{"value":"settlement-entries","description":"Read the `settlement-entries` list's catalogue","actions":[{"grant":{"resource":"Merchants","action":"ReadFinancials"},"resource":"merchantFinancials","action":"query"}]},{"value":"journal-entries","description":"Read the `journal-entries` list's catalogue","actions":[{"grant":{"resource":"SystemJournalEntries","action":"Read"},"resource":"systemJournalEntries","action":"query"}]},{"value":"merchant-invoices","description":"Read the `merchant-invoices` list's catalogue","actions":[{"grant":{"resource":"Merchants","action":"ReadFinancials"},"resource":"merchantFinancials","action":"query"}]},{"value":"merchants","description":"Read the `merchants` list's catalogue","actions":[{"grant":{"resource":"Merchants","action":"Read"},"resource":"merchants","action":"query"}]},{"value":"customers","description":"Read the `customers` list's catalogue","actions":[{"grant":{"resource":"MerchantCustomers","action":"Read"},"resource":"merchantCustomers","action":"query"}]},{"value":"enterprises","description":"Read the `enterprises` list's catalogue","actions":[{"grant":{"resource":"Enterprises","action":"Read"},"resource":"enterprises","action":"query"}]},{"value":"marketplaces","description":"Read the `marketplaces` list's catalogue","actions":[{"grant":{"resource":"Marketplaces","action":"Read"},"resource":"marketplaces","action":"query"}]},{"value":"users","description":"Read the `users` list's catalogue","actions":[{"grant":{"resource":"Users","action":"Read"},"resource":"users","action":"query"}]},{"value":"roles","description":"Read the `roles` list's catalogue","actions":[{"grant":{"resource":"Roles","action":"Read"},"resource":"roles","action":"query"}]},{"value":"files","description":"Read the `files` list's catalogue","actions":[{"grant":{"resource":"Merchants","action":"ReadKyb"},"resource":"merchantKyb","action":"query"}]}]}}},"/filter-catalogues/{filterCatalogueId}/filter-values":{"get":{"tags":["Filters"],"description":"Find the values one filter can take for this caller, a page at a time, scoped exactly as the list is. `q` is the search text, at least the filter's `minimumSearch` long. A `Referenced` filter's values are found by the referenced collection's search, run under the list's authority, and each is answered with its id and label only. Pass `nextStartingAfter` back as `startingAfter` for the next page; a cursor continues only the walk that issued it, the same `filter` and `q`, and is refused with 400 otherwise. The walk is forward only, so `endingBefore` and `page` are refused with 400. A `Listed` filter's values are in the catalogue and an `Entered` one's are typed, so both are refused with 400.","operationId":"queryFilterCatalogueFilterValues","parameters":[{"name":"filterCatalogueId","in":"path","required":true,"schema":{"type":"string"}},{"name":"q","in":"query","description":"Search. Matches the label of each value, a merchant's name or a customer's name or email, by the referenced collection's search. An id, an email address, a phone number and any value listed as matched exactly match exactly; any other term matches without regard to case from the start of a value (or of any word in it, beside a longer word of the term), or anywhere in it from three characters, every word of it somewhere; a term that matches nothing so is read again with typos tolerated. Closest matches come first unless `sort` is given.","required":false,"schema":{"type":"string","maxLength":100}},{"name":"startingAfter","in":"query","description":"Cursor pagination, forward only: the `nextStartingAfter` of the page before.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"filter","in":"query","description":"The filter whose values to read, by its `name` in the catalogue. Required.","required":true,"schema":{"type":"string"}},{"name":"value","in":"query","description":"Values already chosen, to read their labels rather than search: a deep link's `merchantId=mcht_...` resolved to the name it shows. Repeat it for several. With `value`, `q` and `startingAfter` are refused with 400.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FcatValuePage"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"description":"Required action depends on `filterCatalogueId`","parameter":"filterCatalogueId","values":[{"value":"transactions","description":"Read the values of the `transactions` list's catalogue","actions":[{"grant":{"resource":"Transactions","action":"Read"},"resource":"transactions","action":"query"}]},{"value":"loans","description":"Read the values of the `loans` list's catalogue","actions":[{"grant":{"resource":"Loans","action":"Read"},"resource":"loans","action":"query"}]},{"value":"orders","description":"Read the values of the `orders` list's catalogue","actions":[{"grant":{"resource":"Orders","action":"Read"},"resource":"orders","action":"query"}]},{"value":"refunds","description":"Read the values of the `refunds` list's catalogue","actions":[{"grant":{"resource":"Refunds","action":"Read"},"resource":"refunds","action":"query"}]},{"value":"payouts","description":"Read the values of the `payouts` list's catalogue","actions":[{"grant":{"resource":"Merchants","action":"ReadFinancials"},"resource":"merchantFinancials","action":"query"}]},{"value":"disputes","description":"Read the values of the `disputes` list's catalogue","actions":[{"grant":{"resource":"Disputes","action":"Read"},"resource":"disputes","action":"query"}]},{"value":"sources","description":"Read the values of the `sources` list's catalogue","actions":[{"grant":{"resource":"CustomerPaymentSources","action":"Read"},"resource":"customerPaymentSources","action":"query"}]},{"value":"issuer-transactions","description":"Read the values of the `issuer-transactions` list's catalogue","actions":[{"grant":{"resource":"IssuerTransactions","action":"Read"},"resource":"issuerTransactions","action":"query"}]},{"value":"issuer-transaction-exceptions","description":"Read the values of the `issuer-transaction-exceptions` list's catalogue","actions":[{"grant":{"resource":"IssuerTransactionDiscrepancies","action":"Read"},"resource":"issuerTransactionDiscrepancies","action":"query"}]},{"value":"cards","description":"Read the values of the `cards` list's catalogue","actions":[{"grant":{"resource":"CreditCards","action":"Read"},"resource":"creditCards","action":"query"}]},{"value":"loan-facilities","description":"Read the values of the `loan-facilities` list's catalogue","actions":[{"grant":{"resource":"LoanFacilities","action":"Read"},"resource":"loanFacilities","action":"query"}]},{"value":"loan-products","description":"Read the values of the `loan-products` list's catalogue","actions":[{"grant":{"resource":"LoanProducts","action":"Read"},"resource":"loanProducts","action":"query"}]},{"value":"loan-agreements","description":"Read the values of the `loan-agreements` list's catalogue","actions":[{"grant":{"resource":"LoanMasterAgreements","action":"Read"},"resource":"loanMasterAgreements","action":"query"}]},{"value":"loan-transactions","description":"Read the values of the `loan-transactions` list's catalogue","actions":[{"grant":{"resource":"LoanTransactions","action":"Read"},"resource":"loanTransactions","action":"query"}]},{"value":"loan-statements","description":"Read the values of the `loan-statements` list's catalogue","actions":[{"grant":{"resource":"LoanStatements","action":"Read"},"resource":"loanStatements","action":"query"}]},{"value":"webhooks","description":"Read the values of the `webhooks` list's catalogue","actions":[{"grant":{"resource":"WebhookSubscriptions","action":"Read"},"resource":"webhookSubscriptions","action":"query"}]},{"value":"settlement-entries","description":"Read the values of the `settlement-entries` list's catalogue","actions":[{"grant":{"resource":"Merchants","action":"ReadFinancials"},"resource":"merchantFinancials","action":"query"}]},{"value":"journal-entries","description":"Read the values of the `journal-entries` list's catalogue","actions":[{"grant":{"resource":"SystemJournalEntries","action":"Read"},"resource":"systemJournalEntries","action":"query"}]},{"value":"merchant-invoices","description":"Read the values of the `merchant-invoices` list's catalogue","actions":[{"grant":{"resource":"Merchants","action":"ReadFinancials"},"resource":"merchantFinancials","action":"query"}]},{"value":"merchants","description":"Read the values of the `merchants` list's catalogue","actions":[{"grant":{"resource":"Merchants","action":"Read"},"resource":"merchants","action":"query"}]},{"value":"customers","description":"Read the values of the `customers` list's catalogue","actions":[{"grant":{"resource":"MerchantCustomers","action":"Read"},"resource":"merchantCustomers","action":"query"}]},{"value":"enterprises","description":"Read the values of the `enterprises` list's catalogue","actions":[{"grant":{"resource":"Enterprises","action":"Read"},"resource":"enterprises","action":"query"}]},{"value":"marketplaces","description":"Read the values of the `marketplaces` list's catalogue","actions":[{"grant":{"resource":"Marketplaces","action":"Read"},"resource":"marketplaces","action":"query"}]},{"value":"users","description":"Read the values of the `users` list's catalogue","actions":[{"grant":{"resource":"Users","action":"Read"},"resource":"users","action":"query"}]},{"value":"roles","description":"Read the values of the `roles` list's catalogue","actions":[{"grant":{"resource":"Roles","action":"Read"},"resource":"roles","action":"query"}]},{"value":"files","description":"Read the values of the `files` list's catalogue","actions":[{"grant":{"resource":"Merchants","action":"ReadKyb"},"resource":"merchantKyb","action":"query"}]}]}}},"/orders/{orderId}":{"get":{"tags":["Orders"],"description":"Return one order.","operationId":"getOrder","parameters":[{"name":"orderId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrdrView"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Orders","action":"Read"},"description":"Requires the `query` action on `orders` for the supplied runtime context","action":"query","resource":"orders"}},"patch":{"tags":["Orders"],"description":"Update an order's own details, cancel it, reissue its payment link or send it. Selected by the body's `type`.","operationId":"updateOrder","parameters":[{"name":"orderId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrdrUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrdrUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"description":"Required action depends on the request variant","variants":[{"description":"Cancel an unpaid order","schema":"OrdrUpdateCancel","actions":[{"grant":{"resource":"Orders","action":"Delete"},"resource":"orders","action":"delete"}]},{"description":"Change an order's own details","schema":"OrdrUpdateDetails","actions":[{"grant":{"resource":"Orders","action":"Update"},"resource":"orders","action":"update"}]},{"description":"Issue a new payment link","schema":"OrdrUpdateReissuePaymentLink","actions":[{"grant":{"resource":"Orders","action":"Update"},"resource":"orders","action":"update"}]},{"description":"Send the existing payment link","schema":"OrdrUpdateSendPaymentLink","actions":[{"grant":{"resource":"Orders","action":"Update"},"resource":"orders","action":"update"}]}]}}},"/orders":{"get":{"tags":["Orders"],"description":"Return a page of orders. Supply `page` for offset pagination or `startingAfter` for cursor pagination, and `q` to search. The filters combine with each other and with `q` by AND. `GET /filter-catalogues/orders` lists those this caller can use. A cursor continues only the walk that issued it: sent with different filters, `q` or `sort`, it is refused with 400. One issued before the list named its walks resumes as it did.","operationId":"queryOrders","parameters":[{"name":"q","in":"query","description":"Free-text search. Supplying it engages the search index; omit it to filter only.","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"endingBefore","in":"query","description":"Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"Fields to sort by, comma-delimited, in priority order. Prefix a field with `-` for descending.","required":false,"explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/OrdrSort"}}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/OrdrColumn"}}},{"name":"status","in":"query","description":"Only orders whose status is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/OrdrStatus"},{"type":"array","items":{"$ref":"#/components/schemas/OrdrStatus"}}]},"x-filter":{"filter":"status","operator":"In","kind":"Enum"}},{"name":"orderType","in":"query","description":"Only orders whose kind is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/OrdrType"},{"type":"array","items":{"$ref":"#/components/schemas/OrdrType"}}]},"x-filter":{"filter":"orderType","operator":"In","kind":"Enum"}},{"name":"merchantId","in":"query","description":"Only orders whose merchant is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"merchantId","operator":"In","kind":"Id"}},{"name":"marketplaceId","in":"query","description":"Only orders whose marketplace is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"marketplaceId","operator":"In","kind":"Id"}},{"name":"referenceOrderId","in":"query","description":"Filter by your own identifier for the order.","required":false,"schema":{"type":"string"},"x-filter":{"filter":"referenceOrderId","operator":"Equals","kind":"Text"}},{"name":"currency","in":"query","description":"Only orders whose currency is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/IsoCurrency"},{"type":"array","items":{"$ref":"#/components/schemas/IsoCurrency"}}]},"x-filter":{"filter":"currency","operator":"In","kind":"Currency"}},{"name":"amountFrom","in":"query","description":"Only orders whose total, in the minor units of `currency`, is at least this.","required":false,"schema":{"type":"integer","format":"int64"},"x-filter":{"filter":"amount","operator":"AtLeast","kind":"Amount"}},{"name":"amountTo","in":"query","description":"Only orders whose total, in the minor units of `currency`, is at most this.","required":false,"schema":{"type":"integer","format":"int64"},"x-filter":{"filter":"amount","operator":"AtMost","kind":"Amount"}},{"name":"createdAfter","in":"query","description":"Only orders whose creation time is at or after this ISO-8601 timestamp.","required":false,"schema":{"type":"string","format":"date-time"},"x-filter":{"filter":"created","operator":"After","kind":"Instant"}},{"name":"createdBefore","in":"query","description":"Only orders whose creation time is before, and not at, this ISO-8601 timestamp.","required":false,"schema":{"type":"string","format":"date-time"},"x-filter":{"filter":"created","operator":"Before","kind":"Instant"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrdrPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Orders","action":"Read"},"description":"Requires the `query` action on `orders` for the supplied runtime context","action":"query","resource":"orders"}},"post":{"tags":["Orders"],"description":"Create an order, optionally with a payment link. Selected by the body's `type`.","operationId":"createOrders","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrdrCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrdrCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Orders","action":"Create"},"description":"Requires the `create` action on `orders` for the supplied runtime context","action":"create","resource":"orders"}}},"/loans/{loanId}":{"get":{"tags":["Loans"],"description":"Return one loan.","operationId":"getLoan","parameters":[{"name":"loanId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoanView","description":"A loan, a revolving facility a borrower draws against."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Loans","action":"Read"},"description":"Requires the `query` action on `loans` for the supplied runtime context","action":"query","resource":"loans"}},"patch":{"tags":["Loans"],"description":"Update a loan's mutable attributes, including its status and its limit, or replace or clear its statement settings. Answers with the loan, and with the statement settings where the patch changed them.","operationId":"updateLoan","parameters":[{"name":"loanId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoanUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoanUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Loans","action":"Update"},"description":"Requires the `update` action on `loans` for the supplied runtime context","action":"update","resource":"loans"}}},"/loans":{"get":{"tags":["Loans"],"description":"Return a page of loans. Supply `page` for offset pagination or `startingAfter` for cursor pagination, and `q` to search. The filters combine with each other and with `q` by AND. `GET /filter-catalogues/loans` lists those this caller can use. A cursor continues only the walk that issued it: sent with different filters, `q` or `sort`, it is refused with 400.","operationId":"queryLoans","parameters":[{"name":"q","in":"query","description":"Search. Matches a loan id, the id of its product or facility, the reference loan id, the account name or the EDI number. An id, an email address, a phone number and any value listed as matched exactly match exactly; any other term matches without regard to case from the start of a value (or of any word in it, beside a longer word of the term), or anywhere in it from three characters, every word of it somewhere; a term that matches nothing so is read again with typos tolerated. Closest matches come first unless `sort` is given.","required":false,"schema":{"type":"string","maxLength":100}},{"name":"page","in":"query","description":"Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"endingBefore","in":"query","description":"Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"Fields to sort by, comma-delimited, in priority order. Prefix a field with `-` for descending.","required":false,"explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/LoanSort"}}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/LoanColumn"}}},{"name":"status","in":"query","description":"Only loans whose status is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/LoanStatus"},{"type":"array","items":{"$ref":"#/components/schemas/LoanStatus"}}]},"x-filter":{"filter":"status","operator":"In","kind":"Enum"}},{"name":"statusNot","in":"query","description":"Leave out loans whose status is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/LoanStatus"},{"type":"array","items":{"$ref":"#/components/schemas/LoanStatus"}}]},"x-filter":{"filter":"status","operator":"NotIn","kind":"Enum"}},{"name":"merchantId","in":"query","description":"Only loans whose borrowing merchant is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"merchantId","operator":"In","kind":"Id"}},{"name":"merchantIdNot","in":"query","description":"Leave out loans whose borrowing merchant is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"merchantId","operator":"NotIn","kind":"Id"}},{"name":"marketplaceId","in":"query","description":"Only loans whose marketplace is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"marketplaceId","operator":"In","kind":"Id"}},{"name":"marketplaceIdNot","in":"query","description":"Leave out loans whose marketplace is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"marketplaceId","operator":"NotIn","kind":"Id"}},{"name":"marketplaceIdAbsent","in":"query","description":"`true` for only loans with no marketplace, `false` for only those with one.","required":false,"schema":{"type":"boolean"},"x-filter":{"filter":"marketplaceId","operator":"Absent","kind":"Id"}},{"name":"customerId","in":"query","description":"Only loans whose borrowing customer is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"customerId","operator":"In","kind":"Id"}},{"name":"customerIdNot","in":"query","description":"Leave out loans whose borrowing customer is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"customerId","operator":"NotIn","kind":"Id"}},{"name":"customerIdAbsent","in":"query","description":"`true` for only loans with no borrowing customer, `false` for only those with one.","required":false,"schema":{"type":"boolean"},"x-filter":{"filter":"customerId","operator":"Absent","kind":"Id"}},{"name":"productType","in":"query","description":"Only loans whose kind is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/LprodType"},{"type":"array","items":{"$ref":"#/components/schemas/LprodType"}}]},"x-filter":{"filter":"productType","operator":"In","kind":"Enum"}},{"name":"productTypeNot","in":"query","description":"Leave out loans whose kind is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/LprodType"},{"type":"array","items":{"$ref":"#/components/schemas/LprodType"}}]},"x-filter":{"filter":"productType","operator":"NotIn","kind":"Enum"}},{"name":"currency","in":"query","description":"Only loans whose currency is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/IsoCurrency"},{"type":"array","items":{"$ref":"#/components/schemas/IsoCurrency"}}]},"x-filter":{"filter":"currency","operator":"In","kind":"Currency"}},{"name":"currencyNot","in":"query","description":"Leave out loans whose currency is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/IsoCurrency"},{"type":"array","items":{"$ref":"#/components/schemas/IsoCurrency"}}]},"x-filter":{"filter":"currency","operator":"NotIn","kind":"Currency"}},{"name":"referenceLoanId","in":"query","description":"Filter by your own identifier for the loan.","required":false,"schema":{"type":"string","maxLength":200},"x-filter":{"filter":"referenceLoanId","operator":"Equals","kind":"Text"}},{"name":"createdAfter","in":"query","description":"Only loans whose creation time is at or after this ISO-8601 timestamp.","required":false,"schema":{"type":"string","format":"date-time"},"x-filter":{"filter":"created","operator":"After","kind":"Instant"}},{"name":"createdBefore","in":"query","description":"Only loans whose creation time is at or before this ISO-8601 timestamp.","required":false,"schema":{"type":"string","format":"date-time"},"x-filter":{"filter":"created","operator":"Before","kind":"Instant"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoanPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Loans","action":"Read"},"description":"Requires the `query` action on `loans` for the supplied runtime context","action":"query","resource":"loans"}},"post":{"tags":["Loans"],"description":"Apply for a loan, or accept an offer. Selected by the body's `type`. Applying answers with an offer; accepting it answers with the loan.","operationId":"createLoans","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoanCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoanCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"description":"Required action depends on the request variant","variants":[{"description":"Apply for a loan","schema":"LoanCmdApply","actions":[{"grant":{"resource":"Loans","action":"Apply"},"resource":"loans","action":"apply"}]},{"description":"Accept a loan offer","schema":"LoanCmdAcceptOffer","actions":[{"grant":{"resource":"Loans","action":"Activate"},"resource":"loans","action":"activate"}]}]}}},"/loans/{loanId}/statement-settings":{"get":{"tags":["Loans"],"description":"Return how this loan's statement documents are produced and delivered. `LoanStatementSettingsNotConfigured` means none are set: the loan's statements get CSV and PDF and nothing is mailed. The transfer secret is never returned; `secretSet` says whether one is stored. Settings imported from APG read back as stored and may fail validation when sent back: `,`-joined or malformed addresses are refused until corrected. Needs `Loans_Update`, as changing them does, with `LoanUpdateStatementSettings` or `LoanUpdateClearStatementSettings` on the loan's `PATCH`.","operationId":"getLoanStatementSetting","parameters":[{"name":"loanId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoanStatementSettings"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Loans","action":"Update"},"description":"Requires the `update` action on `loans` for the supplied runtime context","action":"update","resource":"loans"}}},"/users/{userId}":{"get":{"tags":["Identity"],"description":"Return one user.","operationId":"getUser","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserView","description":"A user, a person or a service principal that authenticates."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Users","action":"Read"},"description":"Requires the `query` action on `users` for the supplied runtime context","action":"query","resource":"users"}},"patch":{"tags":["Identity"],"description":"Change a user's name, identifiers, permissions or status.","operationId":"updateUser","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Users","action":"Update"},"description":"Requires the `update` action on `users` for the supplied runtime context","action":"update","resource":"users"}}},"/users":{"get":{"tags":["Identity"],"description":"Return a page of users. Supply `page` for offset pagination or `startingAfter` for cursor pagination, and `q` to search. `GET /filter-catalogues/users` lists the filters this caller can use. A cursor continues only the walk that issued it: sent with different filters, `q` or `sort`, it is refused with 400.","operationId":"queryUsers","parameters":[{"name":"q","in":"query","description":"Search. Matches a user id, the display name, or the whole email address or phone number the user signs in with. An id, an email address, a phone number and any value listed as matched exactly match exactly; any other term matches without regard to case from the start of a value (or of any word in it, beside a longer word of the term), or anywhere in it from three characters, every word of it somewhere; a term that matches nothing so is read again with typos tolerated. Closest matches come first unless `sort` is given.","required":false,"schema":{"type":"string","maxLength":100}},{"name":"page","in":"query","description":"Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"endingBefore","in":"query","description":"Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"Fields to sort by, comma-delimited, in priority order. Prefix a field with `-` for descending.","required":false,"explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserSort"}}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserColumn"}}},{"name":"userId","in":"query","description":"Only users whose id is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"userId","operator":"In","kind":"Id"}},{"name":"status","in":"query","description":"Only users whose status is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/UserStatus"},{"type":"array","items":{"$ref":"#/components/schemas/UserStatus"}}]},"x-filter":{"filter":"status","operator":"In","kind":"Enum"}},{"name":"enterpriseId","in":"query","description":"Only users whose enterprise is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"enterpriseId","operator":"In","kind":"Id"}},{"name":"marketplaceId","in":"query","description":"Only users whose marketplace is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"marketplaceId","operator":"In","kind":"Id"}},{"name":"merchantId","in":"query","description":"Only users whose merchant is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"merchantId","operator":"In","kind":"Id"}},{"name":"customerId","in":"query","description":"Only users whose customer is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"customerId","operator":"In","kind":"Id"}},{"name":"delegateId","in":"query","description":"Only users whose delegate is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"delegateId","operator":"In","kind":"Text"}},{"name":"emailAddress","in":"query","description":"Only users whose email address is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"emailAddress","operator":"In","kind":"Text"}},{"name":"phoneNumber","in":"query","description":"Only users whose phone number is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"phoneNumber","operator":"In","kind":"Text"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Users","action":"Read"},"description":"Requires the `query` action on `users` for the supplied runtime context","action":"query","resource":"users"}},"post":{"tags":["Identity"],"description":"Create a user.","operationId":"createUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Users","action":"Create"},"description":"Requires the `create` action on `users` for the supplied runtime context","action":"create","resource":"users"}}},"/marketplaces/{marketplaceId}":{"get":{"tags":["Marketplaces"],"description":"Return one marketplace, with its bank-transfer details and source rules.","operationId":"getMarketplace","parameters":[{"name":"marketplaceId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MktpView","description":"A marketplace, a platform whose sub-merchants take payments under it."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Marketplaces","action":"Read"},"description":"Requires the `query` action on `marketplaces` for the supplied runtime context","action":"query","resource":"marketplaces"}},"patch":{"tags":["Marketplaces"],"description":"Set up bank transfers, replace the source rules, or set who collects sub-merchant invoice fees. One change per call.","operationId":"updateMarketplace","parameters":[{"name":"marketplaceId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MktpUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MktpUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Marketplaces","action":"Update"},"description":"Requires the `update` action on `marketplaces` for the supplied runtime context","action":"update","resource":"marketplaces"}}},"/marketplaces":{"get":{"tags":["Marketplaces"],"description":"Return a page of marketplaces, the platform's read. Narrow it by `enterpriseId` and `status`, any of those given, or leave some out with `enterpriseIdNot` and `statusNot`. `GET /filter-catalogues/marketplaces` lists the filters this caller can use. A cursor continues only the walk that issued it: sent with different filters, `q` or `sort`, it is refused with 400.","operationId":"queryMarketplaces","parameters":[{"name":"q","in":"query","description":"Search. Matches a marketplace id, the id of its enterprise, the business name, the slug, the company email address or the company phone number. An id, an email address, a phone number and any value listed as matched exactly match exactly; any other term matches without regard to case from the start of a value (or of any word in it, beside a longer word of the term), or anywhere in it from three characters, every word of it somewhere; a term that matches nothing so is read again with typos tolerated. Closest matches come first unless `sort` is given.","required":false,"schema":{"type":"string","maxLength":100}},{"name":"page","in":"query","description":"Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"endingBefore","in":"query","description":"Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"Fields to sort by, comma-delimited, in priority order. Prefix a field with `-` for descending.","required":false,"explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/MktpSort"}}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/MktpColumn"}}},{"name":"enterpriseId","in":"query","description":"Only marketplaces whose enterprise is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"enterpriseId","operator":"In","kind":"Id"}},{"name":"enterpriseIdNot","in":"query","description":"Leave out marketplaces whose enterprise is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"enterpriseId","operator":"NotIn","kind":"Id"}},{"name":"status","in":"query","description":"Only marketplaces whose status is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/MktpStatus"},{"type":"array","items":{"$ref":"#/components/schemas/MktpStatus"}}]},"x-filter":{"filter":"status","operator":"In","kind":"Enum"}},{"name":"statusNot","in":"query","description":"Leave out marketplaces whose status is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/MktpStatus"},{"type":"array","items":{"$ref":"#/components/schemas/MktpStatus"}}]},"x-filter":{"filter":"status","operator":"NotIn","kind":"Enum"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MktpPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Marketplaces","action":"Read"},"description":"Requires the `query` action on `marketplaces` for the supplied runtime context","action":"query","resource":"marketplaces"}},"post":{"tags":["Marketplaces"],"description":"Create a marketplace. The response carries its first API key, once, and nowhere else.","operationId":"createMarketplaces","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MktpCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MktpCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Marketplaces","action":"Update"},"description":"Requires the `update` action on `marketplaces` for the supplied runtime context","action":"update","resource":"marketplaces"}}},"/marketplaces/{marketplaceId}/settings":{"get":{"tags":["Marketplaces"],"description":"Return the defaults sub-merchants inherit, and the tax countries this marketplace can create them in. The defaults are absent where you may not read them, which is the same answer as having none.","operationId":"getMarketplaceSetting","parameters":[{"name":"marketplaceId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MktpSettings"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Marketplaces","action":"Read"},"description":"Requires the `query` action on `marketplaces` for the supplied runtime context","action":"query","resource":"marketplaces"}}},"/marketplaces/{marketplaceId}/country-settings":{"get":{"tags":["Marketplaces"],"description":"Return the marketplace's profile and sub-merchant template for one tax country. Sections you may not read are absent.","operationId":"getMarketplaceCountrySetting","parameters":[{"name":"marketplaceId","in":"path","required":true,"schema":{"type":"string"}},{"name":"taxCountry","in":"query","description":"ISO 3166-1 alpha-2. Required, a marketplace's profile is per tax country, so there is no template to read without one.","required":true,"schema":{"$ref":"#/components/schemas/IsoCountry"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MktpCountrySettings"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Marketplaces","action":"Read"},"description":"Requires the `query` action on `marketplaces` for the supplied runtime context","action":"query","resource":"marketplaces"}}},"/payouts/{payoutId}":{"get":{"tags":["Payouts"],"description":"Return one payout, with what it is made of.","operationId":"getPayout","parameters":[{"name":"payoutId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutView","description":"A payout, money the platform sent to a merchant's bank account."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Merchants","action":"ReadFinancials"},"description":"Requires the `query` action on `merchantFinancials` for the supplied runtime context","action":"query","resource":"merchantFinancials"}},"patch":{"tags":["Payouts"],"description":"Record an out-of-band settlement, reverse a payout, release a suspended one, push one through a disbursement run, or make its statement again or mail it again.","operationId":"updatePayout","parameters":[{"name":"payoutId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Merchants","action":"UpdateFinancials"},"description":"Requires the `update` action on `merchantFinancials` for the supplied runtime context","action":"update","resource":"merchantFinancials"}}},"/payouts":{"get":{"tags":["Payouts"],"description":"Return a page of payouts. Filter by `reference` to answer a question about a bank statement line. `composition` is not populated on a page. The filters combine with each other and with `q` by AND. `GET /filter-catalogues/payouts` lists those this caller can use. A cursor continues only the walk that issued it: sent with different filters, `q` or `sort`, it is refused with 400. One issued before the list named its walks resumes as it did.","operationId":"queryPayouts","parameters":[{"name":"q","in":"query","description":"Search. Matches a payout id, the reference payout id, the statement descriptor or the narrative. An id, an email address, a phone number and any value listed as matched exactly match exactly; any other term matches without regard to case from the start of a value (or of any word in it, beside a longer word of the term), or anywhere in it from three characters, every word of it somewhere; a term that matches nothing so is read again with typos tolerated. Closest matches come first unless `sort` is given.","required":false,"schema":{"type":"string","maxLength":100}},{"name":"page","in":"query","description":"Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"endingBefore","in":"query","description":"Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"Fields to sort by, comma-delimited, in priority order. Prefix a field with `-` for descending.","required":false,"explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/PayoutSort"}}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/PayoutColumn"}}},{"name":"status","in":"query","description":"Only payouts whose status is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/PayoutStatus"},{"type":"array","items":{"$ref":"#/components/schemas/PayoutStatus"}}]},"x-filter":{"filter":"status","operator":"In","kind":"Enum"}},{"name":"payoutId","in":"query","description":"Only payouts whose payout is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"payoutId","operator":"In","kind":"Id"}},{"name":"merchantId","in":"query","description":"Only payouts whose merchant is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"merchantId","operator":"In","kind":"Id"}},{"name":"marketplaceId","in":"query","description":"Only payouts whose marketplace is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"marketplaceId","operator":"In","kind":"Id"}},{"name":"enterpriseId","in":"query","description":"Only payouts whose enterprise is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"enterpriseId","operator":"In","kind":"Id"}},{"name":"reference","in":"query","description":"Only payouts whose reference is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"reference","operator":"In","kind":"Text"}},{"name":"disbursementId","in":"query","description":"Only payouts whose disbursement is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"disbursementId","operator":"In","kind":"Text"}},{"name":"currency","in":"query","description":"Only payouts whose currency is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/IsoCurrency"},{"type":"array","items":{"$ref":"#/components/schemas/IsoCurrency"}}]},"x-filter":{"filter":"currency","operator":"In","kind":"Currency"}},{"name":"amountFrom","in":"query","description":"Only payouts whose amount, in minor units of `currency`, is at least this.","required":false,"schema":{"type":"integer","format":"int64"},"x-filter":{"filter":"amount","operator":"AtLeast","kind":"Amount"}},{"name":"amountTo","in":"query","description":"Only payouts whose amount, in minor units of `currency`, is at most this.","required":false,"schema":{"type":"integer","format":"int64"},"x-filter":{"filter":"amount","operator":"AtMost","kind":"Amount"}},{"name":"settlingFrom","in":"query","description":"Only payouts whose settlement date is at or after this ISO-8601 date.","required":false,"schema":{"type":"string","format":"date"},"x-filter":{"filter":"settling","operator":"After","kind":"Date"}},{"name":"settlingTo","in":"query","description":"Only payouts whose settlement date is at or before this ISO-8601 date.","required":false,"schema":{"type":"string","format":"date"},"x-filter":{"filter":"settling","operator":"Before","kind":"Date"}},{"name":"createdAfter","in":"query","description":"Only payouts whose creation time is at or after this ISO-8601 timestamp.","required":false,"schema":{"type":"string","format":"date-time"},"x-filter":{"filter":"created","operator":"After","kind":"Instant"}},{"name":"createdBefore","in":"query","description":"Only payouts whose creation time is before, and not at, this ISO-8601 timestamp.","required":false,"schema":{"type":"string","format":"date-time"},"x-filter":{"filter":"created","operator":"Before","kind":"Instant"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Merchants","action":"ReadFinancials"},"description":"Requires the `query` action on `merchantFinancials` for the supplied runtime context","action":"query","resource":"merchantFinancials"}},"post":{"tags":["Payouts"],"description":"Raise a payout by hand, for the credential's own merchant.","operationId":"createPayouts","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Merchants","action":"UpdateFinancials"},"description":"Requires the `update` action on `merchantFinancials` for the supplied runtime context","action":"update","resource":"merchantFinancials"}}},"/payouts/{payoutId}/documents":{"get":{"tags":["Payouts"],"description":"Return the documents made for the payout's statement, each with where it got to: its format, its status and its mail. A payout has few, so they page by `page` only.","operationId":"queryPayoutDocuments","parameters":[{"name":"payoutId","in":"path","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"1-based page number.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutDocumentPage"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Merchants","action":"ReadFinancials"},"description":"Requires the `query` action on `merchantFinancials` for the supplied runtime context","action":"query","resource":"merchantFinancials"}}},"/payouts/{payoutId}/documents/{format}":{"get":{"tags":["Payouts"],"description":"Return the payout's statement as the file itself, under its own media type: `text/csv` for `Csv`, `application/pdf` for `Pdf`,\n`application/xml` for `Xml`. `Content-Disposition` names the file; the name is stated here too, because generated clients drop headers.\nA statement not made yet is a `404`.","operationId":"getPayoutDocument","parameters":[{"name":"payoutId","in":"path","required":true,"schema":{"type":"string"}},{"name":"format","in":"path","description":"Which document. It also fixes the response's `Content-Type`.","required":true,"schema":{"$ref":"#/components/schemas/PayoutStatementFormat"}}],"responses":{"200":{"description":"","headers":{"Content-Disposition":{"description":"`attachment` with the file's name: `filename`, plus `filename*` (RFC 5987) when the name is not printable ASCII.","required":true,"schema":{"type":"string"}}},"content":{"text/csv":{"schema":{"type":"string","format":"binary"}},"application/pdf":{"schema":{"type":"string","format":"binary"}},"application/xml":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Merchants","action":"ReadFinancials"},"description":"Requires the `query` action on `merchantFinancials` for the supplied runtime context","action":"query","resource":"merchantFinancials"}}},"/refunds/{refundId}":{"get":{"tags":["Transactions"],"description":"Return one refund.","operationId":"getRefund","parameters":[{"name":"refundId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RfndView","description":"A refund of part or all of a transaction."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Refunds","action":"Read"},"description":"Requires the `query` action on `refunds` for the supplied runtime context","action":"query","resource":"refunds"}}},"/refunds":{"get":{"tags":["Transactions"],"description":"Return a page of refunds, one entry per refund: `limit` and `totalCount` count refunds, not the transactions they refund. Supply `page` for offset pagination or `startingAfter` for cursor pagination. The filters combine with each other and with `q` by AND. `GET /filter-catalogues/refunds` lists those this caller can use. A cursor continues only the walk that issued it: sent with different filters, `q` or `sort`, it is refused with 400. One issued before the list named its walks resumes as it did.","operationId":"queryRefunds","parameters":[{"name":"q","in":"query","description":"Search. Matches a refund id, the id of the transaction or order it refunds, or the gateway's refund id. An id, an email address, a phone number and any value listed as matched exactly match exactly; any other term matches without regard to case from the start of a value (or of any word in it, beside a longer word of the term), or anywhere in it from three characters, every word of it somewhere; a term that matches nothing so is read again with typos tolerated. Closest matches come first unless `sort` is given.","required":false,"schema":{"type":"string","maxLength":100}},{"name":"page","in":"query","description":"Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"endingBefore","in":"query","description":"Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/RfndColumn"}}},{"name":"merchantId","in":"query","description":"Only refunds whose merchant is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"merchantId","operator":"In","kind":"Id"}},{"name":"transactionId","in":"query","description":"Only refunds whose payment is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"transactionId","operator":"In","kind":"Id"}},{"name":"customerId","in":"query","description":"Only refunds whose customer is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"customerId","operator":"In","kind":"Id"}},{"name":"orderId","in":"query","description":"Only refunds whose order is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"orderId","operator":"In","kind":"Id"}},{"name":"referenceOrderId","in":"query","description":"Filter by your own reference for the order.","required":false,"schema":{"type":"string"},"x-filter":{"filter":"referenceOrderId","operator":"Equals","kind":"Text"}},{"name":"amount","in":"query","description":"Filter to refunds of exactly this amount, in minor units.","required":false,"schema":{"type":"integer","format":"int64"},"x-filter":{"filter":"amount","operator":"Equals","kind":"Amount"}},{"name":"currency","in":"query","description":"Only refunds whose currency is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/IsoCurrency"},{"type":"array","items":{"$ref":"#/components/schemas/IsoCurrency"}}]},"x-filter":{"filter":"currency","operator":"In","kind":"Currency"}},{"name":"createdAfter","in":"query","description":"Only refunds whose creation time is at or after this ISO-8601 timestamp.","required":false,"schema":{"type":"string","format":"date-time"},"x-filter":{"filter":"created","operator":"After","kind":"Instant"}},{"name":"createdBefore","in":"query","description":"Only refunds whose creation time is at or before this ISO-8601 timestamp.","required":false,"schema":{"type":"string","format":"date-time"},"x-filter":{"filter":"created","operator":"Before","kind":"Instant"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RfndPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Refunds","action":"Read"},"description":"Requires the `query` action on `refunds` for the supplied runtime context","action":"query","resource":"refunds"}},"post":{"tags":["Transactions"],"description":"Refund part or all of a transaction, acquiring or issuing.","operationId":"createRefunds","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RfndCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RfndCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Refunds","action":"Create"},"description":"Requires the `create` action on `refunds` for the supplied runtime context","action":"create","resource":"refunds"}}},"/disputes/{disputeId}":{"get":{"tags":["Transactions"],"description":"Return one dispute.","operationId":"getDispute","parameters":[{"name":"disputeId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeView","description":"A cardholder's challenge to a transaction, and the platform's response to it."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Disputes","action":"Read"},"description":"Requires the `query` action on `disputes` for the supplied runtime context","action":"query","resource":"disputes"}},"patch":{"tags":["Transactions"],"description":"Record an outcome the scheme decided out of band, submit evidence, or move the case on.","operationId":"updateDispute","parameters":[{"name":"disputeId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Disputes","action":"Update"},"description":"Requires the `update` action on `disputes` for the supplied runtime context","action":"update","resource":"disputes"}}},"/disputes":{"get":{"tags":["Transactions"],"description":"Return a page of disputes. Supply `page` for offset pagination or `startingAfter` for cursor pagination, and `q` to search. The filters combine with each other and with `q` by AND. `GET /filter-catalogues/disputes` lists those this caller can use. A cursor continues only the walk that issued it: sent with different filters, `q` or `sort`, it is refused with 400. One issued before the list named its walks resumes as it did.","operationId":"queryDisputes","parameters":[{"name":"q","in":"query","description":"Search. Matches a dispute id, the id of the transaction or order it disputes, or the gateway's dispute id, the reason or the state. An id, an email address, a phone number and any value listed as matched exactly match exactly; any other term matches without regard to case from the start of a value (or of any word in it, beside a longer word of the term), or anywhere in it from three characters, every word of it somewhere; a term that matches nothing so is read again with typos tolerated. Closest matches come first unless `sort` is given.","required":false,"schema":{"type":"string","maxLength":100}},{"name":"page","in":"query","description":"Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"endingBefore","in":"query","description":"Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"Fields to sort by, comma-delimited, in priority order. Prefix a field with `-` for descending.","required":false,"explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/DisputeSort"}}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/DisputeColumn"}}},{"name":"merchantId","in":"query","description":"Only disputes whose merchant is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"merchantId","operator":"In","kind":"Id"}},{"name":"transactionId","in":"query","description":"Only disputes whose payment is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"transactionId","operator":"In","kind":"Id"}},{"name":"orderId","in":"query","description":"Only disputes whose order is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"orderId","operator":"In","kind":"Id"}},{"name":"referenceOrderId","in":"query","description":"Filter by your own reference for the order.","required":false,"schema":{"type":"string"},"x-filter":{"filter":"referenceOrderId","operator":"Equals","kind":"Text"}},{"name":"customerEmail","in":"query","description":"Filter by the email address of the customer who disputed.","required":false,"schema":{"type":"string"},"x-filter":{"filter":"customerEmail","operator":"Equals","kind":"Text"}},{"name":"currency","in":"query","description":"Only disputes whose currency is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/IsoCurrency"},{"type":"array","items":{"$ref":"#/components/schemas/IsoCurrency"}}]},"x-filter":{"filter":"currency","operator":"In","kind":"Currency"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputePage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Disputes","action":"Read"},"description":"Requires the `query` action on `disputes` for the supplied runtime context","action":"query","resource":"disputes"}}},"/loan-facilities/{loanFacilityId}":{"get":{"tags":["Loans"],"description":"Return one loan facility.","operationId":"getLoanFacility","parameters":[{"name":"loanFacilityId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LfacView","description":"A loan facility, the pool the platform lends to borrowers from."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"LoanFacilities","action":"Read"},"description":"Requires the `query` action on `loanFacilities` for the supplied runtime context","action":"query","resource":"loanFacilities"}},"patch":{"tags":["Loans"],"description":"Add funds to a facility, change the business it lends on behalf of, or set where its statements ask to be paid and the mark they are drawn with. The business profile is merged over what is stored.","operationId":"updateLoanFacility","parameters":[{"name":"loanFacilityId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LfacUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LfacUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"LoanFacilities","action":"Update"},"description":"Requires the `update` action on `loanFacilities` for the supplied runtime context","action":"update","resource":"loanFacilities"}}},"/loan-facilities":{"get":{"tags":["Loans"],"description":"Return a page of loan facilities. The read is scoped to one enterprise and infers it from the credential, an enterprise API key names one. A credential that does not, such as a platform-admin JWT, must send the enterprise in an `Enterprise-Id` header. Supply `page` for offset pagination or `startingAfter` for cursor pagination, and `q` to search. `GET /filter-catalogues/loan-facilities` lists the filters this caller can use. A cursor continues only the walk that issued it: sent with different filters, `q` or `sort`, it is refused with 400.","operationId":"queryLoanFacilities","parameters":[{"name":"q","in":"query","description":"Search. Matches a loan facility id, the reference facility id, the description, or the business or brand name. An id, an email address, a phone number and any value listed as matched exactly match exactly; any other term matches without regard to case from the start of a value (or of any word in it, beside a longer word of the term), or anywhere in it from three characters, every word of it somewhere; a term that matches nothing so is read again with typos tolerated. Closest matches come first unless `sort` is given.","required":false,"schema":{"type":"string","maxLength":100}},{"name":"page","in":"query","description":"Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"endingBefore","in":"query","description":"Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"Fields to sort by, comma-delimited, in priority order. Prefix a field with `-` for descending.","required":false,"explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/LfacSort"}}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/LfacColumn"}}},{"name":"status","in":"query","description":"Only loan facilities whose status is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/LfacStatus"},{"type":"array","items":{"$ref":"#/components/schemas/LfacStatus"}}]},"x-filter":{"filter":"status","operator":"In","kind":"Enum"}},{"name":"statusNot","in":"query","description":"Leave out loan facilities whose status is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/LfacStatus"},{"type":"array","items":{"$ref":"#/components/schemas/LfacStatus"}}]},"x-filter":{"filter":"status","operator":"NotIn","kind":"Enum"}},{"name":"currency","in":"query","description":"Only loan facilities whose currency is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/IsoCurrency"},{"type":"array","items":{"$ref":"#/components/schemas/IsoCurrency"}}]},"x-filter":{"filter":"currency","operator":"In","kind":"Currency"}},{"name":"currencyNot","in":"query","description":"Leave out loan facilities whose currency is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/IsoCurrency"},{"type":"array","items":{"$ref":"#/components/schemas/IsoCurrency"}}]},"x-filter":{"filter":"currency","operator":"NotIn","kind":"Currency"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LfacPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"LoanFacilities","action":"Read"},"description":"Requires the `query` action on `loanFacilities` for the supplied runtime context","action":"query","resource":"loanFacilities"}},"post":{"tags":["Loans"],"description":"Create a loan facility.","operationId":"createLoanFacilities","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LfacCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LfacCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"LoanFacilities","action":"Create"},"description":"Requires the `create` action on `loanFacilities` for the supplied runtime context","action":"create","resource":"loanFacilities"}}},"/loan-statements/{loanStatementId}":{"get":{"tags":["Loans"],"description":"Return one loan statement, with its entries.","operationId":"getLoanStatement","parameters":[{"name":"loanStatementId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LstmtView","description":"A loan statement for one period."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"LoanStatements","action":"Read"},"description":"Requires the `query` action on `loanStatements` for the supplied runtime context","action":"query","resource":"loanStatements"}},"patch":{"tags":["Loans"],"description":"Issue a statement, move its billing date, credit a payment, recompute its totals, cancel a late fee, cancel the loan's latest statement, or generate, regenerate and e-mail its documents.","operationId":"updateLoanStatement","parameters":[{"name":"loanStatementId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LstmtUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LstmtUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"LoanStatements","action":"Update"},"description":"Requires the `update` action on `loanStatements` for the supplied runtime context","action":"update","resource":"loanStatements"}}},"/loan-statements":{"get":{"tags":["Loans"],"description":"Return a page of loan statements. Without `q`, a query with no `loanId`, `referenceStatementId` or date bound reads the statements created in the last 90 days, and an upper bound alone reads the 90 days ending there. A `q` search covers all of the borrower's statements, as far as the caller's delegate loan access allows, so an old statement is found by its reference. `GET /filter-catalogues/loan-statements` lists the filters this caller can use. A cursor continues only the walk that issued it: sent with different filters, `q` or `sort`, it is refused with 400.","operationId":"queryLoanStatements","parameters":[{"name":"q","in":"query","description":"Search. Matches a statement id, the id of its loan, or the reference statement id. An id, an email address, a phone number and any value listed as matched exactly match exactly; any other term matches without regard to case from the start of a value (or of any word in it, beside a longer word of the term), or anywhere in it from three characters, every word of it somewhere; a term that matches nothing so is read again with typos tolerated. Closest matches come first unless `sort` is given.","required":false,"schema":{"type":"string","maxLength":100}},{"name":"page","in":"query","description":"Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"endingBefore","in":"query","description":"Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"Fields to sort by, comma-delimited, in priority order. Prefix a field with `-` for descending.","required":false,"explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/LstmtSort"}}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/LstmtColumn"}}},{"name":"status","in":"query","description":"Only loan statements whose status is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/LstmtStatus"},{"type":"array","items":{"$ref":"#/components/schemas/LstmtStatus"}}]},"x-filter":{"filter":"status","operator":"In","kind":"Enum"}},{"name":"statusNot","in":"query","description":"Leave out loan statements whose status is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/LstmtStatus"},{"type":"array","items":{"$ref":"#/components/schemas/LstmtStatus"}}]},"x-filter":{"filter":"status","operator":"NotIn","kind":"Enum"}},{"name":"loanId","in":"query","description":"Only loan statements whose loan is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"loanId","operator":"In","kind":"Id"}},{"name":"loanIdNot","in":"query","description":"Leave out loan statements whose loan is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"loanId","operator":"NotIn","kind":"Id"}},{"name":"merchantId","in":"query","description":"Only loan statements whose borrowing merchant is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"merchantId","operator":"In","kind":"Id"}},{"name":"merchantIdNot","in":"query","description":"Leave out loan statements whose borrowing merchant is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"merchantId","operator":"NotIn","kind":"Id"}},{"name":"customerId","in":"query","description":"Only loan statements whose borrowing customer is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"customerId","operator":"In","kind":"Id"}},{"name":"customerIdNot","in":"query","description":"Leave out loan statements whose borrowing customer is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"customerId","operator":"NotIn","kind":"Id"}},{"name":"customerIdAbsent","in":"query","description":"`true` for only loan statements with no borrowing customer, `false` for only those with one.","required":false,"schema":{"type":"boolean"},"x-filter":{"filter":"customerId","operator":"Absent","kind":"Id"}},{"name":"referenceStatementId","in":"query","description":"Find a statement by the platform's own reference.","required":false,"schema":{"type":"string"},"x-filter":{"filter":"referenceStatementId","operator":"Equals","kind":"Text"}},{"name":"currency","in":"query","description":"Only loan statements whose currency is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/IsoCurrency"},{"type":"array","items":{"$ref":"#/components/schemas/IsoCurrency"}}]},"x-filter":{"filter":"currency","operator":"In","kind":"Currency"}},{"name":"currencyNot","in":"query","description":"Leave out loan statements whose currency is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/IsoCurrency"},{"type":"array","items":{"$ref":"#/components/schemas/IsoCurrency"}}]},"x-filter":{"filter":"currency","operator":"NotIn","kind":"Currency"}},{"name":"dueFrom","in":"query","description":"Only loan statements whose due date is at or after this ISO-8601 date.","required":false,"schema":{"type":"string","format":"date"},"x-filter":{"filter":"due","operator":"After","kind":"Date"}},{"name":"dueTo","in":"query","description":"Only loan statements whose due date is at or before this ISO-8601 date.","required":false,"schema":{"type":"string","format":"date"},"x-filter":{"filter":"due","operator":"Before","kind":"Date"}},{"name":"createdAfter","in":"query","description":"Only loan statements whose cut time is at or after this ISO-8601 timestamp.","required":false,"schema":{"type":"string","format":"date-time"},"x-filter":{"filter":"created","operator":"After","kind":"Instant"}},{"name":"createdBefore","in":"query","description":"Only loan statements whose cut time is before, and not at, this ISO-8601 timestamp.","required":false,"schema":{"type":"string","format":"date-time"},"x-filter":{"filter":"created","operator":"Before","kind":"Instant"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LstmtPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"LoanStatements","action":"Read"},"description":"Requires the `query` action on `loanStatements` for the supplied runtime context","action":"query","resource":"loanStatements"}},"post":{"tags":["Loans"],"description":"Cut a statement for a loan's current period, or recreate historic ones. Selected by the body's `type`.","operationId":"createLoanStatements","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LstmtCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LstmtCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"LoanStatements","action":"Create"},"description":"Requires the `create` action on `loanStatements` for the supplied runtime context","action":"create","resource":"loanStatements"}}},"/loan-statements/{loanStatementId}/documents/{format}":{"get":{"tags":["Loans"],"description":"Return one of the statement's documents as the file itself, under its own media type: `text/csv` for `Csv`,\n`application/pdf` for `Pdf`, `application/xml` for `Xml`. `Content-Disposition` names the file; the name is stated\nhere too, because generated clients drop headers.\n\nWith `useLimepayGeneration=true` the file is the one the platform stored, named\n`{ediNumber}_{referenceStatementId}_{yyyyMMdd_HHmmss}.{documentId}[.V{schemaVersion}].{csv|pdf|xml}`, the time in UTC.\nA format not produced for this statement yet, or XML for a loan whose settings do not enable it, is a `400`.\n\nWith `false`, the file is relayed unchanged from APG's gateway under APG's own name. APG not finding the\nstatement is a `404`; any other refusal from APG is a `500`.\n\nOmitted, the environment decides: dev, tst and stg answer as `true` does, production as `false` does.\n\nSend an `Accept` naming the format, or none. One naming none of the three, `application/json` for one, is a `406`\nwith an empty body; one naming another of the three still gets the format in the path. Any other query parameter\nis a `400`.","operationId":"getLoanStatementDocument","parameters":[{"name":"loanStatementId","in":"path","required":true,"schema":{"type":"string"}},{"name":"format","in":"path","description":"Which document. It also fixes the response's `Content-Type`.","required":true,"schema":{"$ref":"#/components/schemas/LoanStatementDocumentFormat"}},{"name":"useLimepayGeneration","in":"query","description":"`true` serves the document the platform rendered and stored; one not produced yet is a `400`, never a fall-back to APG. `false` relays APG's file, as edge does. Omitted, it depends on the environment, as on edge: dev, tst and stg serve the stored document, production relays APG's file.","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"","headers":{"Content-Disposition":{"description":"`attachment` with the file's name: `filename`, plus `filename*` (RFC 5987) when the name is not printable ASCII.","required":true,"schema":{"type":"string"}}},"content":{"text/csv":{"schema":{"type":"string","format":"binary"}},"application/pdf":{"schema":{"type":"string","format":"binary"}},"application/xml":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"LoanStatements","action":"Read"},"description":"Requires the `query` action on `loanStatements` for the supplied runtime context","action":"query","resource":"loanStatements"}}},"/loan-statements/{loanStatementId}/documents":{"get":{"tags":["Loans"],"description":"Return the documents made for the statement, each with where it got to: its format, its status, its mail and its ready notice. A statement has few, so they page by `page` only.","operationId":"queryLoanStatementDocuments","parameters":[{"name":"loanStatementId","in":"path","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"1-based page number.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LstmtDocumentPage"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"LoanStatements","action":"Read"},"description":"Requires the `query` action on `loanStatements` for the supplied runtime context","action":"query","resource":"loanStatements"}}},"/roles/{roleId}":{"get":{"tags":["Identity"],"description":"Return one role, with its grants resolved.","operationId":"getRole","parameters":[{"name":"roleId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleView"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Roles","action":"Read"},"description":"Requires the `query` action on `roles` for the supplied runtime context","action":"query","resource":"roles"}},"patch":{"tags":["Identity"],"description":"Change a role's name, or replace what it grants.","operationId":"updateRole","parameters":[{"name":"roleId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Roles","action":"Update"},"description":"Requires the `update` action on `roles` for the supplied runtime context","action":"update","resource":"roles"}}},"/roles":{"get":{"tags":["Identity"],"description":"Return a page of roles. Supply `page` for offset pagination or `startingAfter` for cursor pagination, and `q` to search. `GET /filter-catalogues/roles` lists the filters this caller can use. A cursor continues only the walk that issued it: sent with different filters, `q` or `sort`, it is refused with 400.","operationId":"queryRoles","parameters":[{"name":"q","in":"query","description":"Search. Matches a role id or the name. An id, an email address, a phone number and any value listed as matched exactly match exactly; any other term matches without regard to case from the start of a value (or of any word in it, beside a longer word of the term), or anywhere in it from three characters, every word of it somewhere; a term that matches nothing so is read again with typos tolerated. Closest matches come first unless `sort` is given.","required":false,"schema":{"type":"string","maxLength":100}},{"name":"page","in":"query","description":"Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"endingBefore","in":"query","description":"Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"Fields to sort by, comma-delimited, in priority order. Prefix a field with `-` for descending.","required":false,"explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/RoleSort"}}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/RoleColumn"}}},{"name":"name","in":"query","description":"Filter by role name.","required":false,"schema":{"type":"string"},"x-filter":{"filter":"name","operator":"Equals","kind":"Text"}},{"name":"roleType","in":"query","description":"Only roles whose kind is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/RoleType"},{"type":"array","items":{"$ref":"#/components/schemas/RoleType"}}]},"x-filter":{"filter":"roleType","operator":"In","kind":"Enum"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RolePage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Roles","action":"Read"},"description":"Requires the `query` action on `roles` for the supplied runtime context","action":"query","resource":"roles"}},"post":{"tags":["Identity"],"description":"Define a role, carrying its own grants or grouping other roles. Selected by the body's `type`.","operationId":"createRoles","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Roles","action":"Create"},"description":"Requires the `create` action on `roles` for the supplied runtime context","action":"create","resource":"roles"}}},"/oidc-providers/{oidcProviderId}":{"get":{"tags":["Identity"],"description":"Return one OIDC provider. The client secret is never included.","operationId":"getOidcProvider","parameters":[{"name":"oidcProviderId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OidcidpView","description":"An external identity provider sign-in can be federated to."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"OidcIdps","action":"Read"},"description":"Requires the `query` action on `oidcIdps` for the supplied runtime context","action":"query","resource":"oidcIdps"}},"patch":{"tags":["Identity"],"description":"Update a provider's mutable attributes.","operationId":"updateOidcProvider","parameters":[{"name":"oidcProviderId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OidcidpUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OidcidpUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"OidcIdps","action":"Update"},"description":"Requires the `update` action on `oidcIdps` for the supplied runtime context","action":"update","resource":"oidcIdps"}}},"/oidc-providers":{"get":{"tags":["Identity"],"description":"Return a page of OIDC providers. Supply `page` for offset pagination or `startingAfter` for cursor pagination, and `q` to search.","operationId":"queryOidcProviders","parameters":[{"name":"q","in":"query","description":"Search. Matches an OIDC provider id, the display name or the issuer. An id, an email address, a phone number and any value listed as matched exactly match exactly; any other term matches without regard to case from the start of a value (or of any word in it, beside a longer word of the term), or anywhere in it from three characters, every word of it somewhere; a term that matches nothing so is read again with typos tolerated. Closest matches come first unless `sort` is given.","required":false,"schema":{"type":"string","maxLength":100}},{"name":"page","in":"query","description":"Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"endingBefore","in":"query","description":"Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"Fields to sort by, comma-delimited, in priority order. Prefix a field with `-` for descending.","required":false,"explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/OidcidpSort"}}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/OidcidpColumn"}}},{"name":"status","in":"query","description":"Filter by provider status. Repeat the parameter to supply several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/OidcidpStatus"},{"type":"array","items":{"$ref":"#/components/schemas/OidcidpStatus"}}]}},{"name":"issuer","in":"query","description":"Filter by issuer URL.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OidcidpPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"OidcIdps","action":"Read"},"description":"Requires the `query` action on `oidcIdps` for the supplied runtime context","action":"query","resource":"oidcIdps"}},"post":{"tags":["Identity"],"description":"Register a provider.","operationId":"createOidcProviders","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OidcidpCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OidcidpCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"OidcIdps","action":"Create"},"description":"Requires the `create` action on `oidcIdps` for the supplied runtime context","action":"create","resource":"oidcIdps"}}},"/fx-rate-sets/{fxRateSetId}":{"get":{"tags":["FX rates"],"description":"Return one rate set with its current rates.","operationId":"getFxRateSet","parameters":[{"name":"fxRateSetId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FxrsView","description":"A set of exchange rates an enterprise maintains."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"FxRates","action":"Read"},"description":"Requires the `query` action on `fxRates` for the supplied runtime context","action":"query","resource":"fxRates"}},"patch":{"tags":["FX rates"],"description":"Load new rates. `replaceOldRates` decides whether they replace the set's rates or merge into them, there is no safe default.","operationId":"updateFxRateSet","parameters":[{"name":"fxRateSetId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FxrsUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FxrsUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"FxRates","action":"Update"},"description":"Requires the `update` action on `fxRates` for the supplied runtime context","action":"update","resource":"fxRates"}}},"/fx-rate-sets/{fxRateSetId}/rates":{"get":{"tags":["FX rates"],"description":"Price one currency pair from this set. A pair the set does not quote directly is crossed through its `crossCurrency`, and the legs come back with it.","operationId":"getFxRateSetRate","parameters":[{"name":"fxRateSetId","in":"path","required":true,"schema":{"type":"string"}},{"name":"baseCurrency","in":"query","description":"The currency being converted from. Required.","required":true,"schema":{"$ref":"#/components/schemas/IsoCurrency"}},{"name":"termCurrency","in":"query","description":"The currency being converted to. Required.","required":true,"schema":{"$ref":"#/components/schemas/IsoCurrency"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FxrsCrossRates"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"FxRates","action":"Read"},"description":"Requires the `query` action on `fxRates` for the supplied runtime context","action":"query","resource":"fxRates"}}},"/fx-rate-sets":{"post":{"tags":["FX rates"],"description":"Create a rate set with an initial set of rates. The response carries the identifier you address it by.","operationId":"createFxRateSets","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FxrsCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FxrsCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"FxRates","action":"Create"},"description":"Requires the `create` action on `fxRates` for the supplied runtime context","action":"create","resource":"fxRates"}}},"/source-verifications/{sourceVerificationId}":{"get":{"tags":["Payment sources"],"description":"Return one source verification.","operationId":"getSourceVerification","parameters":[{"name":"sourceVerificationId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PsrcverView","description":"A verification run against the payment source used by a transaction."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"SourceVerifications","action":"Read"},"description":"Requires the `query` action on `sourceVerifications` for the supplied runtime context","action":"query","resource":"sourceVerifications"}},"patch":{"tags":["Payment sources"],"description":"Override a verification's outcome, pass it, fail it, or reset it to run again.","operationId":"updateSourceVerification","parameters":[{"name":"sourceVerificationId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PsrcverUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PsrcverUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"SourceVerifications","action":"Update"},"description":"Requires the `update` action on `sourceVerifications` for the supplied runtime context","action":"update","resource":"sourceVerifications"}}},"/source-verifications":{"get":{"tags":["Payment sources"],"description":"Return the source verification of one transaction, as a page of at most one. `transactionId` is required.","operationId":"querySourceVerifications","parameters":[{"name":"page","in":"query","description":"1-based page number.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/PsrcverColumn"}}},{"name":"transactionId","in":"query","description":"The transaction whose payment-source verification to return.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PsrcverPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"SourceVerifications","action":"Read"},"description":"Requires the `query` action on `sourceVerifications` for the supplied runtime context","action":"query","resource":"sourceVerifications"}},"post":{"tags":["Payment sources"],"description":"Run a verification against a transaction's source.","operationId":"createSourceVerifications","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PsrcverCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PsrcverCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"SourceVerifications","action":"Create"},"description":"Requires the `create` action on `sourceVerifications` for the supplied runtime context","action":"create","resource":"sourceVerifications"}}},"/delegates/{delegateId}":{"get":{"tags":["Customers"],"description":"Return one delegate.","operationId":"getDelegate","parameters":[{"name":"delegateId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustdView","description":"A person authorised to act for one or more organisation customers."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Magic Link Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"CustomerDelegates","action":"Read"},"description":"Requires the `query` action on `customerDelegates` for the supplied runtime context","action":"query","resource":"customerDelegates"}},"patch":{"tags":["Customers"],"description":"Change a delegate's contact details, link it to or unlink it from a customer, or change what it is to one. Selected by the body's `type`.","operationId":"updateDelegate","parameters":[{"name":"delegateId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustdUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustdUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Magic Link Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"description":"Required action depends on the request variant","variants":[{"description":"Change the name","schema":"CustdUpdateName","actions":[{"grant":{"resource":"CustomerDelegates","action":"Update"},"resource":"customerDelegates","action":"update"}]},{"description":"Change the email address","schema":"CustdUpdateEmailAddress","actions":[{"grant":{"resource":"CustomerDelegates","action":"Update"},"resource":"customerDelegates","action":"update"}]},{"description":"Change the phone number","schema":"CustdUpdatePhoneNumber","actions":[{"grant":{"resource":"CustomerDelegates","action":"Update"},"resource":"customerDelegates","action":"update"}]},{"description":"Link to a customer","schema":"CustdUpdateLinkCustomer","actions":[{"grant":{"resource":"CustomerDelegates","action":"Link"},"resource":"customerDelegates","action":"link"}]},{"description":"Unlink from a customer","schema":"CustdUpdateUnlinkCustomer","actions":[{"grant":{"resource":"CustomerDelegates","action":"Link"},"resource":"customerDelegates","action":"link"}]},{"description":"Change the position at a customer","schema":"CustdUpdatePosition","actions":[{"grant":{"resource":"CustomerDelegates","action":"UpdatePermissions"},"resource":"customerDelegates","action":"updatePermissions"}]},{"description":"Change the loan role at a customer","schema":"CustdUpdateLoanRole","actions":[{"grant":{"resource":"CustomerDelegates","action":"UpdatePermissions"},"resource":"customerDelegates","action":"updatePermissions"}]}]}}},"/delegates":{"get":{"tags":["Customers"],"description":"Return a page of the delegates the credentials reach, narrowed by `customerId`, `merchantId` or `delegateId`. Supply `page` for offset pagination or `startingAfter` for cursor pagination, and `q` to search.","operationId":"queryDelegates","parameters":[{"name":"q","in":"query","description":"Search. Matches a delegate id, the display name, or the whole email address or phone number. An id, an email address, a phone number and any value listed as matched exactly match exactly; any other term matches without regard to case from the start of a value (or of any word in it, beside a longer word of the term), or anywhere in it from three characters, every word of it somewhere; a term that matches nothing so is read again with typos tolerated. Closest matches come first unless `sort` is given.","required":false,"schema":{"type":"string","maxLength":100}},{"name":"page","in":"query","description":"Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"endingBefore","in":"query","description":"Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"Fields to sort by, comma-delimited, in priority order. Prefix a field with `-` for descending.","required":false,"explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/CustdSort"}}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/CustdColumn"}}},{"name":"customerId","in":"query","description":"Filter to delegates of one customer.","required":false,"schema":{"type":"string"}},{"name":"merchantId","in":"query","description":"Filter to delegates of one merchant's customers.","required":false,"schema":{"type":"string"}},{"name":"delegateId","in":"query","description":"Filter to one delegate.","required":false,"schema":{"type":"string"}},{"name":"emailAddress","in":"query","description":"Filter by the delegate's email address.","required":false,"schema":{"type":"string"}},{"name":"name","in":"query","description":"Filter by the delegate's name.","required":false,"schema":{"type":"string"}},{"name":"createdAfter","in":"query","description":"Delegates created at or after this ISO-8601 timestamp.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"createdBefore","in":"query","description":"Delegates created at or before this ISO-8601 timestamp.","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustdPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Magic Link Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"CustomerDelegates","action":"Read"},"description":"Requires the `query` action on `customerDelegates` for the supplied runtime context","action":"query","resource":"customerDelegates"}},"post":{"tags":["Customers"],"description":"Add a delegate, ask a customer's delegates to approve a new one, or approve one by its emailed link. Selected by the body's `type`.","operationId":"createDelegates","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustdCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustdCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Magic Link Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"description":"Required action depends on the request variant","variants":[{"description":"Add or refresh a delegate","schema":"CustdCmdUpsert","actions":[{"grant":{"resource":"CustomerDelegates","action":"Upsert"},"resource":"customerDelegates","action":"upsert"}]},{"description":"Ask the customer's delegates to approve a new one","schema":"CustdCmdRequestAddition","actions":[{"grant":{"resource":"MerchantCustomers","action":"Update"},"resource":"merchantCustomers","action":"update"}]},{"description":"Approve an addition by its emailed link","schema":"CustdCmdApproveAddition","tokenAnchored":true}]}}},"/issuer-transaction-exceptions/{issuerTransactionExceptionId}":{"get":{"tags":["Card issuer"],"description":"Return one exception, including any suggested resolution.","operationId":"getIssuerTransactionException","parameters":[{"name":"issuerTransactionExceptionId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptView"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"IssuerTransactionDiscrepancies","action":"Read"},"description":"Requires the `query` action on `issuerTransactionDiscrepancies` for the supplied runtime context","action":"query","resource":"issuerTransactionDiscrepancies"}},"patch":{"tags":["Card issuer"],"description":"Resolve an exception or add a note to it. Which resolutions are accepted depends on the kind, see `ExceptResolution`.","operationId":"updateIssuerTransactionException","parameters":[{"name":"issuerTransactionExceptionId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"IssuerTransactionDiscrepancies","action":"Update"},"description":"Requires the `update` action on `issuerTransactionDiscrepancies` for the supplied runtime context","action":"update","resource":"issuerTransactionDiscrepancies"}}},"/issuer-transaction-exceptions":{"get":{"tags":["Card issuer"],"description":"Return a page of exceptions. Supply `page` for offset pagination or `startingAfter` for cursor pagination, and `q` to search. The filters combine with each other and with `q` by AND. `GET /filter-catalogues/issuer-transaction-exceptions` lists those this caller can use. A cursor continues only the walk that issued it: sent with different filters, `q` or `sort`, it is refused with 400.","operationId":"queryIssuerTransactionExceptions","parameters":[{"name":"q","in":"query","description":"Search. Matches an exception id, the id of its loan or card, the card's last four digits, the reference transaction id or the card holder's name. No card number is ever matched. An id, an email address, a phone number and any value listed as matched exactly match exactly; any other term matches without regard to case from the start of a value (or of any word in it, beside a longer word of the term), or anywhere in it from three characters, every word of it somewhere; a term that matches nothing so is read again with typos tolerated. Closest matches come first unless `sort` is given.","required":false,"schema":{"type":"string","maxLength":100}},{"name":"page","in":"query","description":"Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"endingBefore","in":"query","description":"Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"Fields to sort by, comma-delimited, in priority order. Prefix a field with `-` for descending.","required":false,"explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExceptSort"}}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExceptColumn"}}},{"name":"status","in":"query","description":"Only exceptions whose status is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/ExceptStatus"},{"type":"array","items":{"$ref":"#/components/schemas/ExceptStatus"}}]},"x-filter":{"filter":"status","operator":"In","kind":"Enum"}},{"name":"kind","in":"query","description":"Only exceptions whose kind is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/ExceptKind"},{"type":"array","items":{"$ref":"#/components/schemas/ExceptKind"}}]},"x-filter":{"filter":"kind","operator":"In","kind":"Enum"}},{"name":"loanId","in":"query","description":"Only exceptions whose card's loan is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"loanId","operator":"In","kind":"Id"}},{"name":"cardId","in":"query","description":"Only exceptions whose card is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"cardId","operator":"In","kind":"Id"}},{"name":"referenceTransactionId","in":"query","description":"Find an exception by the reference the scheme quoted.","required":false,"schema":{"type":"string"},"x-filter":{"filter":"referenceTransactionId","operator":"Equals","kind":"Text"}},{"name":"approvalCode","in":"query","description":"Find a capture exception by the approval code it quoted.","required":false,"schema":{"type":"string"},"x-filter":{"filter":"approvalCode","operator":"Equals","kind":"Text"}},{"name":"createdAfter","in":"query","description":"Only exceptions whose raising time is at or after this ISO-8601 timestamp.","required":false,"schema":{"type":"string","format":"date-time"},"x-filter":{"filter":"created","operator":"After","kind":"Instant"}},{"name":"createdBefore","in":"query","description":"Only exceptions whose raising time is before, and not at, this ISO-8601 timestamp.","required":false,"schema":{"type":"string","format":"date-time"},"x-filter":{"filter":"created","operator":"Before","kind":"Instant"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"IssuerTransactionDiscrepancies","action":"Read"},"description":"Requires the `query` action on `issuerTransactionDiscrepancies` for the supplied runtime context","action":"query","resource":"issuerTransactionDiscrepancies"}}},"/webhooks/{webhookId}":{"get":{"tags":["Webhooks"],"description":"Return one webhook subscription. The signing secret is never included.","operationId":"getWebhook","parameters":[{"name":"webhookId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookView","description":"A subscription delivering platform events to an endpoint you control."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"WebhookSubscriptions","action":"Read"},"description":"Requires the `query` action on `webhookSubscriptions` for the supplied runtime context","action":"query","resource":"webhookSubscriptions"}},"patch":{"tags":["Webhooks"],"description":"Update a subscription's url, event types, description or status, or rotate its signing secret. Fields you omit are left unchanged.","operationId":"updateWebhook","parameters":[{"name":"webhookId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"WebhookSubscriptions","action":"Update"},"description":"Requires the `update` action on `webhookSubscriptions` for the supplied runtime context","action":"update","resource":"webhookSubscriptions"}}},"/webhooks":{"get":{"tags":["Webhooks"],"description":"Return a page of webhook subscriptions. Supply `page` for offset pagination or `startingAfter` for cursor pagination, and `q` to search. A caller held to no merchant or marketplace, and not entitled to every subscription, reads only those its `merchantId` or `marketplaceId` names. `GET /filter-catalogues/webhooks` lists the filters this caller can use. A cursor continues only the walk that issued it: sent with different filters, `q` or `sort`, it is refused with 400.","operationId":"queryWebhooks","parameters":[{"name":"q","in":"query","description":"Search. Matches a webhook id, the URL or the description, or any part of the name of an event type it is subscribed to. An id, an email address, a phone number and any value listed as matched exactly match exactly; any other term matches without regard to case from the start of a value (or of any word in it, beside a longer word of the term), or anywhere in it from three characters, every word of it somewhere; a term that matches nothing so is read again with typos tolerated. Closest matches come first unless `sort` is given.","required":false,"schema":{"type":"string","maxLength":100}},{"name":"page","in":"query","description":"Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"endingBefore","in":"query","description":"Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"Fields to sort by, comma-delimited, in priority order. Prefix a field with `-` for descending.","required":false,"explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/WebhookSort"}}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/WebhookColumn"}}},{"name":"status","in":"query","description":"Only subscriptions whose status is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/WebhookStatus"},{"type":"array","items":{"$ref":"#/components/schemas/WebhookStatus"}}]},"x-filter":{"filter":"status","operator":"In","kind":"Enum"}},{"name":"statusNot","in":"query","description":"Leave out subscriptions whose status is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/WebhookStatus"},{"type":"array","items":{"$ref":"#/components/schemas/WebhookStatus"}}]},"x-filter":{"filter":"status","operator":"NotIn","kind":"Enum"}},{"name":"merchantId","in":"query","description":"Only subscriptions whose merchant is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"merchantId","operator":"In","kind":"Id"}},{"name":"merchantIdNot","in":"query","description":"Leave out subscriptions whose merchant is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"merchantId","operator":"NotIn","kind":"Id"}},{"name":"marketplaceId","in":"query","description":"Only subscriptions whose marketplace is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"marketplaceId","operator":"In","kind":"Id"}},{"name":"marketplaceIdNot","in":"query","description":"Leave out subscriptions whose marketplace is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"marketplaceId","operator":"NotIn","kind":"Id"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"WebhookSubscriptions","action":"Read"},"description":"Requires the `query` action on `webhookSubscriptions` for the supplied runtime context","action":"query","resource":"webhookSubscriptions"}},"post":{"tags":["Webhooks"],"description":"Subscribe an endpoint to platform events.","operationId":"createWebhooks","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"WebhookSubscriptions","action":"Update"},"description":"Requires the `update` action on `webhookSubscriptions` for the supplied runtime context","action":"update","resource":"webhookSubscriptions"}}},"/webhooks/{webhookId}/deliveries":{"get":{"tags":["Webhooks"],"description":"Return a page of this subscription's deliveries, newest first. Filter by `status` to find the ones that did not arrive, and by `event` to follow one event type. Each entry carries the attempt count and the last HTTP status your endpoint answered with.","operationId":"queryWebhookDeliveries","parameters":[{"name":"webhookId","in":"path","required":true,"schema":{"type":"string"}},{"name":"q","in":"query","description":"Search. Matches a delivery id, or exactly the event type, the id of the entity the event is about, the idempotency key or the request id. An id, an email address, a phone number and any value listed as matched exactly match exactly; any other term matches without regard to case from the start of a value (or of any word in it, beside a longer word of the term), or anywhere in it from three characters, every word of it somewhere; a term that matches nothing so is read again with typos tolerated. Matches come newest first unless `sort` is given.","required":false,"schema":{"type":"string","maxLength":100}},{"name":"page","in":"query","description":"Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"endingBefore","in":"query","description":"Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"Fields to sort by, comma-delimited, in priority order. Prefix a field with `-` for descending.","required":false,"explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/WebhookDeliverySort"}}},{"name":"status","in":"query","description":"Filter to deliveries in one state. `Failed` is the one a dashboard usually wants.","required":false,"schema":{"type":"string"}},{"name":"event","in":"query","description":"Filter to one event type.","required":false,"schema":{"$ref":"#/components/schemas/WebhookEventType"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookDeliveryPage"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"WebhookSubscriptions","action":"Read"},"description":"Requires the `query` action on `webhookSubscriptions` for the supplied runtime context","action":"query","resource":"webhookSubscriptions"}}},"/webhooks/{webhookId}/deliveries/{deliveryId}":{"get":{"tags":["Webhooks"],"description":"Return one delivery, with its attempts and what your endpoint last answered. A delivery that does not belong to this webhook is a 404, not a redirect.","operationId":"getWebhookDelivery","parameters":[{"name":"webhookId","in":"path","required":true,"schema":{"type":"string"}},{"name":"deliveryId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookDeliveryView","description":"One attempt to deliver one event to one subscription."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"WebhookSubscriptions","action":"Read"},"description":"Requires the `query` action on `webhookSubscriptions` for the supplied runtime context","action":"query","resource":"webhookSubscriptions"}},"patch":{"tags":["Webhooks"],"description":"Act on one delivery. Today the only action is to send it again. A delivery that does not belong to this webhook is a 404, not a redirect.","operationId":"updateWebhookDelivery","parameters":[{"name":"webhookId","in":"path","required":true,"schema":{"type":"string"}},{"name":"deliveryId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookDeliveryUpd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookDeliveryUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"WebhookSubscriptions","action":"Update"},"description":"Requires the `update` action on `webhookSubscriptions` for the supplied runtime context","action":"update","resource":"webhookSubscriptions"}}},"/payment-tokens/{paymentTokenId}":{"get":{"tags":["Payment tokens"],"description":"Return one payment token.","operationId":"getPaymentToken","parameters":[{"name":"paymentTokenId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PtknView","description":"A single-use token authorising one payment of a stated amount."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Public Token | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"PaymentTokens","action":"Read"},"description":"Requires the `query` action on `paymentTokens` for the supplied runtime context","action":"query","resource":"paymentTokens"}}},"/payment-tokens":{"post":{"tags":["Payment tokens"],"description":"Issue a payment token. The payment method is selected by the body's `type`.","operationId":"createPaymentTokens","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PtknCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PtknCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Public Token | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"PaymentTokens","action":"Create"},"description":"Requires the `create` action on `paymentTokens` for the supplied runtime context","action":"create","resource":"paymentTokens"}}},"/sessions":{"get":{"tags":["Identity"],"description":"Return the session you are holding, and what it can do. A page of one, the platform stores no sessions, so there are no others to list.","operationId":"querySessions","parameters":[{"name":"page","in":"query","description":"1-based page number.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/SessColumn"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | IAM User JWT | Customer JWT | Merchant JWT | Marketplace JWT | Admin JWT":[]}],"x-required-action":{"grant":{"resource":"Sessions","action":"Read"},"description":"Requires the `query` action on `sessions` for the supplied runtime context","action":"query","resource":"sessions"}},"post":{"tags":["Identity"],"description":"Start or complete a sign-in. The response says which step you are on. The credential is optional, see below.","operationId":"createSessions","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{},{"Marketplace API Key | Merchant Secret Token | User Auth Token | IAM User JWT | Customer JWT | Merchant JWT | Marketplace JWT | Admin JWT":[]}],"x-required-action":{"grant":{"resource":"Sessions","action":"Create"},"description":"Requires the `create` action on `sessions` for the supplied runtime context","action":"create","resource":"sessions"}},"patch":{"tags":["Identity"],"description":"Act in a different domain, which needs your session's bearer, or trade a refresh token for a new bearer, which needs no credential. See below.","operationId":"updateSessions","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{},{"Marketplace API Key | Merchant Secret Token | User Auth Token | IAM User JWT | Customer JWT | Merchant JWT | Marketplace JWT | Admin JWT":[]}],"x-required-action":{"grant":{"resource":"Sessions","action":"Create"},"description":"Requires the `create` action on `sessions` for the supplied runtime context","action":"create","resource":"sessions"}}},"/auth-tokens":{"post":{"tags":["Identity"],"description":"Mint an auth token, ask what one says about itself, or exchange a customer's for a bearer. The credential is optional, see below.","operationId":"createAuthTokens","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AtknCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AtknCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{},{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Sessions","action":"Create"},"description":"Requires the `create` action on `sessions` for the supplied runtime context","action":"create","resource":"sessions"}}},"/api-keys/{apiKeyId}":{"get":{"tags":["Identity"],"description":"Return one service token. The secret is never included.","operationId":"getApiKey","parameters":[{"name":"apiKeyId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyView","description":"A credential a backend service authenticates with."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"ServiceTokens","action":"Read"},"description":"Requires the `query` action on `serviceTokens` for the supplied runtime context","action":"query","resource":"serviceTokens"}},"patch":{"tags":["Identity"],"description":"Change a token's description, expiry, status or permissions. One change per call, the arm says which.","operationId":"updateApiKey","parameters":[{"name":"apiKeyId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"ServiceTokens","action":"Update"},"description":"Requires the `update` action on `serviceTokens` for the supplied runtime context","action":"update","resource":"serviceTokens"}}},"/api-keys":{"get":{"tags":["Identity"],"description":"Return a page of service tokens. `tokenType` is required, and so is the party it belongs to, there is no cross-party token read: `merchantId` for the two merchant types, `marketplaceId` for a marketplace key, `enterpriseId` for an enterprise key.","operationId":"queryApiKeys","parameters":[{"name":"q","in":"query","description":"Search. Matches an API key id or the description. An id, an email address, a phone number and any value listed as matched exactly match exactly; any other term matches without regard to case from the start of a value (or of any word in it, beside a longer word of the term), or anywhere in it from three characters, every word of it somewhere; a term that matches nothing so is read again with typos tolerated. Closest matches come first unless `sort` is given.","required":false,"schema":{"type":"string","maxLength":100}},{"name":"page","in":"query","description":"Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"endingBefore","in":"query","description":"Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"Fields to sort by, comma-delimited, in priority order. Prefix a field with `-` for descending.","required":false,"explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApiKeySort"}}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApiKeyColumn"}}},{"name":"tokenType","in":"query","description":"What kind of token. Omit it to read every kind.","required":false,"schema":{"$ref":"#/components/schemas/ApiKeyType"}},{"name":"merchantId","in":"query","description":"Whose tokens, for the merchant types.","required":false,"schema":{"type":"string"}},{"name":"marketplaceId","in":"query","description":"Whose tokens, for a marketplace key.","required":false,"schema":{"type":"string"}},{"name":"enterpriseId","in":"query","description":"Whose tokens, for an enterprise key.","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Filter by status. Repeat the parameter to supply several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiKeyStatus"},{"type":"array","items":{"$ref":"#/components/schemas/ApiKeyStatus"}}]}},{"name":"expired","in":"query","description":"Only expired tokens, or only unexpired ones.","required":false,"schema":{"type":"boolean"}},{"name":"createdAfter","in":"query","description":"Tokens created at or after this ISO-8601 timestamp.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"createdBefore","in":"query","description":"Tokens created before this ISO-8601 timestamp.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"expiresAfter","in":"query","description":"Tokens expiring at or after this ISO-8601 timestamp.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"expiresBefore","in":"query","description":"Tokens expiring before this ISO-8601 timestamp.","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"ServiceTokens","action":"Read"},"description":"Requires the `query` action on `serviceTokens` for the supplied runtime context","action":"query","resource":"serviceTokens"},"x-required-one-of":[["merchantId"],["marketplaceId"],["enterpriseId"]]},"post":{"tags":["Identity"],"description":"Issue a token. The secret is on the response and nowhere else, ever.","operationId":"createApiKeys","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"ServiceTokens","action":"Create"},"description":"Requires the `create` action on `serviceTokens` for the supplied runtime context","action":"create","resource":"serviceTokens"}}},"/surcharge-quotes":{"post":{"tags":["Payment tokens"],"description":"Ask what a payment would cost. The way you identify the method is selected by the body's `type`.","operationId":"createSurchargeQuotes","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SrchqCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SrchqCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Public Token | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"PaymentTokens","action":"Create"},"description":"Requires the `create` action on `paymentTokens` for the supplied runtime context","action":"create","resource":"paymentTokens"}}},"/transfers/{transferId}":{"get":{"tags":["Transactions"],"description":"Return the transfer record for a transaction: every movement out of it, and how much is left to move. The identifier is the transaction's.","operationId":"getTransfer","parameters":[{"name":"transferId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TtfrView","description":"Every movement of one transaction's funds to other merchants, and what is left to move."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Transactions","action":"Read"},"description":"Requires the `query` action on `transactions` for the supplied runtime context","action":"query","resource":"transactions"}},"patch":{"tags":["Transactions"],"description":"Claw back part of what was transferred to one merchant. Identify the record by its transaction.","operationId":"updateTransfer","parameters":[{"name":"transferId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TtfrUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TtfrUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Transactions","action":"Transfer"},"description":"Requires the `transfer` action on `transactions` for the supplied runtime context","action":"transfer","resource":"transactions"}}},"/transfers":{"post":{"tags":["Transactions"],"description":"Move part of a transaction's funds to another merchant.","operationId":"createTransfers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TtfrCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TtfrCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Transactions","action":"Transfer"},"description":"Requires the `transfer` action on `transactions` for the supplied runtime context","action":"transfer","resource":"transactions"}}},"/loan-transactions/{loanTransactionId}":{"get":{"tags":["Loans"],"description":"Return one loan transaction.","operationId":"getLoanTransaction","parameters":[{"name":"loanTransactionId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LtxnView","description":"A movement on a loan, a drawdown, a card charge, a fee or an adjustment."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"LoanTransactions","action":"Read"},"description":"Requires the `query` action on `loanTransactions` for the supplied runtime context","action":"query","resource":"loanTransactions"}},"patch":{"tags":["Loans"],"description":"Publish an authorised movement to the balance, or cancel it.","operationId":"updateLoanTransaction","parameters":[{"name":"loanTransactionId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LtxnUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LtxnUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"LoanTransactions","action":"Update"},"description":"Requires the `update` action on `loanTransactions` for the supplied runtime context","action":"update","resource":"loanTransactions"}}},"/loan-transactions":{"get":{"tags":["Loans"],"description":"Return a page of loan transactions. Supply `page` for offset pagination or `startingAfter` for cursor pagination, and `q` to search. `GET /filter-catalogues/loan-transactions` lists the filters this caller can use. A cursor continues only the walk that issued it: sent with different filters, `q` or `sort`, it is refused with 400.","operationId":"queryLoanTransactions","parameters":[{"name":"q","in":"query","description":"Search. Matches a loan transaction id, the id of its loan, the reference transaction id or a standalone entry's description. An id, an email address, a phone number and any value listed as matched exactly match exactly; any other term matches without regard to case from the start of a value (or of any word in it, beside a longer word of the term), or anywhere in it from three characters, every word of it somewhere; a term that matches nothing so is read again with typos tolerated. Matches come newest first unless `sort` is given.","required":false,"schema":{"type":"string","maxLength":100}},{"name":"page","in":"query","description":"Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"endingBefore","in":"query","description":"Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"Fields to sort by, comma-delimited, in priority order. Prefix a field with `-` for descending.","required":false,"explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/LtxnSort"}}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/LtxnColumn"}}},{"name":"status","in":"query","description":"Only loan transactions whose status is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/LtxnStatus"},{"type":"array","items":{"$ref":"#/components/schemas/LtxnStatus"}}]},"x-filter":{"filter":"status","operator":"In","kind":"Enum"}},{"name":"statusNot","in":"query","description":"Leave out loan transactions whose status is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/LtxnStatus"},{"type":"array","items":{"$ref":"#/components/schemas/LtxnStatus"}}]},"x-filter":{"filter":"status","operator":"NotIn","kind":"Enum"}},{"name":"loanId","in":"query","description":"Only loan transactions whose loan is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"loanId","operator":"In","kind":"Id"}},{"name":"loanIdNot","in":"query","description":"Leave out loan transactions whose loan is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"loanId","operator":"NotIn","kind":"Id"}},{"name":"merchantId","in":"query","description":"Only loan transactions whose borrowing merchant is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"merchantId","operator":"In","kind":"Id"}},{"name":"merchantIdNot","in":"query","description":"Leave out loan transactions whose borrowing merchant is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"merchantId","operator":"NotIn","kind":"Id"}},{"name":"customerId","in":"query","description":"Only loan transactions whose borrowing customer is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"customerId","operator":"In","kind":"Id"}},{"name":"customerIdNot","in":"query","description":"Leave out loan transactions whose borrowing customer is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"customerId","operator":"NotIn","kind":"Id"}},{"name":"customerIdAbsent","in":"query","description":"`true` for only loan transactions with no borrowing customer, `false` for only those with one.","required":false,"schema":{"type":"boolean"},"x-filter":{"filter":"customerId","operator":"Absent","kind":"Id"}},{"name":"productType","in":"query","description":"Only loan transactions whose kind of loan is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/LprodType"},{"type":"array","items":{"$ref":"#/components/schemas/LprodType"}}]},"x-filter":{"filter":"productType","operator":"In","kind":"Enum"}},{"name":"productTypeNot","in":"query","description":"Leave out loan transactions whose kind of loan is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/LprodType"},{"type":"array","items":{"$ref":"#/components/schemas/LprodType"}}]},"x-filter":{"filter":"productType","operator":"NotIn","kind":"Enum"}},{"name":"currency","in":"query","description":"Only loan transactions whose loan currency is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/IsoCurrency"},{"type":"array","items":{"$ref":"#/components/schemas/IsoCurrency"}}]},"x-filter":{"filter":"currency","operator":"In","kind":"Currency"}},{"name":"currencyNot","in":"query","description":"Leave out loan transactions whose loan currency is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/IsoCurrency"},{"type":"array","items":{"$ref":"#/components/schemas/IsoCurrency"}}]},"x-filter":{"filter":"currency","operator":"NotIn","kind":"Currency"}},{"name":"referenceLoanTransactionId","in":"query","description":"Find a movement by your own reference.","required":false,"schema":{"type":"string"},"x-filter":{"filter":"referenceLoanTransactionId","operator":"Equals","kind":"Text"}},{"name":"createdAfter","in":"query","description":"Only loan transactions whose creation time is at or after this ISO-8601 timestamp.","required":false,"schema":{"type":"string","format":"date-time"},"x-filter":{"filter":"created","operator":"After","kind":"Instant"}},{"name":"createdBefore","in":"query","description":"Only loan transactions whose creation time is before, and not at, this ISO-8601 timestamp.","required":false,"schema":{"type":"string","format":"date-time"},"x-filter":{"filter":"created","operator":"Before","kind":"Instant"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LtxnPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"LoanTransactions","action":"Read"},"description":"Requires the `query` action on `loanTransactions` for the supplied runtime context","action":"query","resource":"loanTransactions"}},"post":{"tags":["Loans"],"description":"Post a fee or an adjustment to a loan. Answers with the movement, or with the loan's balances where the entry was a standalone fee.","operationId":"createLoanTransactions","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LtxnCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LtxnCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"LoanTransactions","action":"Create"},"description":"Requires the `create` action on `loanTransactions` for the supplied runtime context","action":"create","resource":"loanTransactions"}}},"/reference-entries":{"post":{"tags":["Reference data"],"description":"Look a bank branch up, list the industries, or load a register. A lookup needs `MerchantFinancials_Query`, a load `ReferenceData_Create`, and the industries no permission beyond the credential.","operationId":"createReferenceEntries","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"description":"Required action depends on the request variant","variants":[{"description":"Look an Australian bank branch up","schema":"RefCmdLookupBsb","actions":[{"grant":{"resource":"Merchants","action":"ReadFinancials"},"resource":"merchantFinancials","action":"query"}]},{"description":"Look a New Zealand bank branch up","schema":"RefCmdLookupNzPrefix","actions":[{"grant":{"resource":"Merchants","action":"ReadFinancials"},"resource":"merchantFinancials","action":"query"}]},{"description":"Load the Australian bank-branch register","schema":"RefCmdLoadAuRegister","actions":[{"grant":{"resource":"ReferenceData","action":"Create"},"resource":"referenceData","action":"create"}]},{"description":"Load the New Zealand bank-branch register","schema":"RefCmdLoadNzRegister","actions":[{"grant":{"resource":"ReferenceData","action":"Create"},"resource":"referenceData","action":"create"}]},{"description":"List the industries the platform recognises","schema":"RefCmdListIndustries","credentialOnly":true}]}}},"/bin-groups/{binGroupId}":{"get":{"tags":["Reference data"],"description":"Read one BIN group with its ranges.","operationId":"getBinGroup","parameters":[{"name":"binGroupId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BingView","description":"A named set of card-number ranges, which source rules match a card against."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"ReferenceData","action":"Read"},"description":"Requires the `query` action on `referenceData` for the supplied runtime context","action":"query","resource":"referenceData"}},"put":{"tags":["Reference data"],"description":"Replace a group's title and ranges. Whole, not partial, and it keeps the group's creation date, which a create cannot.","operationId":"replaceBinGroup","parameters":[{"name":"binGroupId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BingReplace"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BingView","description":"A named set of card-number ranges, which source rules match a card against."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"ReferenceData","action":"Create"},"description":"Requires the `create` action on `referenceData` for the supplied runtime context","action":"create","resource":"referenceData"}}},"/bin-groups":{"post":{"tags":["Reference data"],"description":"Create a BIN group. The platform assigns the identifier; a replace is the only way to change one afterwards.","operationId":"createBinGroups","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BingCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BingCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"ReferenceData","action":"Create"},"description":"Requires the `create` action on `referenceData` for the supplied runtime context","action":"create","resource":"referenceData"}}},"/abn-lookups":{"post":{"tags":["Reference data"],"description":"Ask the register about an ABN. The answer is the lookup, nothing is stored, so keep it.","operationId":"createAbnLookups","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AbnlkCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AbnlkCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"ReferenceData","action":"Read"},"description":"Requires the `query` action on `referenceData` for the supplied runtime context","action":"query","resource":"referenceData"}}},"/ledgers/{ledgerId}":{"patch":{"tags":["Ledgers and journals"],"description":"Recount a ledger from a point in time, optionally from a stated opening balance.","operationId":"updateLedger","parameters":[{"name":"ledgerId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SldgUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SldgUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"SystemLedgerEntries","action":"Create"},"description":"Requires the `create` action on `systemLedgerEntries` for the supplied runtime context","action":"create","resource":"systemLedgerEntries"}}},"/ledgers":{"patch":{"tags":["Ledgers and journals"],"description":"Clear the ledgers of a set of merchants or loans, or adjust or correct one loan's balance. A clearance answers with what was cleared, an empty list clears every owner of that kind; an adjustment or correction answers with the loan's ledger.","operationId":"updateLedgers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SldgCollectionUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SldgClearance"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"SystemLedgerEntries","action":"Create"},"description":"Requires the `create` action on `systemLedgerEntries` for the supplied runtime context","action":"create","resource":"systemLedgerEntries"}}},"/journals/{journalId}":{"get":{"tags":["Ledgers and journals"],"description":"Return one journal: its five-part identity, and the ledger it clears into.","operationId":"getJournal","parameters":[{"name":"journalId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SjnlView","description":"A journal, the platform's double-entry record of money moving."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"SystemJournals","action":"Read"},"description":"Requires the `query` action on `systemJournals` for the supplied runtime context","action":"query","resource":"systemJournals"}},"patch":{"tags":["Ledgers and journals"],"description":"Link a journal to the ledger it clears into, and record when it last cleared.","operationId":"updateJournal","parameters":[{"name":"journalId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SjnlUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SjnlUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"SystemJournals","action":"Update"},"description":"Requires the `update` action on `systemJournals` for the supplied runtime context","action":"update","resource":"systemJournals"}}},"/journals":{"get":{"tags":["Ledgers and journals"],"description":"Return a page of journals. A journal is identified by five things together, so the filters narrow rather than name one.","operationId":"queryJournals","parameters":[{"name":"q","in":"query","description":"Search. Matches a journal id, the id of its ledger, the owner's name or the owner identifier. An id, an email address, a phone number and any value listed as matched exactly match exactly; any other term matches without regard to case from the start of a value (or of any word in it, beside a longer word of the term), or anywhere in it from three characters, every word of it somewhere; a term that matches nothing so is read again with typos tolerated. Closest matches come first unless `sort` is given.","required":false,"schema":{"type":"string","maxLength":100}},{"name":"page","in":"query","description":"Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"endingBefore","in":"query","description":"Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"Fields to sort by, comma-delimited, in priority order. Prefix a field with `-` for descending.","required":false,"explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/SjnlSort"}}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/SjnlColumn"}}},{"name":"ownerType","in":"query","description":"Filter by what kind of party owns the journal.","required":false,"schema":{"$ref":"#/components/schemas/SjnlOwnerType"}},{"name":"ownerIdentifier","in":"query","description":"Which owner of that kind. Repeat the parameter to supply several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]}},{"name":"category","in":"query","description":"Which of that owner's journals. Repeat the parameter to supply several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/JnalCategory"},{"type":"array","items":{"$ref":"#/components/schemas/JnalCategory"}}]}},{"name":"linkedToLedger","in":"query","description":"Whether the journal has been linked to the ledger it clears into.","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SjnlPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"SystemJournals","action":"Read"},"description":"Requires the `query` action on `systemJournals` for the supplied runtime context","action":"query","resource":"systemJournals"}},"patch":{"tags":["Ledgers and journals"],"description":"Open or clear the journals of a set of merchants. Answers with what was done, an empty `merchantIds` acts on every merchant.","operationId":"updateJournals","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SjnlCollectionUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SjnlMaintenance"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"SystemJournals","action":"Update"},"description":"Requires the `update` action on `systemJournals` for the supplied runtime context","action":"update","resource":"systemJournals"}}},"/enterprises/{enterpriseId}":{"get":{"tags":["Enterprises"],"description":"Return one enterprise.","operationId":"getEnterprise","parameters":[{"name":"enterpriseId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntView","description":"A platform tenant, the party that holds the contract everything else sits under."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Enterprises","action":"Read"},"description":"Requires the `query` action on `enterprises` for the supplied runtime context","action":"query","resource":"enterprises"}},"patch":{"tags":["Enterprises"],"description":"Add or replace a public encryption key for the enterprise, give or replace its registration, set its branding, or set the hosts it serves. One operation per request. An enterprise's own credential may do all but the last for its own enterprise; claiming hosts is the platform's alone.","operationId":"updateEnterprise","parameters":[{"name":"enterpriseId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Enterprises","action":"Update"},"description":"Requires the `update` action on `enterprises` for the supplied runtime context","action":"update","resource":"enterprises"}}},"/enterprises":{"get":{"tags":["Enterprises"],"description":"Return a page of enterprises. Supply `page` for offset pagination or `startingAfter` for cursor pagination, and `q` to search. `GET /filter-catalogues/enterprises` lists the filters this caller can use. A cursor continues only the walk that issued it: sent with different filters, `q` or `sort`, it is refused with 400.","operationId":"queryEnterprises","parameters":[{"name":"q","in":"query","description":"Search. Matches an enterprise id, the business name, the slug, the company email address or the company phone number. An id, an email address, a phone number and any value listed as matched exactly match exactly; any other term matches without regard to case from the start of a value (or of any word in it, beside a longer word of the term), or anywhere in it from three characters, every word of it somewhere; a term that matches nothing so is read again with typos tolerated. Closest matches come first unless `sort` is given.","required":false,"schema":{"type":"string","maxLength":100}},{"name":"page","in":"query","description":"Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"endingBefore","in":"query","description":"Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"Fields to sort by, comma-delimited, in priority order. Prefix a field with `-` for descending.","required":false,"explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/EntSort"}}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/EntColumn"}}},{"name":"businessName","in":"query","description":"Only enterprises whose registered business name is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"businessName","operator":"In","kind":"Text"}},{"name":"slug","in":"query","description":"Only enterprises whose slug is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"slug","operator":"In","kind":"Text"}},{"name":"createdAfter","in":"query","description":"Only enterprises whose creation time is at or after this ISO-8601 timestamp.","required":false,"schema":{"type":"string","format":"date-time"},"x-filter":{"filter":"created","operator":"After","kind":"Instant"}},{"name":"createdBefore","in":"query","description":"Only enterprises whose creation time is at or before this ISO-8601 timestamp.","required":false,"schema":{"type":"string","format":"date-time"},"x-filter":{"filter":"created","operator":"Before","kind":"Instant"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Enterprises","action":"Read"},"description":"Requires the `query` action on `enterprises` for the supplied runtime context","action":"query","resource":"enterprises"}},"post":{"tags":["Enterprises"],"description":"Create an enterprise. The response carries its API key, once.","operationId":"createEnterprises","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Enterprises","action":"Create"},"description":"Requires the `create` action on `enterprises` for the supplied runtime context","action":"create","resource":"enterprises"}}},"/auth-types/{authTypeId}":{"get":{"tags":["Identity"],"description":"Return one authentication-type mapping.","operationId":"getAuthType","parameters":[{"name":"authTypeId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthtypeView","description":"How the users of one permission domain sign in."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"OidcIdps","action":"Read"},"description":"Requires the `query` action on `oidcIdps` for the supplied runtime context","action":"query","resource":"oidcIdps"}},"patch":{"tags":["Identity"],"description":"Change how a permission domain's users sign in.","operationId":"updateAuthType","parameters":[{"name":"authTypeId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthtypeUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthtypeUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"OidcIdps","action":"Update"},"description":"Requires the `update` action on `oidcIdps` for the supplied runtime context","action":"update","resource":"oidcIdps"}}},"/auth-types":{"get":{"tags":["Identity"],"description":"Return a page of authentication-type mappings. Supply `domainKey` to read exactly one, `page` or `cursor` to paginate, and `q` to search.","operationId":"queryAuthTypes","parameters":[{"name":"q","in":"query","description":"Search. Matches an authentication type id, or the id of the enterprise, marketplace, merchant, customer or delegate it is for. An id, an email address, a phone number and any value listed as matched exactly match exactly; any other term matches without regard to case from the start of a value (or of any word in it, beside a longer word of the term), or anywhere in it from three characters, every word of it somewhere; a term that matches nothing so is read again with typos tolerated. Closest matches come first unless `sort` is given.","required":false,"schema":{"type":"string","maxLength":100}},{"name":"page","in":"query","description":"Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"endingBefore","in":"query","description":"Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"Fields to sort by, comma-delimited, in priority order. Prefix a field with `-` for descending.","required":false,"explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/AuthtypeSort"}}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/AuthtypeColumn"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthtypePage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"OidcIdps","action":"Read"},"description":"Requires the `query` action on `oidcIdps` for the supplied runtime context","action":"query","resource":"oidcIdps"}},"post":{"tags":["Identity"],"description":"Map a login-capable permission domain to the authentication type its users use.","operationId":"createAuthTypes","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthtypeCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthtypeCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"OidcIdps","action":"Create"},"description":"Requires the `create` action on `oidcIdps` for the supplied runtime context","action":"create","resource":"oidcIdps"}}},"/loan-products/{loanProductId}":{"get":{"tags":["Loans"],"description":"Return one loan product.","operationId":"getLoanProduct","parameters":[{"name":"loanProductId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LprodView","description":"The terms loans are written on, fees, statement frequency and limits, funded by one facility."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"LoanProducts","action":"Read"},"description":"Requires the `query` action on `loanProducts` for the supplied runtime context","action":"query","resource":"loanProducts"}},"patch":{"tags":["Loans"],"description":"Change a product's limits or its late-payment grace days. Nothing else about a product can be changed.","operationId":"updateLoanProduct","parameters":[{"name":"loanProductId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LprodUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LprodUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"LoanProducts","action":"Update"},"description":"Requires the `update` action on `loanProducts` for the supplied runtime context","action":"update","resource":"loanProducts"}}},"/loan-products":{"get":{"tags":["Loans"],"description":"Return a page of loan products. Supply `page` for offset pagination or `startingAfter` for cursor pagination, and `q` to search. `GET /filter-catalogues/loan-products` lists the filters this caller can use. A cursor continues only the walk that issued it: sent with different filters, `q` or `sort`, it is refused with 400.","operationId":"queryLoanProducts","parameters":[{"name":"q","in":"query","description":"Search. Matches a loan product id, the id of its facility, or the description. An id, an email address, a phone number and any value listed as matched exactly match exactly; any other term matches without regard to case from the start of a value (or of any word in it, beside a longer word of the term), or anywhere in it from three characters, every word of it somewhere; a term that matches nothing so is read again with typos tolerated. Closest matches come first unless `sort` is given.","required":false,"schema":{"type":"string","maxLength":100}},{"name":"page","in":"query","description":"Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"endingBefore","in":"query","description":"Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"Fields to sort by, comma-delimited, in priority order. Prefix a field with `-` for descending.","required":false,"explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/LprodSort"}}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/LprodColumn"}}},{"name":"status","in":"query","description":"Only loan products whose status is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/LprodStatus"},{"type":"array","items":{"$ref":"#/components/schemas/LprodStatus"}}]},"x-filter":{"filter":"status","operator":"In","kind":"Enum"}},{"name":"statusNot","in":"query","description":"Leave out loan products whose status is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/LprodStatus"},{"type":"array","items":{"$ref":"#/components/schemas/LprodStatus"}}]},"x-filter":{"filter":"status","operator":"NotIn","kind":"Enum"}},{"name":"productType","in":"query","description":"Only loan products whose kind is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/LprodType"},{"type":"array","items":{"$ref":"#/components/schemas/LprodType"}}]},"x-filter":{"filter":"productType","operator":"In","kind":"Enum"}},{"name":"productTypeNot","in":"query","description":"Leave out loan products whose kind is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/LprodType"},{"type":"array","items":{"$ref":"#/components/schemas/LprodType"}}]},"x-filter":{"filter":"productType","operator":"NotIn","kind":"Enum"}},{"name":"currency","in":"query","description":"Only loan products whose currency is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/IsoCurrency"},{"type":"array","items":{"$ref":"#/components/schemas/IsoCurrency"}}]},"x-filter":{"filter":"currency","operator":"In","kind":"Currency"}},{"name":"currencyNot","in":"query","description":"Leave out loan products whose currency is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/IsoCurrency"},{"type":"array","items":{"$ref":"#/components/schemas/IsoCurrency"}}]},"x-filter":{"filter":"currency","operator":"NotIn","kind":"Currency"}},{"name":"loanFacilityId","in":"query","description":"Only loan products whose facility is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"loanFacilityId","operator":"In","kind":"Id"}},{"name":"loanFacilityIdNot","in":"query","description":"Leave out loan products whose facility is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"loanFacilityId","operator":"NotIn","kind":"Id"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LprodPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"LoanProducts","action":"Read"},"description":"Requires the `query` action on `loanProducts` for the supplied runtime context","action":"query","resource":"loanProducts"}},"post":{"tags":["Loans"],"description":"Create a loan product against a facility.","operationId":"createLoanProducts","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LprodCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LprodCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"LoanProducts","action":"Create"},"description":"Requires the `create` action on `loanProducts` for the supplied runtime context","action":"create","resource":"loanProducts"}}},"/loan-agreements/{loanAgreementId}":{"get":{"tags":["Loans"],"description":"Return one loan agreement.","operationId":"getLoanAgreement","parameters":[{"name":"loanAgreementId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LmaView","description":"The master agreement a set of loans is drawn under, and what is left of its limit."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"LoanMasterAgreements","action":"Read"},"description":"Requires the `query` action on `loanMasterAgreements` for the supplied runtime context","action":"query","resource":"loanMasterAgreements"}},"patch":{"tags":["Loans"],"description":"Change what may be outstanding on an agreement. An agreement cannot be renamed.","operationId":"updateLoanAgreement","parameters":[{"name":"loanAgreementId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LmaUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LmaUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"LoanMasterAgreements","action":"Update"},"description":"Requires the `update` action on `loanMasterAgreements` for the supplied runtime context","action":"update","resource":"loanMasterAgreements"}}},"/loan-agreements":{"get":{"tags":["Loans"],"description":"Return a page of loan agreements. Supply `page` for offset pagination or `startingAfter` for cursor pagination, and `q` to search. `GET /filter-catalogues/loan-agreements` lists the filters this caller can use. A cursor continues only the walk that issued it: sent with different filters, `q` or `sort`, it is refused with 400.","operationId":"queryLoanAgreements","parameters":[{"name":"q","in":"query","description":"Search. Matches a loan agreement id, the id of its facility, the reference agreement id or the description. An id, an email address, a phone number and any value listed as matched exactly match exactly; any other term matches without regard to case from the start of a value (or of any word in it, beside a longer word of the term), or anywhere in it from three characters, every word of it somewhere; a term that matches nothing so is read again with typos tolerated. Closest matches come first unless `sort` is given.","required":false,"schema":{"type":"string","maxLength":100}},{"name":"page","in":"query","description":"Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"endingBefore","in":"query","description":"Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"Fields to sort by, comma-delimited, in priority order. Prefix a field with `-` for descending.","required":false,"explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/LmaSort"}}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/LmaColumn"}}},{"name":"loanFacilityId","in":"query","description":"Only loan agreements whose facility is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"loanFacilityId","operator":"In","kind":"Id"}},{"name":"loanFacilityIdNot","in":"query","description":"Leave out loan agreements whose facility is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"loanFacilityId","operator":"NotIn","kind":"Id"}},{"name":"referenceAgreementId","in":"query","description":"Find an agreement by the applicant's own reference.","required":false,"schema":{"type":"string"},"x-filter":{"filter":"referenceAgreementId","operator":"Equals","kind":"Text"}},{"name":"currency","in":"query","description":"Only loan agreements whose currency is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/IsoCurrency"},{"type":"array","items":{"$ref":"#/components/schemas/IsoCurrency"}}]},"x-filter":{"filter":"currency","operator":"In","kind":"Currency"}},{"name":"currencyNot","in":"query","description":"Leave out loan agreements whose currency is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/IsoCurrency"},{"type":"array","items":{"$ref":"#/components/schemas/IsoCurrency"}}]},"x-filter":{"filter":"currency","operator":"NotIn","kind":"Currency"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LmaPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"LoanMasterAgreements","action":"Read"},"description":"Requires the `query` action on `loanMasterAgreements` for the supplied runtime context","action":"query","resource":"loanMasterAgreements"}},"post":{"tags":["Loans"],"description":"Create a loan agreement against a facility.","operationId":"createLoanAgreements","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LmaCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LmaCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"LoanMasterAgreements","action":"Create"},"description":"Requires the `create` action on `loanMasterAgreements` for the supplied runtime context","action":"create","resource":"loanMasterAgreements"}}},"/beneficial-owners/{beneficialOwnerId}":{"get":{"tags":["Merchants"],"description":"Read one owner, in full. The merchant is named by `merchantId` or the `Merchant-Id` header, the platform resolves an owner within its merchant.","operationId":"getBeneficialOwner","parameters":[{"name":"beneficialOwnerId","in":"path","required":true,"schema":{"type":"string"}},{"name":"merchantId","in":"query","description":"Whose owner this is. Omit it when the `Merchant-Id` header names the merchant.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PsonView","description":"A person who owns or controls a merchant, and the outcome of verifying them."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Merchants","action":"ReadKyb"},"description":"Requires the `query` action on `merchantKyb` for the supplied runtime context","action":"query","resource":"merchantKyb"}},"put":{"tags":["Merchants"],"description":"Replace everything known about an owner. Whole, not partial, and it names the merchant, because the platform needs one.","operationId":"replaceBeneficialOwner","parameters":[{"name":"beneficialOwnerId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PsonReplace"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PsonView","description":"A person who owns or controls a merchant, and the outcome of verifying them."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Merchants","action":"UpdateKyb"},"description":"Requires the `update` action on `merchantKyb` for the supplied runtime context","action":"update","resource":"merchantKyb"}},"delete":{"tags":["Merchants"],"description":"Remove an owner. Check `deletable` first, the last owner of a verified merchant cannot be removed.","operationId":"deleteBeneficialOwner","parameters":[{"name":"beneficialOwnerId","in":"path","required":true,"schema":{"type":"string"}},{"name":"merchantId","in":"query","description":"Whose owner this is. Omit it when the `Merchant-Id` header names the merchant.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":""},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Merchants","action":"DeleteKyb"},"description":"Requires the `delete` action on `merchantKyb` for the supplied runtime context","action":"delete","resource":"merchantKyb"}}},"/beneficial-owners":{"get":{"tags":["Merchants"],"description":"Return a merchant's beneficial owners. The merchant is named by `merchantId` or the `Merchant-Id` header, and the whole set comes back in one page.","operationId":"queryBeneficialOwners","parameters":[{"name":"q","in":"query","description":"Search. Matches a beneficial owner id, the first or last name, or the whole email address. An id, an email address, a phone number and any value listed as matched exactly match exactly; any other term matches without regard to case from the start of a value (or of any word in it, beside a longer word of the term), or anywhere in it from three characters, every word of it somewhere; a term that matches nothing so is read again with typos tolerated. Closest matches come first unless `sort` is given.","required":false,"schema":{"type":"string","maxLength":100}},{"name":"page","in":"query","description":"Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"endingBefore","in":"query","description":"Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/PsonColumn"}}},{"name":"merchantId","in":"query","description":"Whose owners to read. Omit it when the `Merchant-Id` header names the merchant.","required":false,"schema":{"type":"string"}},{"name":"verificationStatus","in":"query","description":"Filter by verification status. Repeat the parameter to supply several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/PsonVerificationStatus"},{"type":"array","items":{"$ref":"#/components/schemas/PsonVerificationStatus"}}]}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PsonPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Merchants","action":"ReadKyb"},"description":"Requires the `query` action on `merchantKyb` for the supplied runtime context","action":"query","resource":"merchantKyb"}},"post":{"tags":["Merchants"],"description":"Add a beneficial owner to a merchant. The platform verifies them; the response says how far it got.","operationId":"createBeneficialOwners","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PsonCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PsonCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Merchants","action":"CreateKyb"},"description":"Requires the `create` action on `merchantKyb` for the supplied runtime context","action":"create","resource":"merchantKyb"}}},"/organisations/{organisationId}":{"get":{"tags":["Parties"],"description":"Return one organisation in the caller's scope.","operationId":"getOrganisation","parameters":[{"name":"organisationId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrgView","description":"A business's legal record: what the business register says about it, how it is reached, who owns it and what it is evidenced by. One record is shared by every merchant, customer and owner in an enterprise that is the same business."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Organisations","action":"Read"},"description":"Requires the `query` action on `organisations` for the supplied runtime context","action":"query","resource":"organisations"}},"patch":{"tags":["Parties"],"description":"Replace the organisation's contact. It is replaced whole, so a field left out is cleared.","operationId":"updateOrganisation","parameters":[{"name":"organisationId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrgUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrgUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Organisations","action":"Update"},"description":"Requires the `update` action on `organisations` for the supplied runtime context","action":"update","resource":"organisations"}}},"/organisations":{"get":{"tags":["Parties"],"description":"Return a page of the organisations in the caller's scope, newest first unless `sort` says otherwise. Supply `page` for offset pagination or `startingAfter` for cursor pagination. A cursor continues only the walk that issued it: sent with different filters or `sort`, it is refused with 400.","operationId":"queryOrganisations","parameters":[{"name":"page","in":"query","description":"Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"endingBefore","in":"query","description":"Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"Fields to sort by, comma-delimited, in priority order. Prefix a field with `-` for descending.","required":false,"explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/OrgSort"}}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/OrgColumn"}}},{"name":"merchantId","in":"query","description":"Only the organisations linked to this merchant: its own, its customers' and the owners reached from either.","required":false,"schema":{"type":"string"},"x-filter":{"filter":"merchantId","operator":"Equals","kind":"Id"}},{"name":"customerId","in":"query","description":"Only the organisation a customer is, and the organisations that own it.","required":false,"schema":{"type":"string"},"x-filter":{"filter":"customerId","operator":"Equals","kind":"Id"}},{"name":"nameContains","in":"query","description":"Only organisations whose registered name contains this text.","required":false,"schema":{"type":"string","maxLength":200},"x-filter":{"filter":"name","operator":"Contains","kind":"Text"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrgPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Organisations","action":"Read"},"description":"Requires the `query` action on `organisations` for the supplied runtime context","action":"query","resource":"organisations"}}},"/persons/{personId}":{"get":{"tags":["Parties"],"description":"Return one person in the caller's scope.","operationId":"getPerson","parameters":[{"name":"personId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrsnView"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Persons","action":"Read"},"description":"Requires the `query` action on `persons` for the supplied runtime context","action":"query","resource":"persons"}}},"/persons":{"get":{"tags":["Parties"],"description":"Return a page of the persons in the caller's scope, newest first unless `sort` says otherwise. Supply `page` for offset pagination or `startingAfter` for cursor pagination. A cursor continues only the walk that issued it: sent with different filters or `sort`, it is refused with 400.","operationId":"queryPersons","parameters":[{"name":"page","in":"query","description":"Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"endingBefore","in":"query","description":"Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"Fields to sort by, comma-delimited, in priority order. Prefix a field with `-` for descending.","required":false,"explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/PrsnSort"}}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/PrsnColumn"}}},{"name":"merchantId","in":"query","description":"Only the persons linked to this merchant: its own persons, its customers' and the owners reached from either.","required":false,"schema":{"type":"string"},"x-filter":{"filter":"merchantId","operator":"Equals","kind":"Id"}},{"name":"customerId","in":"query","description":"Only the person a customer is, and the persons who own the organisation a customer is.","required":false,"schema":{"type":"string"},"x-filter":{"filter":"customerId","operator":"Equals","kind":"Id"}},{"name":"nameContains","in":"query","description":"Only persons whose name contains this text.","required":false,"schema":{"type":"string","maxLength":200},"x-filter":{"filter":"name","operator":"Contains","kind":"Text"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrsnPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Persons","action":"Read"},"description":"Requires the `query` action on `persons` for the supplied runtime context","action":"query","resource":"persons"}}},"/suppliers/{supplierId}":{"get":{"tags":["Parties"],"description":"Return one supplier in the caller's scope.","operationId":"getSupplier","parameters":[{"name":"supplierId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuplView"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Suppliers","action":"Read"},"description":"Requires the `query` action on `suppliers` for the supplied runtime context","action":"query","resource":"suppliers"}}},"/suppliers":{"get":{"tags":["Parties"],"description":"Return a page of the suppliers in the caller's scope, newest first unless `sort` says otherwise. Supply `page` for offset pagination or `startingAfter` for cursor pagination.","operationId":"querySuppliers","parameters":[{"name":"page","in":"query","description":"Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"endingBefore","in":"query","description":"Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"Fields to sort by, comma-delimited, in priority order. Prefix a field with `-` for descending.","required":false,"explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/SuplSort"}}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/SuplColumn"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuplPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Suppliers","action":"Read"},"description":"Requires the `query` action on `suppliers` for the supplied runtime context","action":"query","resource":"suppliers"}}},"/queues":{"get":{"tags":["Operations"],"description":"Return every queue the platform drains, with what each consumer group on it is doing.","operationId":"queryQueues","parameters":[{"name":"page","in":"query","description":"1-based page number.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/QueueColumn"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueuePage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Queues","action":"Read"},"description":"Requires the `query` action on `queues` for the supplied runtime context","action":"query","resource":"queues"}}},"/queues/{queueId}":{"get":{"tags":["Operations"],"description":"Return one queue by name, with what each consumer group on it is doing.","operationId":"getQueue","parameters":[{"name":"queueId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Queue","description":"A queue the platform drains internally, and every consumer group draining it."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Queues","action":"Read"},"description":"Requires the `query` action on `queues` for the supplied runtime context","action":"query","resource":"queues"}},"patch":{"tags":["Operations"],"description":"Replay up to 100 of this queue's dead letters at once, each published again unchanged. Answers with the outcome for every id, `Replayed`, `NotFound` or `Failed`, and the queue as it reads afterwards. One that fails does not stop the rest.","operationId":"updateQueue","parameters":[{"name":"queueId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueDlqReplays"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Queues","action":"Update"},"description":"Requires the `update` action on `queues` for the supplied runtime context","action":"update","resource":"queues"}}},"/queues/{queueId}/dead-letters":{"get":{"tags":["Operations"],"description":"Return the messages this queue's consumers could not handle, newest first.","operationId":"queryQueueDeadLetters","parameters":[{"name":"queueId","in":"path","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"1-based page number.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"consumer","in":"query","description":"Only the messages this consumer group could not handle.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueuedlqPage"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Queues","action":"Read"},"description":"Requires the `query` action on `queues` for the supplied runtime context","action":"query","resource":"queues"}}},"/queues/{queueId}/dead-letters/{deadLetterId}":{"get":{"tags":["Operations"],"description":"Return one dead letter, with the message exactly as it was published. A deadLetter that does not belong to this queue is a 404, not a redirect.","operationId":"getQueueDeadLetter","parameters":[{"name":"queueId","in":"path","required":true,"schema":{"type":"string"}},{"name":"deadLetterId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueDeadLetter","description":"A message a consumer group could not handle, kept exactly as it was published."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Queues","action":"Read"},"description":"Requires the `query` action on `queues` for the supplied runtime context","action":"query","resource":"queues"}},"patch":{"tags":["Operations"],"description":"Act on one dead letter. `QueueDlqReplay` publishes the message again, unchanged. A deadLetter that does not belong to this queue is a 404, not a redirect.","operationId":"updateQueueDeadLetter","parameters":[{"name":"queueId","in":"path","required":true,"schema":{"type":"string"}},{"name":"deadLetterId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueDlqPatch"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueuedlqUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Queues","action":"Update"},"description":"Requires the `update` action on `queues` for the supplied runtime context","action":"update","resource":"queues"}}},"/rule-areas":{"get":{"tags":["Reference data"],"description":"Return every rule area the platform has registered, each with what it offers.","operationId":"queryRuleAreas","parameters":[{"name":"page","in":"query","description":"1-based page number.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/RareaColumn"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RareaPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Rules","action":"Read"},"description":"Requires the `query` action on `rules` for the supplied runtime context","action":"query","resource":"rules"}}},"/rule-areas/{ruleAreaId}":{"get":{"tags":["Reference data"],"description":"Return one rule area by its domain, with its templates, fields, actions and list kinds.","operationId":"getRuleArea","parameters":[{"name":"ruleAreaId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RareaView"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Rules","action":"Read"},"description":"Requires the `query` action on `rules` for the supplied runtime context","action":"query","resource":"rules"}}},"/rule-policies/{rulePolicyId}":{"get":{"tags":["Reference data"],"description":"Return one rule policy as its current version holds it, with its rule.","operationId":"getRulePolicy","parameters":[{"name":"rulePolicyId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RpolView","description":"A rule, held by a tenant. It is made from one of its area's templates, and each change is a version of its own: a version is made by one person and approved by another, and only an approved version is part of a ruleset. The tenant that owns it manages it, as do the tenants above it; the tenants beneath it read it."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Rules","action":"Read"},"description":"Requires the `query` action on `rules` for the supplied runtime context","action":"query","resource":"rules"}},"patch":{"tags":["Reference data"],"description":"Make the next version of a policy, or take a step of the maker and checker flow: submit, approve or reject a version, pause, resume or retire the rule.","operationId":"updateRulePolicy","parameters":[{"name":"rulePolicyId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RpolUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RpolUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Rules","action":"Update"},"description":"Requires the `update` action on `rules` for the supplied runtime context","action":"update","resource":"rules"}}},"/rule-policies":{"get":{"tags":["Reference data"],"description":"Return a page of the policies the caller may see in one area, newest change first, optionally only one owner's and only those in one state. Walk the pages with `page`, or pass `nextStartingAfter` back as `startingAfter`.","operationId":"queryRulePolicies","parameters":[{"name":"page","in":"query","description":"Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"endingBefore","in":"query","description":"Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/RpolColumn"}}},{"name":"domain","in":"query","description":"The area whose policies are listed, as `ruleAreaId` names it.","required":true,"schema":{"type":"string"}},{"name":"ownerType","in":"query","description":"Only the policies this tenant owns, named with `ownerId`. Absent for every owner the caller may see.","required":false,"schema":{"$ref":"#/components/schemas/RpolOwnerType"}},{"name":"ownerId","in":"query","description":"The id of the owner `ownerType` names. Absent for the platform.","required":false,"schema":{"type":"string"}},{"name":"state","in":"query","description":"Only the policies whose current version is in this state.","required":false,"schema":{"$ref":"#/components/schemas/RpolState"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RpolPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Rules","action":"Read"},"description":"Requires the `query` action on `rules` for the supplied runtime context","action":"query","resource":"rules"}},"post":{"tags":["Reference data"],"description":"Make a rule policy as a draft at version 1. The rule is checked against its template and its owner's lists, and refused with every reason if it fails.","operationId":"createRulePolicies","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RpolCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RpolCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Rules","action":"Update"},"description":"Requires the `update` action on `rules` for the supplied runtime context","action":"update","resource":"rules"}}},"/rule-policies/{rulePolicyId}/versions":{"get":{"tags":["Reference data"],"description":"Return a page of the versions of a policy, oldest first, each with its rule, what it changed, why, by whom and when.","operationId":"queryRulePolicyVersions","parameters":[{"name":"rulePolicyId","in":"path","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"endingBefore","in":"query","description":"Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RpolVersionPage"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Rules","action":"Read"},"description":"Requires the `query` action on `rules` for the supplied runtime context","action":"query","resource":"rules"}}},"/rule-policies/{rulePolicyId}/versions/{versionId}":{"get":{"tags":["Reference data"],"description":"Return one version of a policy with the rule it held. A version that does not belong to this rulePolicy is a 404, not a redirect.","operationId":"getRulePolicyVersion","parameters":[{"name":"rulePolicyId","in":"path","required":true,"schema":{"type":"string"}},{"name":"versionId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RpolVersion"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Rules","action":"Read"},"description":"Requires the `query` action on `rules` for the supplied runtime context","action":"query","resource":"rules"}}},"/named-lists/{namedListId}":{"get":{"tags":["Reference data"],"description":"Return one named list as its current version holds it, without its entries.","operationId":"getNamedList","parameters":[{"name":"namedListId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NlstView","description":"A named set of entries that rules read by name, such as the countries a rule applies to. A rule names a list rather than holding its entries, so an edit to the list reaches every rule that names it. A list has one owner, which alone adds and removes its entries, as do the tenants above it. A rule may name the lists of its own owner and of the tenants above it, and no others."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Rules","action":"Read"},"description":"Requires the `query` action on `rules` for the supplied runtime context","action":"query","resource":"rules"}},"patch":{"tags":["Reference data"],"description":"Add entries to a list and take entries from it, as its next version. An edit that changes nothing writes no version.","operationId":"updateNamedList","parameters":[{"name":"namedListId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NlstUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NlstUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Rules","action":"Update"},"description":"Requires the `update` action on `rules` for the supplied runtime context","action":"update","resource":"rules"}}},"/named-lists":{"get":{"tags":["Reference data"],"description":"Return a page of the named lists the caller may see in one area, newest change first, optionally only one owner's.","operationId":"queryNamedLists","parameters":[{"name":"page","in":"query","description":"Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"endingBefore","in":"query","description":"Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/NlstColumn"}}},{"name":"domain","in":"query","description":"The area whose lists are listed, as `ruleAreaId` names it.","required":true,"schema":{"type":"string"}},{"name":"ownerType","in":"query","description":"Only the lists this tenant owns, named with `ownerId`. Absent for every owner the caller may see.","required":false,"schema":{"$ref":"#/components/schemas/RpolOwnerType"}},{"name":"ownerId","in":"query","description":"The id of the owner `ownerType` names. Absent for the platform.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NlstPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Rules","action":"Read"},"description":"Requires the `query` action on `rules` for the supplied runtime context","action":"query","resource":"rules"}},"post":{"tags":["Reference data"],"description":"Make a named list holding the entries given, as version 1. Every entry is checked against the list's kind, and refused with every reason if it fails.","operationId":"createNamedLists","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NlstCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NlstCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Rules","action":"Update"},"description":"Requires the `update` action on `rules` for the supplied runtime context","action":"update","resource":"rules"}}},"/named-lists/{namedListId}/entries":{"get":{"tags":["Reference data"],"description":"Return the entries a list held at a version, the current one where none is named, in the order of their values. A version the list never had is a 404.","operationId":"queryNamedListEntries","parameters":[{"name":"namedListId","in":"path","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"endingBefore","in":"query","description":"Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"version","in":"query","description":"The version of the list whose entries are read. The current version where absent.","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NlstEntryPage"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Rules","action":"Read"},"description":"Requires the `query` action on `rules` for the supplied runtime context","action":"query","resource":"rules"}}},"/named-lists/{namedListId}/versions":{"get":{"tags":["Reference data"],"description":"Return every version of a list, oldest first, with the entries each added and removed, why, by whom and when.","operationId":"queryNamedListVersions","parameters":[{"name":"namedListId","in":"path","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"endingBefore","in":"query","description":"Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NlstVersionPage"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Rules","action":"Read"},"description":"Requires the `query` action on `rules` for the supplied runtime context","action":"query","resource":"rules"}}},"/rule-decisions":{"get":{"tags":["Reference data"],"description":"Return a page of the decisions made for one target in one area, latest first, each with the fields it read and what each rule did.","operationId":"queryRuleDecisions","parameters":[{"name":"page","in":"query","description":"Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"endingBefore","in":"query","description":"Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/RdecColumn"}}},{"name":"domain","in":"query","description":"The area whose decisions are listed, as `ruleAreaId` names it.","required":true,"schema":{"type":"string"}},{"name":"targetId","in":"query","description":"The target the decisions were made for, as a contextual id or as the 24 hexadecimal characters of its id without the prefix.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RdecPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Rules","action":"Read"},"description":"Requires the `query` action on `rules` for the supplied runtime context","action":"query","resource":"rules"}}},"/feature-flags":{"get":{"tags":["Operations"],"description":"Return every flag the platform declares, with who each is on for.","operationId":"queryFeatureFlags","parameters":[{"name":"page","in":"query","description":"1-based page number.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/FflagColumn"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FflagPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Queues","action":"Read"},"description":"Requires the `query` action on `queues` for the supplied runtime context","action":"query","resource":"queues"}}},"/feature-flags/{featureFlagId}":{"get":{"tags":["Operations"],"description":"Return one flag by name, with who it is on for.","operationId":"getFeatureFlag","parameters":[{"name":"featureFlagId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FflagView","description":"A feature the platform turns on for some callers before it turns it on for every caller, and who it is on for now. A caller it is off for is answered as though the feature's endpoints did not exist."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Queues","action":"Read"},"description":"Requires the `query` action on `queues` for the supplied runtime context","action":"query","resource":"queues"}},"patch":{"tags":["Operations"],"description":"Change who a flag is on for: set its mode, or add to or take from its tenants or its people. Answers with the flag as it now is.","operationId":"updateFeatureFlag","parameters":[{"name":"featureFlagId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FflagUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FflagUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Queues","action":"Update"},"description":"Requires the `update` action on `queues` for the supplied runtime context","action":"update","resource":"queues"}}},"/report-datasets":{"get":{"tags":["Reporting"],"description":"Return every dataset this caller may ask questions of. The caller may keep the answer for five minutes.","operationId":"queryReportDatasets","parameters":[{"name":"q","in":"query","description":"Free-text search. Supplying it engages the search index; omit it to filter only.","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"1-based page number.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/RdsetColumn"}}}],"responses":{"200":{"description":"","headers":{"Cache-Control":{"description":"The answer is this caller's: kept by it for five minutes, by no shared cache.","required":true,"schema":{"type":"string"}},"Vary":{"description":"A kept answer is the credential's that asked: a cache holds one per `Authorization`.","required":true,"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RdsetPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Reports","action":"Read"},"description":"Requires the `query` action on `reports` for the supplied runtime context","action":"query","resource":"reports"}}},"/report-datasets/{reportDatasetId}":{"get":{"tags":["Reporting"],"description":"Return one dataset: its dimensions, measures and time grains. The caller may keep the answer for five minutes.","operationId":"getReportDataset","parameters":[{"name":"reportDatasetId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{"Cache-Control":{"description":"The answer is this caller's: kept by it for five minutes, by no shared cache.","required":true,"schema":{"type":"string"}},"Vary":{"description":"A kept answer is the credential's that asked: a cache holds one per `Authorization`.","required":true,"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Rdset"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Reports","action":"Read"},"description":"Requires the `query` action on `reports` for the supplied runtime context","action":"query","resource":"reports"}}},"/report-datasets/{reportDatasetId}/dimension-values":{"get":{"tags":["Reporting"],"description":"Find the values a dimension can be filtered to, a page at a time. `q` is the search text, required for a `Search` lookup. The values page by cursor in a fixed order: a lookup searched by name in name order, a declared list in its declared order, anything else in its values' order. Pass `nextStartingAfter` back as `startingAfter` for the next page; `hasMore` says whether one follows. A cursor continues only the walk that issued it, the same dimension and `q`, and is refused with 400 otherwise. The walk is forward only, so `endingBefore` and `page` are refused with 400. A listed dimension's page is its declaration's, which the caller may keep for five minutes (`Cache-Control: private, max-age=300`); a searched or referenced one is read from the data each time and carries no `Cache-Control`.","operationId":"queryReportDatasetDimensionValues","parameters":[{"name":"reportDatasetId","in":"path","required":true,"schema":{"type":"string"}},{"name":"q","in":"query","description":"Free-text search. Supplying it engages the search index; omit it to filter only.","required":false,"schema":{"type":"string"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, forward only: the `nextStartingAfter` of the page before.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"dimension","in":"query","description":"The dimension to list values of. Required.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{"Cache-Control":{"description":"`private, max-age=300` where the answer is a set the caller may keep for five minutes; absent where it is read from the data.","required":false,"schema":{"type":"string"}},"Vary":{"description":"A kept answer is the credential's that asked: a cache holds one per `Authorization`.","required":true,"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RdsetValuePage"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Reports","action":"Read"},"description":"Requires the `query` action on `reports` for the supplied runtime context","action":"query","resource":"reports"}}},"/report-ranges":{"get":{"tags":["Reporting"],"description":"Return every named time range, in display order.","operationId":"queryReportRanges","parameters":[{"name":"page","in":"query","description":"1-based page number.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/RrngColumn"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RrngPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Reports","action":"Read"},"description":"Requires the `query` action on `reports` for the supplied runtime context","action":"query","resource":"reports"}}},"/report-ranges/{reportRangeId}":{"get":{"tags":["Reporting"],"description":"Return one named time range, by its name.","operationId":"getReportRange","parameters":[{"name":"reportRangeId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Rrng"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Reports","action":"Read"},"description":"Requires the `query` action on `reports` for the supplied runtime context","action":"query","resource":"reports"}}},"/report-queries":{"post":{"tags":["Reporting"],"description":"Ask a dataset a question. The answer is returned and not stored.","operationId":"createReportQueries","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RqryCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RqryCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Reports","action":"Read"},"description":"Requires the `query` action on `reports` for the supplied runtime context","action":"query","resource":"reports"}}},"/report-query-batches":{"post":{"tags":["Reporting"],"description":"Ask several questions at once. The answers come back in the order asked, each answered or refused.","operationId":"createReportQueryBatches","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RqbatCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RqbatCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Reports","action":"Read"},"description":"Requires the `query` action on `reports` for the supplied runtime context","action":"query","resource":"reports"}}},"/report-exports":{"post":{"tags":["Reporting"],"description":"Export a question's whole answer. The answer is the file, and nothing is stored.","operationId":"createReportExports","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RexpCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RexpCreateRsp"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Reports","action":"Read"},"description":"Requires the `query` action on `reports` for the supplied runtime context","action":"query","resource":"reports"}}},"/report-query-plans":{"post":{"tags":["Reporting"],"description":"Explain a question: its SQL, plan and estimated cost. Nothing is run and nothing is stored.","operationId":"createReportQueryPlans","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RqplanCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RqplanCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Reports","action":"Read"},"description":"Requires the `query` action on `reports` for the supplied runtime context","action":"query","resource":"reports"}}},"/report-spaces/{reportSpaceId}":{"get":{"tags":["Reporting"],"description":"Return one space the caller can see.","operationId":"getReportSpace","parameters":[{"name":"reportSpaceId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RspcView","description":"A folder of saved charts, dashboards and notebooks. Everything in it is seen by whoever sees the space."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Reports","action":"Read"},"description":"Requires the `query` action on `reports` for the supplied runtime context","action":"query","resource":"reports"}},"delete":{"tags":["Reporting"],"description":"Delete a space the caller may change, moving what it held up to its parent, or from a private space at the top to the caller's default space. A shared space at the top and the default space must be empty, and the System space cannot be deleted.","operationId":"deleteReportSpace","parameters":[{"name":"reportSpaceId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":""},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Reports","action":"Read"},"description":"Requires the `query` action on `reports` for the supplied runtime context","action":"query","resource":"reports"}},"patch":{"tags":["Reporting"],"description":"Rename, move or share a space the caller may change. Sharing one, or changing a shared one, needs `Reports_Manage` as well, and the System space keeps its name and place.","operationId":"updateReportSpace","parameters":[{"name":"reportSpaceId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RspcUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RspcUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"description":"Required action depends on the request variant","variants":[{"description":"Rename a space","schema":"RspcUpdateRename","actions":[{"grant":{"resource":"Reports","action":"Read"},"resource":"reports","action":"query"}]},{"description":"Move a space into another","schema":"RspcUpdateMove","actions":[{"grant":{"resource":"Reports","action":"Read"},"resource":"reports","action":"query"}]},{"description":"Move a space to the top","schema":"RspcUpdateMoveToTop","actions":[{"grant":{"resource":"Reports","action":"Read"},"resource":"reports","action":"query"}]},{"description":"Share a private space with its tenant","schema":"RspcUpdateShare","actions":[{"grant":{"resource":"Reports","action":"Read"},"resource":"reports","action":"query"},{"grant":{"resource":"Reports","action":"Update"},"resource":"reports","action":"update"}]}]}}},"/report-spaces":{"get":{"tags":["Reporting"],"description":"Return a page of the spaces the caller can see, in the order they were saved. `q` matches part of a name. Walk the pages by passing `nextStartingAfter` back as `startingAfter`; `page` and `endingBefore` are refused with 400.","operationId":"queryReportSpaces","parameters":[{"name":"q","in":"query","description":"Free-text search. Supplying it engages the search index; omit it to filter only.","required":false,"schema":{"type":"string"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, forward only: the `nextStartingAfter` of the page before.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/RspcColumn"}}},{"name":"reportSpaceId","in":"query","description":"Only the spaces sitting directly in this one.","required":false,"schema":{"type":"string"}},{"name":"owner","in":"query","description":"`me` for what the caller saved.","required":false,"schema":{"type":"string"}},{"name":"tenant","in":"query","description":"Only the spaces of this enterprise, marketplace or merchant id. The caller's own tenant lists the spaces it sees there; a tenant beneath it lists the spaces that tenant shares, read only, for a caller with `ReportsOversight_Query`.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RspcPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Reports","action":"Read"},"description":"Requires the `query` action on `reports` for the supplied runtime context","action":"query","resource":"reports"}},"post":{"tags":["Reporting"],"description":"Save a space, or with `RspcCmdDefault` find or make the caller's default space. A shared one needs `Reports_Manage` as well.","operationId":"createReportSpaces","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RspcCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RspcCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Reports","action":"Read"},"description":"Requires the `query` action on `reports` for the supplied runtime context","action":"query","resource":"reports"}}},"/report-charts/{reportChartId}":{"get":{"tags":["Reporting"],"description":"Return one chart the caller can read.","operationId":"getReportChart","parameters":[{"name":"reportChartId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RchtView","description":"A saved question and how it is drawn. A dashboard's tiles show charts, and a change to a chart reaches every dashboard showing it."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Reports","action":"Read"},"description":"Requires the `query` action on `reports` for the supplied runtime context","action":"query","resource":"reports"}},"delete":{"tags":["Reporting"],"description":"Delete a chart the caller may change, and its tiles from every dashboard showing it.","operationId":"deleteReportChart","parameters":[{"name":"reportChartId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":""},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Reports","action":"Read"},"description":"Requires the `query` action on `reports` for the supplied runtime context","action":"query","resource":"reports"}},"patch":{"tags":["Reporting"],"description":"Rename, move, re-ask or redraw a chart the caller may change. Changing one in a shared space needs `Reports_Manage` as well.","operationId":"updateReportChart","parameters":[{"name":"reportChartId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RchtUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RchtUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Reports","action":"Read"},"description":"Requires the `query` action on `reports` for the supplied runtime context","action":"query","resource":"reports"}}},"/report-charts":{"get":{"tags":["Reporting"],"description":"Return a page of the charts the caller can read, in the order they were saved. `q` matches part of a title. Walk the pages by passing `nextStartingAfter` back as `startingAfter`; `page` and `endingBefore` are refused with 400.","operationId":"queryReportCharts","parameters":[{"name":"q","in":"query","description":"Free-text search. Supplying it engages the search index; omit it to filter only.","required":false,"schema":{"type":"string"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, forward only: the `nextStartingAfter` of the page before.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/RchtColumn"}}},{"name":"reportSpaceId","in":"query","description":"Only the charts saved in this space.","required":false,"schema":{"type":"string"}},{"name":"owner","in":"query","description":"`me` for what the caller saved.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RchtPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Reports","action":"Read"},"description":"Requires the `query` action on `reports` for the supplied runtime context","action":"query","resource":"reports"}},"post":{"tags":["Reporting"],"description":"Save a chart, or a copy of one. Saving in a shared space needs `Reports_Manage` as well.","operationId":"createReportCharts","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RchtCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RchtCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Reports","action":"Read"},"description":"Requires the `query` action on `reports` for the supplied runtime context","action":"query","resource":"reports"}}},"/report-dashboards/{reportDashboardId}":{"get":{"tags":["Reporting"],"description":"Return one dashboard the caller can read, with the tiles it may read. `include=Charts` also returns the charts those tiles show that the caller may read, each as `GET /report-charts/{id}` returns it, in tile order and each once, so a dashboard's charts are read in one request. Any other `include` value is refused with 400.","operationId":"getReportDashboard","parameters":[{"name":"reportDashboardId","in":"path","required":true,"schema":{"type":"string"}},{"name":"include","in":"query","description":"Also return the dashboard's charts: `Charts`.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/RdshInclude"},{"type":"array","items":{"$ref":"#/components/schemas/RdshInclude"}}]}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RdshView","description":"Charts laid out together, with tabs, filters and what clicking a tile does."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Reports","action":"Read"},"description":"Requires the `query` action on `reports` for the supplied runtime context","action":"query","resource":"reports"}},"delete":{"tags":["Reporting"],"description":"Delete a dashboard the caller may change, and every pin of it.","operationId":"deleteReportDashboard","parameters":[{"name":"reportDashboardId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":""},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Reports","action":"Read"},"description":"Requires the `query` action on `reports` for the supplied runtime context","action":"query","resource":"reports"}},"patch":{"tags":["Reporting"],"description":"Rename, move, lay out or set the presentation of a dashboard the caller may change. Changing one in a shared space needs `Reports_Manage` as well.","operationId":"updateReportDashboard","parameters":[{"name":"reportDashboardId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RdshUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RdshUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Reports","action":"Read"},"description":"Requires the `query` action on `reports` for the supplied runtime context","action":"query","resource":"reports"}}},"/report-dashboards":{"get":{"tags":["Reporting"],"description":"Return a page of the dashboards the caller can read, in the order they were saved. `q` matches part of a title. Walk the pages by passing `nextStartingAfter` back as `startingAfter`; `page` and `endingBefore` are refused with 400.","operationId":"queryReportDashboards","parameters":[{"name":"q","in":"query","description":"Free-text search. Supplying it engages the search index; omit it to filter only.","required":false,"schema":{"type":"string"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, forward only: the `nextStartingAfter` of the page before.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/RdshColumn"}}},{"name":"reportSpaceId","in":"query","description":"Only the dashboards saved in this space.","required":false,"schema":{"type":"string"}},{"name":"owner","in":"query","description":"`me` for what the caller saved.","required":false,"schema":{"type":"string"}},{"name":"reportChartId","in":"query","description":"Only the dashboards with a tile showing this chart, as deleting it would leave them.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RdshPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Reports","action":"Read"},"description":"Requires the `query` action on `reports` for the supplied runtime context","action":"query","resource":"reports"}},"post":{"tags":["Reporting"],"description":"Save a dashboard, or a copy of one. Saving in a shared space needs `Reports_Manage` as well.","operationId":"createReportDashboards","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RdshCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RdshCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Reports","action":"Read"},"description":"Requires the `query` action on `reports` for the supplied runtime context","action":"query","resource":"reports"}}},"/report-notebooks/{reportNotebookId}":{"get":{"tags":["Reporting"],"description":"Return one notebook the caller can read.","operationId":"getReportNotebook","parameters":[{"name":"reportNotebookId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RnbkView","description":"Questions and notes in order, each question saved without its answer."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Reports","action":"Read"},"description":"Requires the `query` action on `reports` for the supplied runtime context","action":"query","resource":"reports"}},"delete":{"tags":["Reporting"],"description":"Delete a notebook the caller may change.","operationId":"deleteReportNotebook","parameters":[{"name":"reportNotebookId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":""},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Reports","action":"Read"},"description":"Requires the `query` action on `reports` for the supplied runtime context","action":"query","resource":"reports"}},"patch":{"tags":["Reporting"],"description":"Rename, move or rewrite a notebook the caller may change. Changing one in a shared space needs `Reports_Manage` as well.","operationId":"updateReportNotebook","parameters":[{"name":"reportNotebookId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RnbkUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RnbkUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Reports","action":"Read"},"description":"Requires the `query` action on `reports` for the supplied runtime context","action":"query","resource":"reports"}}},"/report-notebooks":{"get":{"tags":["Reporting"],"description":"Return a page of the notebooks the caller can read, in the order they were saved. `q` matches part of a title. Walk the pages by passing `nextStartingAfter` back as `startingAfter`; `page` and `endingBefore` are refused with 400.","operationId":"queryReportNotebooks","parameters":[{"name":"q","in":"query","description":"Free-text search. Supplying it engages the search index; omit it to filter only.","required":false,"schema":{"type":"string"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, forward only: the `nextStartingAfter` of the page before.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/RnbkColumn"}}},{"name":"reportSpaceId","in":"query","description":"Only the notebooks saved in this space.","required":false,"schema":{"type":"string"}},{"name":"owner","in":"query","description":"`me` for what the caller saved.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RnbkPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Reports","action":"Read"},"description":"Requires the `query` action on `reports` for the supplied runtime context","action":"query","resource":"reports"}},"post":{"tags":["Reporting"],"description":"Save a notebook, or a copy of one. Saving in a shared space needs `Reports_Manage` as well.","operationId":"createReportNotebooks","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RnbkCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RnbkCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Reports","action":"Read"},"description":"Requires the `query` action on `reports` for the supplied runtime context","action":"query","resource":"reports"}}},"/report-pins/{reportPinId}":{"get":{"tags":["Reporting"],"description":"Return one of the caller's pins.","operationId":"getReportPin","parameters":[{"name":"reportPinId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RpinView","description":"A dashboard the caller keeps to hand. Pins are the caller's own, under the tenant it signed in to."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Reports","action":"Read"},"description":"Requires the `query` action on `reports` for the supplied runtime context","action":"query","resource":"reports"}},"delete":{"tags":["Reporting"],"description":"Unpin a dashboard.","operationId":"deleteReportPin","parameters":[{"name":"reportPinId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":""},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Reports","action":"Read"},"description":"Requires the `query` action on `reports` for the supplied runtime context","action":"query","resource":"reports"}},"patch":{"tags":["Reporting"],"description":"Move a pin to another place in the caller's list.","operationId":"updateReportPin","parameters":[{"name":"reportPinId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RpinUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RpinUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Reports","action":"Read"},"description":"Requires the `query` action on `reports` for the supplied runtime context","action":"query","resource":"reports"}}},"/report-pins":{"get":{"tags":["Reporting"],"description":"Return the caller's pins in its order. Walk the pages by passing `nextStartingAfter` back as `startingAfter`; `q`, `page` and `endingBefore` are refused with 400.","operationId":"queryReportPins","parameters":[{"name":"q","in":"query","description":"Free-text search. Supplying it engages the search index; omit it to filter only.","required":false,"schema":{"type":"string"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, forward only: the `nextStartingAfter` of the page before.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/RpinColumn"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RpinPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Reports","action":"Read"},"description":"Requires the `query` action on `reports` for the supplied runtime context","action":"query","resource":"reports"}},"post":{"tags":["Reporting"],"description":"Pin a dashboard the caller can read.","operationId":"createReportPins","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RpinCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RpinCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Reports","action":"Read"},"description":"Requires the `query` action on `reports` for the supplied runtime context","action":"query","resource":"reports"}}},"/report-hidden-dashboards/{reportHiddenDashboardId}":{"get":{"tags":["Reporting"],"description":"Return one of the caller's hidden dashboards.","operationId":"getReportHiddenDashboard","parameters":[{"name":"reportHiddenDashboardId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RhidView","description":"A dashboard the caller has hidden from its own navigation, under the tenant it signed in to. It is hidden from no one else."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Reports","action":"Read"},"description":"Requires the `query` action on `reports` for the supplied runtime context","action":"query","resource":"reports"}},"delete":{"tags":["Reporting"],"description":"Show a hidden dashboard again.","operationId":"deleteReportHiddenDashboard","parameters":[{"name":"reportHiddenDashboardId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":""},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Reports","action":"Read"},"description":"Requires the `query` action on `reports` for the supplied runtime context","action":"query","resource":"reports"}}},"/report-hidden-dashboards":{"get":{"tags":["Reporting"],"description":"Return the dashboards the caller has hidden, oldest first. Walk the pages by passing `nextStartingAfter` back as `startingAfter`; `q`, `page` and `endingBefore` are refused with 400.","operationId":"queryReportHiddenDashboards","parameters":[{"name":"q","in":"query","description":"Free-text search. Supplying it engages the search index; omit it to filter only.","required":false,"schema":{"type":"string"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, forward only: the `nextStartingAfter` of the page before.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/RhidColumn"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RhidPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Reports","action":"Read"},"description":"Requires the `query` action on `reports` for the supplied runtime context","action":"query","resource":"reports"}},"post":{"tags":["Reporting"],"description":"Hide a dashboard the caller can read.","operationId":"createReportHiddenDashboards","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RhidCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RhidCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Reports","action":"Read"},"description":"Requires the `query` action on `reports` for the supplied runtime context","action":"query","resource":"reports"}}},"/report-asks":{"post":{"tags":["Reporting"],"description":"Ask the caller's reporting a question in words. An agent reads the datasets and asks the semantic layer as the caller, then proposes questions, a chart or a dashboard, which nothing saves. Answered as server-sent events: `progress`, then a `proposal` or an `error`, then `done`. Off for a tenant until it is opted in.","operationId":"createReportAsks","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RaskCmd"}}},"required":true},"responses":{"200":{"description":"","headers":{"Cache-Control":{"required":true,"schema":{"type":"string"}},"X-Accel-Buffering":{"required":true,"schema":{"type":"string"}}},"content":{"text/event-stream":{"schema":{"$ref":"#/components/schemas/RaskEvent"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Reports","action":"Read"},"description":"Requires the `query` action on `reports` for the supplied runtime context","action":"query","resource":"reports"}}},"/report-conversations":{"get":{"tags":["Reporting"],"description":"Return the caller's own conversations with Ask, most recently active first. A single Ask is never listed.","operationId":"queryReportConversations","parameters":[{"name":"limit","in":"query","description":"At most this many, 1 to 100; 20 when absent.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"startingAfter","in":"query","description":"The `nextStartingAfter` of the page before.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RconvPage"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Reports","action":"Read"},"description":"Requires the `query` action on `reports` for the supplied runtime context","action":"query","resource":"reports"}},"post":{"tags":["Reporting"],"description":"Start a conversation with Ask with its first message. An agent reads the datasets and asks the semantic layer as the caller, then answers in words, proposes questions, a chart or a dashboard, which nothing saves, or asks a question back. Answered as server-sent events: `message`, `text` and `progress`, then a `proposal` or an `error`, then `done`. The conversation is the caller's alone. Off for a tenant until it is opted in.","operationId":"createReportConversations","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RconvCmd"}}},"required":true},"responses":{"200":{"description":"","headers":{"Cache-Control":{"required":true,"schema":{"type":"string"}},"X-Accel-Buffering":{"required":true,"schema":{"type":"string"}}},"content":{"text/event-stream":{"schema":{"$ref":"#/components/schemas/RconvEvent"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Reports","action":"Read"},"description":"Requires the `query` action on `reports` for the supplied runtime context","action":"query","resource":"reports"}}},"/report-conversations/{reportConversationId}/messages":{"post":{"tags":["Reporting"],"description":"Send a message to one of the caller's conversations, answered with the conversation so far as its context, as server-sent events as the first message is. One message is answered at a time: a message sent while another is answered is refused with 409, and so is one to a conversation that has used all it may.","operationId":"createReportConversationMessages","parameters":[{"name":"reportConversationId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RconvCmd"}}},"required":true},"responses":{"200":{"description":"","headers":{"Cache-Control":{"required":true,"schema":{"type":"string"}},"X-Accel-Buffering":{"required":true,"schema":{"type":"string"}}},"content":{"text/event-stream":{"schema":{"$ref":"#/components/schemas/RconvEvent"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Reports","action":"Read"},"description":"Requires the `query` action on `reports` for the supplied runtime context","action":"query","resource":"reports"}}},"/report-conversations/{reportConversationId}":{"get":{"tags":["Reporting"],"description":"Return one of the caller's conversations with its messages, in order, to reopen it.","operationId":"getReportConversation","parameters":[{"name":"reportConversationId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RconvView"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Reports","action":"Read"},"description":"Requires the `query` action on `reports` for the supplied runtime context","action":"query","resource":"reports"}},"delete":{"tags":["Reporting"],"description":"Delete one of the caller's conversations with its messages. A message being answered is stopped first.","operationId":"deleteReportConversation","parameters":[{"name":"reportConversationId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":""},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Reports","action":"Read"},"description":"Requires the `query` action on `reports` for the supplied runtime context","action":"query","resource":"reports"}}},"/exports":{"get":{"tags":["Reporting"],"description":"Return your exports, newest first, with no links: read one to sign a link to its file.","operationId":"queryExports","parameters":[{"name":"startingAfter","in":"query","description":"Cursor pagination, forward only: the `nextStartingAfter` of the page before.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExptColumn"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExptPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Reports","action":"Read"},"description":"Requires the `query` action on `reports` for the supplied runtime context","action":"query","resource":"reports"}},"post":{"tags":["Reporting"],"description":"Export what a source reads: the file itself when it is small, otherwise an export that writes it.","operationId":"createExports","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExptCmd"}}},"required":true},"responses":{"200":{"description":"The whole file: RFC 4180 CSV in UTF-8, a header line and then a line per row.","headers":{"Content-Disposition":{"description":"`attachment` with the file's name: `filename`, plus `filename*` (RFC 5987) when the name is not printable ASCII.","required":true,"schema":{"type":"string"}}},"content":{"text/csv":{"schema":{"type":"string"}}}},"202":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExptCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Reports","action":"Read"},"description":"Requires the `query` action on `reports` for the supplied runtime context","action":"query","resource":"reports"}}},"/exports/{exportId}":{"get":{"tags":["Reporting"],"description":"Return one of your exports, with a fresh link to its file once it is done.","operationId":"getExport","parameters":[{"name":"exportId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExptView","description":"A CSV export too large to answer at once, written in the background. Read it until it is `Done`, then follow `downloadUrl`. It is yours alone: anyone else asking for it is told it does not exist."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Reports","action":"Read"},"description":"Requires the `query` action on `reports` for the supplied runtime context","action":"query","resource":"reports"}},"delete":{"tags":["Reporting"],"description":"Delete one of your exports once it has finished: its file is removed at once.","operationId":"deleteExport","parameters":[{"name":"exportId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":""},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Reports","action":"Read"},"description":"Requires the `query` action on `reports` for the supplied runtime context","action":"query","resource":"reports"}},"patch":{"tags":["Reporting"],"description":"Cancel one of your exports while it is queued or being written, or retry one that failed or whose file has expired. A cancel answers the export as it now is; a retry answers the new export.","operationId":"updateExport","parameters":[{"name":"exportId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExptUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExptView","description":"A CSV export too large to answer at once, written in the background. Read it until it is `Done`, then follow `downloadUrl`. It is yours alone: anyone else asking for it is told it does not exist."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Reports","action":"Read"},"description":"Requires the `query` action on `reports` for the supplied runtime context","action":"query","resource":"reports"}}},"/export-jobs/{exportJobId}":{"patch":{"tags":["Operations"],"description":"Cancel one export job, or put one that failed on the platform's side back in the queue. Answers the job as it now is.","operationId":"updateExportJob","parameters":[{"name":"exportJobId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExptjobUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExptjobView"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Queues","action":"Update"},"description":"Requires the `update` action on `queues` for the supplied runtime context","action":"update","resource":"queues"}}},"/export-jobs":{"patch":{"tags":["Operations"],"description":"Cancel every queued or running export job of one tenant, or put back in the queue every job that failed on the platform's side since a time. Answers the jobs changed and those left as they were.","operationId":"updateExportJobs","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExptjobsUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExptjobActed"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Queues","action":"Update"},"description":"Requires the `update` action on `queues` for the supplied runtime context","action":"update","resource":"queues"}}},"/files/{fileId}":{"get":{"tags":["Merchants"],"description":"Read one document's details. The merchant is named by `merchantId` or the `Merchant-Id` header, the platform resolves a file within its merchant. Not the bytes.","operationId":"getFile","parameters":[{"name":"fileId","in":"path","required":true,"schema":{"type":"string"}},{"name":"merchantId","in":"query","description":"Whose file this is. Omit it when the `Merchant-Id` header names the merchant.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LfileView"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Merchants","action":"ReadKyb"},"description":"Requires the `query` action on `merchantKyb` for the supplied runtime context","action":"query","resource":"merchantKyb"}}},"/files":{"get":{"tags":["Merchants"],"description":"Return a merchant's KYB documents. The merchant is named by `merchantId` or the `Merchant-Id` header, and the whole set comes back in one page, there are never many. `GET /filter-catalogues/files` lists the filters this caller can use. A cursor continues only the walk that issued it: sent with a different `merchantId`, filters, `q` or `sort`, it is refused with 400.","operationId":"queryFiles","parameters":[{"name":"q","in":"query","description":"Search. Matches a file id or the file name. An id, an email address, a phone number and any value listed as matched exactly match exactly; any other term matches without regard to case from the start of a value (or of any word in it, beside a longer word of the term), or anywhere in it from three characters, every word of it somewhere; a term that matches nothing so is read again with typos tolerated. Closest matches come first unless `sort` is given.","required":false,"schema":{"type":"string","maxLength":100}},{"name":"page","in":"query","description":"Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"endingBefore","in":"query","description":"Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/LfileColumn"}}},{"name":"merchantId","in":"query","description":"Whose files to read. Omit it when the `Merchant-Id` header names the merchant.","required":false,"schema":{"type":"string"}},{"name":"category","in":"query","description":"Only files whose category is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/LfileCategory"},{"type":"array","items":{"$ref":"#/components/schemas/LfileCategory"}}]},"x-filter":{"filter":"category","operator":"In","kind":"Enum"}},{"name":"documentType","in":"query","description":"Only files whose kind of document is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/LfileDocumentType"},{"type":"array","items":{"$ref":"#/components/schemas/LfileDocumentType"}}]},"x-filter":{"filter":"documentType","operator":"In","kind":"Enum"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LfilePage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Merchants","action":"ReadKyb"},"description":"Requires the `query` action on `merchantKyb` for the supplied runtime context","action":"query","resource":"merchantKyb"}},"post":{"tags":["Merchants"],"description":"Upload a KYB document for a merchant. JPEG, PNG or PDF, up to 10MB.","operationId":"createFiles","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/LfileUpload"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LfileUploaded"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Merchants","action":"CreateKyb"},"description":"Requires the `create` action on `merchantKyb` for the supplied runtime context","action":"create","resource":"merchantKyb"}}},"/balances":{"get":{"tags":["Merchants"],"description":"Return a merchant's balances, the platform's ledger position, and what each connected gateway holds. The merchant is named by `merchantId` or the `Merchant-Id` header.","operationId":"queryBalances","parameters":[{"name":"page","in":"query","description":"1-based page number.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/BalColumn"}}},{"name":"merchantId","in":"query","description":"Whose balances to read. Omit it when the `Merchant-Id` header names the merchant.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BalPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Merchants","action":"ReadFinancials"},"description":"Requires the `query` action on `merchantFinancials` for the supplied runtime context","action":"query","resource":"merchantFinancials"}}},"/merchant-invoices/{merchantInvoiceId}":{"get":{"tags":["Settlement"],"description":"Return one invoice, with its lines and billing details.","operationId":"getMerchantInvoice","parameters":[{"name":"merchantInvoiceId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MinvView","description":"What the platform billed a merchant for a period, and what has been paid against it."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Merchants","action":"ReadFinancials"},"description":"Requires the `query` action on `merchantFinancials` for the supplied runtime context","action":"query","resource":"merchantFinancials"}},"patch":{"tags":["Settlement"],"description":"Record an out-of-band payment, resend the invoice by email, or push it through a billing run. Selected by the body's `type`.","operationId":"updateMerchantInvoice","parameters":[{"name":"merchantInvoiceId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MinvUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MinvUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"description":"Required action depends on the request variant","variants":[{"description":"Record an out-of-band payment","schema":"MinvUpdateMarkPaid","actions":[{"grant":{"resource":"Merchants","action":"UpdateFinancials"},"resource":"merchantFinancials","action":"update"}]},{"description":"Resend the invoice by email","schema":"MinvUpdateResendEmail","actions":[{"grant":{"resource":"Merchants","action":"ReadFinancials"},"resource":"merchantFinancials","action":"query"}]},{"description":"Push the invoice through a billing run","schema":"MinvUpdateProcess","actions":[{"grant":{"resource":"Merchants","action":"UpdateFinancials"},"resource":"merchantFinancials","action":"update"}]}]}}},"/merchant-invoices":{"get":{"tags":["Settlement"],"description":"Return a page of invoices. Filter by `invoiceReference` to find the one printed on a paper invoice, or by the two date pairs, issued, or falling due. The filters combine with each other and with `q` by AND. `GET /filter-catalogues/merchant-invoices` lists those this caller can use. A cursor continues only the walk that issued it: sent with different filters, `q` or `sort`, it is refused with 400.","operationId":"queryMerchantInvoices","parameters":[{"name":"q","in":"query","description":"Search. Matches an invoice id, the id of its order, or the narrative. An id, an email address, a phone number and any value listed as matched exactly match exactly; any other term matches without regard to case from the start of a value (or of any word in it, beside a longer word of the term), or anywhere in it from three characters, every word of it somewhere; a term that matches nothing so is read again with typos tolerated. Closest matches come first unless `sort` is given.","required":false,"schema":{"type":"string","maxLength":100}},{"name":"page","in":"query","description":"Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"endingBefore","in":"query","description":"Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"Fields to sort by, comma-delimited, in priority order. Prefix a field with `-` for descending.","required":false,"explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/MinvSort"}}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/MinvColumn"}}},{"name":"merchantInvoiceId","in":"query","description":"Only invoices whose invoice is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"merchantInvoiceId","operator":"In","kind":"Text"}},{"name":"merchantId","in":"query","description":"Filter to one merchant's invoices.","required":false,"schema":{"type":"string"},"x-filter":{"filter":"merchantId","operator":"Equals","kind":"Id"}},{"name":"marketplaceId","in":"query","description":"Filter to one marketplace's merchants.","required":false,"schema":{"type":"string"},"x-filter":{"filter":"marketplaceId","operator":"Equals","kind":"Id"}},{"name":"enterpriseId","in":"query","description":"Filter to one enterprise.","required":false,"schema":{"type":"string"},"x-filter":{"filter":"enterpriseId","operator":"Equals","kind":"Id"}},{"name":"status","in":"query","description":"Only invoices whose status is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/MinvStatus"},{"type":"array","items":{"$ref":"#/components/schemas/MinvStatus"}}]},"x-filter":{"filter":"status","operator":"In","kind":"Enum"}},{"name":"invoiceReference","in":"query","description":"Find an invoice by the reference printed on it. Resolved to the invoice's identifier.","required":false,"schema":{"type":"string"},"x-filter":{"filter":"invoiceReference","operator":"Equals","kind":"Text"}},{"name":"issuedOnFrom","in":"query","description":"Only invoices whose issue day is at or after this ISO-8601 date.","required":false,"schema":{"type":"string","format":"date"},"x-filter":{"filter":"issuedOn","operator":"After","kind":"Date"}},{"name":"issuedOnTo","in":"query","description":"Only invoices whose issue day is at or before this ISO-8601 date.","required":false,"schema":{"type":"string","format":"date"},"x-filter":{"filter":"issuedOn","operator":"Before","kind":"Date"}},{"name":"dueOnFrom","in":"query","description":"Only invoices whose due day is at or after this ISO-8601 date.","required":false,"schema":{"type":"string","format":"date"},"x-filter":{"filter":"dueOn","operator":"After","kind":"Date"}},{"name":"dueOnTo","in":"query","description":"Only invoices whose due day is at or before this ISO-8601 date.","required":false,"schema":{"type":"string","format":"date"},"x-filter":{"filter":"dueOn","operator":"Before","kind":"Date"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MinvPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Merchants","action":"ReadFinancials"},"description":"Requires the `query` action on `merchantFinancials` for the supplied runtime context","action":"query","resource":"merchantFinancials"}},"post":{"tags":["Settlement"],"description":"Raise an invoice over a period for the credential's own merchant. The category decides which of its ledgers is billed.","operationId":"createMerchantInvoices","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MinvCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MinvCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Merchants","action":"CreateFinancials"},"description":"Requires the `create` action on `merchantFinancials` for the supplied runtime context","action":"create","resource":"merchantFinancials"}}},"/settlement-entries":{"get":{"tags":["Settlement"],"description":"Return a page of a merchant's settlement entries. A merchant is required, named by `merchantId`, a `payoutId` or the `Merchant-Id` header, and so is a period: `clearingFrom` and `clearingTo`, or `createdAfter` and `createdBefore`, or a `payoutId` in place of either. The filters combine with each other and with `q` by AND. `GET /filter-catalogues/settlement-entries` lists those this caller can use. A cursor continues only the walk that issued it: sent with different filters, `q` or `sort`, it is refused with 400.","operationId":"querySettlementEntries","parameters":[{"name":"q","in":"query","description":"Search. Matches an entry id, the whole reference or transaction id exactly, or the description. An id, an email address, a phone number and any value listed as matched exactly match exactly; any other term matches without regard to case from the start of a value (or of any word in it, beside a longer word of the term), or anywhere in it from three characters, every word of it somewhere; a term that matches nothing so is read again with typos tolerated. Matches come newest first unless `sort` is given.","required":false,"schema":{"type":"string","maxLength":100}},{"name":"page","in":"query","description":"Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"endingBefore","in":"query","description":"Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"Fields to sort by, comma-delimited, in priority order. Prefix a field with `-` for descending.","required":false,"explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/SettlementEntrySort"}}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/SettlementEntryColumn"}}},{"name":"merchantId","in":"query","description":"Whose settlement to read. Omit it when a `payoutId` or the `Merchant-Id` header names the merchant.","required":false,"schema":{"type":"string"}},{"name":"payoutId","in":"query","description":"Explain one payout: the entries it settled. Supplying this makes the date range optional.","required":false,"schema":{"type":"string"},"x-filter":{"filter":"payoutId","operator":"Equals","kind":"Id"}},{"name":"entryType","in":"query","description":"Only entries whose entry type is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"entryType","operator":"In","kind":"Text"}},{"name":"transactionId","in":"query","description":"Only entries whose transaction is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"transactionId","operator":"In","kind":"Text"}},{"name":"category","in":"query","description":"Only entries whose journal is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/JnalCategory"},{"type":"array","items":{"$ref":"#/components/schemas/JnalCategory"}}]},"x-filter":{"filter":"category","operator":"In","kind":"Enum"}},{"name":"currency","in":"query","description":"Defaults to the merchant's trading currency when omitted.","required":false,"schema":{"$ref":"#/components/schemas/IsoCurrency"},"x-filter":{"filter":"currency","operator":"Equals","kind":"Currency"}},{"name":"amountFrom","in":"query","description":"Only entries whose amount is at least this.","required":false,"schema":{"type":"number"},"x-filter":{"filter":"amount","operator":"AtLeast","kind":"Decimal"}},{"name":"amountTo","in":"query","description":"Only entries whose amount is at most this.","required":false,"schema":{"type":"number"},"x-filter":{"filter":"amount","operator":"AtMost","kind":"Decimal"}},{"name":"clearingFrom","in":"query","description":"Only entries whose clearing day is at or after this ISO-8601 date.","required":false,"schema":{"type":"string","format":"date"},"x-filter":{"filter":"clearing","operator":"After","kind":"Date"}},{"name":"clearingTo","in":"query","description":"Only entries whose clearing day is at or before this ISO-8601 date.","required":false,"schema":{"type":"string","format":"date"},"x-filter":{"filter":"clearing","operator":"Before","kind":"Date"}},{"name":"createdAfter","in":"query","description":"Only entries whose journalling time is at or after this ISO-8601 timestamp.","required":false,"schema":{"type":"string","format":"date-time"},"x-filter":{"filter":"created","operator":"After","kind":"Instant"}},{"name":"createdBefore","in":"query","description":"Only entries whose journalling time is before, and not at, this ISO-8601 timestamp.","required":false,"schema":{"type":"string","format":"date-time"},"x-filter":{"filter":"created","operator":"Before","kind":"Instant"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettlementEntryPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Merchants","action":"ReadFinancials"},"description":"Requires the `query` action on `merchantFinancials` for the supplied runtime context","action":"query","resource":"merchantFinancials"},"x-required-one-of":[["payoutId"],["clearingFrom","clearingTo"],["createdAfter","createdBefore"]]}},"/journal-entries":{"get":{"tags":["Ledgers and journals"],"description":"Return a page of journal entries. Narrow by journal, owner, category, clearance system and currency, and by date. The filters combine with each other and with `q` by AND. `GET /filter-catalogues/journal-entries` lists those this caller can use. A cursor continues only the walk that issued it: sent with different filters, `q` or `sort`, it is refused with 400.","operationId":"queryJournalEntries","parameters":[{"name":"q","in":"query","description":"Search. Matches a journal entry id, the merchant's id, the whole reference or transaction id exactly, or the description. An id, an email address, a phone number and any value listed as matched exactly match exactly; any other term matches without regard to case from the start of a value (or of any word in it, beside a longer word of the term), or anywhere in it from three characters, every word of it somewhere; a term that matches nothing so is read again with typos tolerated. Matches come newest first unless `sort` is given.","required":false,"schema":{"type":"string","maxLength":100}},{"name":"page","in":"query","description":"Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"endingBefore","in":"query","description":"Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"Fields to sort by, comma-delimited, in priority order. Prefix a field with `-` for descending.","required":false,"explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/JnalSort"}}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/JnalColumn"}}},{"name":"ownerType","in":"query","description":"Filter by what kind of party owns the journal.","required":false,"schema":{"$ref":"#/components/schemas/SjnlOwnerType"},"x-filter":{"filter":"ownerType","operator":"Equals","kind":"Enum"}},{"name":"ownerIdentifier","in":"query","description":"Only entries whose owner is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"ownerIdentifier","operator":"In","kind":"Text"}},{"name":"category","in":"query","description":"Only entries whose journal is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/JnalCategory"},{"type":"array","items":{"$ref":"#/components/schemas/JnalCategory"}}]},"x-filter":{"filter":"category","operator":"In","kind":"Enum"}},{"name":"clearanceSystem","in":"query","description":"How the funds clear to the owner.","required":false,"schema":{"type":"string"},"x-filter":{"filter":"clearanceSystem","operator":"Equals","kind":"Text"}},{"name":"currency","in":"query","description":"Filter by the journal's currency.","required":false,"schema":{"$ref":"#/components/schemas/IsoCurrency"},"x-filter":{"filter":"currency","operator":"Equals","kind":"Currency"}},{"name":"merchantId","in":"query","description":"Entries for one merchant.","required":false,"schema":{"type":"string"},"x-filter":{"filter":"merchantId","operator":"Equals","kind":"Id"}},{"name":"marketplaceId","in":"query","description":"Entries for one marketplace.","required":false,"schema":{"type":"string"},"x-filter":{"filter":"marketplaceId","operator":"Equals","kind":"Id"}},{"name":"entryType","in":"query","description":"Only entries whose entry type is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"entryType","operator":"In","kind":"Text"}},{"name":"transactionId","in":"query","description":"Only entries whose transaction is one of these. Repeat the parameter to give several.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-filter":{"filter":"transactionId","operator":"In","kind":"Text"}},{"name":"clearingFrom","in":"query","description":"Only entries whose clearing day is at or after this ISO-8601 date.","required":false,"schema":{"type":"string","format":"date"},"x-filter":{"filter":"clearing","operator":"After","kind":"Date"}},{"name":"clearingTo","in":"query","description":"Only entries whose clearing day is at or before this ISO-8601 date.","required":false,"schema":{"type":"string","format":"date"},"x-filter":{"filter":"clearing","operator":"Before","kind":"Date"}},{"name":"createdAfter","in":"query","description":"Only entries whose journalling time is at or after this ISO-8601 timestamp.","required":false,"schema":{"type":"string","format":"date-time"},"x-filter":{"filter":"created","operator":"After","kind":"Instant"}},{"name":"createdBefore","in":"query","description":"Only entries whose journalling time is before, and not at, this ISO-8601 timestamp.","required":false,"schema":{"type":"string","format":"date-time"},"x-filter":{"filter":"created","operator":"Before","kind":"Instant"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JnalPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"SystemJournalEntries","action":"Read"},"description":"Requires the `query` action on `systemJournalEntries` for the supplied runtime context","action":"query","resource":"systemJournalEntries"}},"post":{"tags":["Ledgers and journals"],"description":"Top up a merchant's book. Writes a balanced pair of entries and answers with the date the funds clear.","operationId":"createJournalEntries","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JnalCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JnalCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"SystemJournalEntries","action":"Create"},"description":"Requires the `create` action on `systemJournalEntries` for the supplied runtime context","action":"create","resource":"systemJournalEntries"}}},"/pay-to-agreements/{payToAgreementId}":{"get":{"tags":["Payment sources"],"description":"Return an agreement's status. The identifier is the token you were given. It is sealed to its merchant, so the merchant is named by `merchantId` or the `Merchant-Id` header.","operationId":"getPayToAgreement","parameters":[{"name":"payToAgreementId","in":"path","required":true,"schema":{"type":"string"}},{"name":"merchantId","in":"query","description":"Whose agreement this is. Omit it when the `Merchant-Id` header names the merchant.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PtagView","description":"A standing authority a payer gives to be debited, addressed by its token."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"PayToAgreements","action":"Read"},"description":"Requires the `query` action on `payToAgreements` for the supplied runtime context","action":"query","resource":"payToAgreements"}}},"/pay-to-agreements":{"post":{"tags":["Payment sources"],"description":"Ask a payer for a standing authority. The response carries the token, it is the only handle you get.","operationId":"createPayToAgreements","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PtagCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PtagCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"PayToAgreements","action":"Create"},"description":"Requires the `create` action on `payToAgreements` for the supplied runtime context","action":"create","resource":"payToAgreements"}}},"/pay-to-aliases":{"post":{"tags":["Payment sources"],"description":"Resolve a PayID to the account name behind it. Nothing is stored, the answer is the lookup.","operationId":"createPayToAliases","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PtalCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PtalCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"PayToAgreements","action":"Read"},"description":"Requires the `query` action on `payToAgreements` for the supplied runtime context","action":"query","resource":"payToAgreements"}}},"/simulations":{"post":{"tags":["Simulations"],"description":"Make the platform act as a card network or issuer would: authorise, clear, refund or dispute a card payment, replay an issuer message, or process the queued ones. Test environments only.","operationId":"createSimulations","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Simulations","action":"Create"},"description":"Requires the `create` action on `simulations` for the supplied runtime context","action":"create","resource":"simulations"}}},"/reports":{"post":{"tags":["Reporting"],"description":"Run a report. The answer is the report, nothing is stored, so keep it. Each report is authorised as the collection it reports on is.","operationId":"createReports","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RprtCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RprtCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"description":"Required action depends on the request variant","variants":[{"description":"Report a merchant's transactions","schema":"RprtCmdTransactions","actions":[{"grant":{"resource":"Transactions","action":"Read"},"resource":"transactions","action":"query"}]},{"description":"Report a merchant's refunds","schema":"RprtCmdRefunds","actions":[{"grant":{"resource":"Refunds","action":"Read"},"resource":"refunds","action":"query"}]},{"description":"Report, and email, one payout","schema":"RprtCmdPayout","actions":[{"grant":{"resource":"Merchants","action":"ReadFinancials"},"resource":"merchantFinancials","action":"query"}]},{"description":"Report a merchant's settlement","schema":"RprtCmdSettlement","actions":[{"grant":{"resource":"Merchants","action":"ReadFinancials"},"resource":"merchantFinancials","action":"query"}]}]}}},"/fee-adjustments":{"post":{"tags":["Settlement"],"description":"Recalculate platform fees over a window, as a dry run or for real. The response is the only record of the run.","operationId":"createFeeAdjustments","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeeadjCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeeadjCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Transactions","action":"Update"},"description":"Requires the `update` action on `transactions` for the supplied runtime context","action":"update","resource":"transactions"}}},"/external-accounts":{"get":{"tags":["Merchants"],"description":"Return a merchant's external accounts. The merchant is named by `merchantId` or the `Merchant-Id` header. There are never many, so the whole set comes back in one page.","operationId":"queryExternalAccounts","parameters":[{"name":"q","in":"query","description":"Search. Matches an external account id, the reference account id, the bank or account name, or the last four digits of the account number exactly. An id, an email address, a phone number and any value listed as matched exactly match exactly; any other term matches without regard to case from the start of a value (or of any word in it, beside a longer word of the term), or anywhere in it from three characters, every word of it somewhere; a term that matches nothing so is read again with typos tolerated. Matches come oldest first.","required":false,"schema":{"type":"string","maxLength":100}},{"name":"page","in":"query","description":"Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"startingAfter","in":"query","description":"Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"endingBefore","in":"query","description":"Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with `page`.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/XaccColumn"}}},{"name":"merchantId","in":"query","description":"Whose accounts to read. Omit it when the `Merchant-Id` header names the merchant.","required":false,"schema":{"type":"string"}},{"name":"currency","in":"query","description":"Filter to accounts paid out in one currency.","required":false,"schema":{"$ref":"#/components/schemas/IsoCurrency"}},{"name":"status","in":"query","description":"Filter by status. Repeat the parameter to supply several.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/XaccStatus"},{"type":"array","items":{"$ref":"#/components/schemas/XaccStatus"}}]}},{"name":"primary","in":"query","description":"Filter to the account payouts actually go to.","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XaccPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Merchants","action":"ReadFinancials"},"description":"Requires the `query` action on `merchantFinancials` for the supplied runtime context","action":"query","resource":"merchantFinancials"}},"post":{"tags":["Merchants"],"description":"Add a bank account the merchant can be paid out to.","operationId":"createExternalAccounts","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XaccCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XaccCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Merchants","action":"CreateFinancials"},"description":"Requires the `create` action on `merchantFinancials` for the supplied runtime context","action":"create","resource":"merchantFinancials"}}},"/external-accounts/{externalAccountId}":{"patch":{"tags":["Merchants"],"description":"Make an account primary for its currency, ask the bank to verify it, or remove it. Every arm names the merchant, because the platform cannot resolve one from the account.","operationId":"updateExternalAccount","parameters":[{"name":"externalAccountId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XaccUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XaccUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"Merchants","action":"UpdateFinancials"},"description":"Requires the `update` action on `merchantFinancials` for the supplied runtime context","action":"update","resource":"merchantFinancials"}}},"/fx-conversions":{"post":{"tags":["FX rates"],"description":"Convert an amount at an enterprise's rates. The answer is the conversion, nothing is stored.","operationId":"createFxConversions","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FxconvCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FxconvCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"FxRates","action":"Read"},"description":"Requires the `query` action on `fxRates` for the supplied runtime context","action":"query","resource":"fxRates"}}},"/apg-numbers":{"get":{"tags":["Reference data"],"description":"Return the identifiers of the records that APG numbers name, or the APG numbers that records hold, for one `kind`. A number or record that has no counterpart is left out.","operationId":"queryApgNumbers","parameters":[{"name":"page","in":"query","description":"1-based page number.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApgnumColumn"}}},{"name":"kind","in":"query","description":"What the numbers number, or what the ids identify. Required.","required":true,"schema":{"$ref":"#/components/schemas/ApgnumKind"}},{"name":"number","in":"query","description":"The APG numbers to look up, one or up to 100 by repeating the parameter. A number that names no record is left out of the answer. Give this or `id`, not both.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"integer","format":"int64"}},{"type":"integer","format":"int64"}]}},{"name":"id","in":"query","description":"The identifiers, on this API, of records of the `kind`, one or up to 100 by repeating the parameter, whose APG numbers to look up. A record with no APG number is left out of the answer. Give this or `number`, not both.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApgnumPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"MerchantTravelData","action":"Read"},"description":"Requires the `query` action on `merchantTravelData` for the supplied runtime context","action":"query","resource":"merchantTravelData"}}},"/travel-uploads":{"get":{"tags":["Merchants"],"description":"Return a page of a merchant's uploads, newest first unless `sort` says otherwise. Name the merchant with `merchantId` or the `Merchant-Id` header. Query with `fileName` to find out whether a file has already been uploaded.","operationId":"queryTravelUploads","parameters":[{"name":"page","in":"query","description":"1-based page number.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"Fields to sort by, comma-delimited, in priority order. Prefix a field with `-` for descending.","required":false,"explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/TvluplSort"}}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/TvluplColumn"}}},{"name":"merchantId","in":"query","description":"Whose uploads to read. Omit it when the `Merchant-Id` header names the merchant.","required":false,"schema":{"type":"string"}},{"name":"fileName","in":"query","description":"Uploads whose file name contains this text.","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Narrow to uploads in this state.","required":false,"schema":{"$ref":"#/components/schemas/TvluplStatus"}},{"name":"createdFrom","in":"query","description":"Uploads recorded at or after this instant.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"createdTo","in":"query","description":"Uploads recorded at or before this instant.","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TvluplPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"MerchantTravelData","action":"Read"},"description":"Requires the `query` action on `merchantTravelData` for the supplied runtime context","action":"query","resource":"merchantTravelData"}},"post":{"tags":["Merchants"],"description":"Record that a file is being uploaded. Answers with the upload, in status `Uploading`.","operationId":"createTravelUploads","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TvluplCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TvluplCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"MerchantTravelData","action":"Create"},"description":"Requires the `create` action on `merchantTravelData` for the supplied runtime context","action":"create","resource":"merchantTravelData"}}},"/travel-uploads/{travelUploadId}":{"patch":{"tags":["Merchants"],"description":"Settle an upload as `Uploaded` or `Failed`.","operationId":"updateTravelUpload","parameters":[{"name":"travelUploadId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TvluplUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TvluplUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"MerchantTravelData","action":"Update"},"description":"Requires the `update` action on `merchantTravelData` for the supplied runtime context","action":"update","resource":"merchantTravelData"}}},"/travel-batches":{"get":{"tags":["Merchants"],"description":"Return a page of the batches across a merchant's travel files, the newest file first unless `sort` says otherwise. Name whose batches with `merchantId`, `ownerMerchantId` or `travelFileId`, or the `Merchant-Id` header.","operationId":"queryTravelBatches","parameters":[{"name":"page","in":"query","description":"1-based page number.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"Fields to sort by, comma-delimited, in priority order. Prefix a field with `-` for descending.","required":false,"explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/TvlbatSort"}}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/TvlbatColumn"}}},{"name":"merchantId","in":"query","description":"The merchant that uploaded the files. Omit it when the `Merchant-Id` header names the merchant, or when `ownerMerchantId` or `travelFileId` says whose batches to read.","required":false,"schema":{"type":"string"}},{"name":"ownerMerchantId","in":"query","description":"Only the batches whose entries belong to this merchant, in files any merchant uploaded.","required":false,"schema":{"type":"string"}},{"name":"travelFileId","in":"query","description":"Only the batches of this file.","required":false,"schema":{"type":"string"}},{"name":"createdFrom","in":"query","description":"Batches whose file was received at or after this instant.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"createdTo","in":"query","description":"Batches whose file was received at or before this instant.","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TvlbatPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"MerchantTravelData","action":"Read"},"description":"Requires the `query` action on `merchantTravelData` for the supplied runtime context","action":"query","resource":"merchantTravelData"}}},"/travel-files/{travelFileId}":{"get":{"tags":["Merchants"],"description":"Return one travel file.","operationId":"getTravelFile","parameters":[{"name":"travelFileId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TvlfileView"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"MerchantTravelData","action":"Read"},"description":"Requires the `query` action on `merchantTravelData` for the supplied runtime context","action":"query","resource":"merchantTravelData"}}},"/travel-files":{"get":{"tags":["Merchants"],"description":"Return a page of a merchant's travel files, newest first unless `sort` says otherwise. Name the merchant with `merchantId` or the `Merchant-Id` header.","operationId":"queryTravelFiles","parameters":[{"name":"page","in":"query","description":"1-based page number.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"Fields to sort by, comma-delimited, in priority order. Prefix a field with `-` for descending.","required":false,"explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/TvlfileSort"}}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/TvlfileColumn"}}},{"name":"merchantId","in":"query","description":"Whose files to read. Omit it when the `Merchant-Id` header names the merchant.","required":false,"schema":{"type":"string"}},{"name":"name","in":"query","description":"Files whose name contains this text.","required":false,"schema":{"type":"string"}},{"name":"fileType","in":"query","description":"Narrow to one kind of file.","required":false,"schema":{"$ref":"#/components/schemas/TvlfileType"}},{"name":"parseStatus","in":"query","description":"Narrow to files at this stage of parsing.","required":false,"schema":{"$ref":"#/components/schemas/TvlfileParseStatus"}},{"name":"dealStatus","in":"query","description":"Narrow to files at this stage of processing.","required":false,"schema":{"$ref":"#/components/schemas/TvlfileDealStatus"}},{"name":"validation","in":"query","description":"Narrow to files that passed or failed their checks.","required":false,"schema":{"$ref":"#/components/schemas/TvlfileValidation"}},{"name":"createdFrom","in":"query","description":"Files received at or after this instant.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"createdTo","in":"query","description":"Files received at or before this instant.","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TvlfilePage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"MerchantTravelData","action":"Read"},"description":"Requires the `query` action on `merchantTravelData` for the supplied runtime context","action":"query","resource":"merchantTravelData"}}},"/travel-files/{travelFileId}/batches":{"get":{"tags":["Merchants"],"description":"Return the batches of this file, in file order. A file has few, so they page by `page` only.","operationId":"queryTravelFileBatches","parameters":[{"name":"travelFileId","in":"path","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"1-based page number.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TvlfileBatchPage"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"MerchantTravelData","action":"Read"},"description":"Requires the `query` action on `merchantTravelData` for the supplied runtime context","action":"query","resource":"merchantTravelData"}}},"/travel-files/{travelFileId}/batches/{batchId}":{"get":{"tags":["Merchants"],"description":"Return one batch of this file. A batch that does not belong to this travelFile is a 404, not a redirect.","operationId":"getTravelFileBatch","parameters":[{"name":"travelFileId","in":"path","required":true,"schema":{"type":"string"}},{"name":"batchId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TvlfileBatch"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"MerchantTravelData","action":"Read"},"description":"Requires the `query` action on `merchantTravelData` for the supplied runtime context","action":"query","resource":"merchantTravelData"}}},"/travel-files/{travelFileId}/errors":{"get":{"tags":["Merchants"],"description":"Return the records of this file that failed their checks, each with the codes it raised. The line a record failed on is never published.","operationId":"queryTravelFileErrors","parameters":[{"name":"travelFileId","in":"path","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"1-based page number.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TvlfileErrorPage"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"MerchantTravelData","action":"Read"},"description":"Requires the `query` action on `merchantTravelData` for the supplied runtime context","action":"query","resource":"merchantTravelData"}}},"/travel-files/{travelFileId}/missing-dbi-workbooks/{layout}":{"get":{"tags":["Merchants"],"description":"Return the workbook of the entries of this file whose data-based invoicing check failed, as the file itself: `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`.\n`Content-Disposition` names the file; the name is stated here too, because generated clients drop headers.\n\nThe entries are those whose data-based invoicing check failed in the last 14 days. `layout` is `Merchant`, the portal's columns,\nauthorised at the merchant the entries belong to, or `Admin`, the back office's, which shows other merchants' details and is\nplatform staff's. None to export is a `404`. The card is never a filter.","operationId":"getTravelFileMissingDbiWorkbook","parameters":[{"name":"travelFileId","in":"path","required":true,"schema":{"type":"string"}},{"name":"layout","in":"path","description":"Which columns the workbook carries.","required":true,"schema":{"$ref":"#/components/schemas/TvldbiwLayout"}},{"name":"documentNumber","in":"query","description":"Entries whose document number contains this text.","required":false,"schema":{"type":"string"}},{"name":"invoiceNumber","in":"query","description":"Entries whose invoice number contains this text.","required":false,"schema":{"type":"string"}},{"name":"fileType","in":"query","description":"Narrow to one kind of file.","required":false,"schema":{"$ref":"#/components/schemas/TvlfileType"}},{"name":"timezone","in":"query","description":"The IANA timezone the expiry column is written in, `Australia/Sydney`. Without it, UTC.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{"Content-Disposition":{"description":"`attachment` with the file's name: `filename`, plus `filename*` (RFC 5987) when the name is not printable ASCII.","required":true,"schema":{"type":"string"}}},"content":{"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"MerchantTravelData","action":"Read"},"description":"Requires the `query` action on `merchantTravelData` for the supplied runtime context","action":"query","resource":"merchantTravelData"}}},"/travel-entries/{travelEntryId}":{"get":{"tags":["Merchants"],"description":"Return one travel entry, with its service lines.","operationId":"getTravelEntry","parameters":[{"name":"travelEntryId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TvlentView","description":"One transaction line of a travel file: what was bought, its amounts, the references the data-based invoicing check reads, where authorising and matching it to a payment have got to, and what it paid for. The card is not published, only whether the line carries one."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"MerchantTravelData","action":"Read"},"description":"Requires the `query` action on `merchantTravelData` for the supplied runtime context","action":"query","resource":"merchantTravelData"}},"patch":{"tags":["Merchants"],"description":"Correct the entry, match it to its payment now, set how much of it has been refunded, say which purchase a refund refunds, or record by hand how it matched. The last three are staff's.","operationId":"updateTravelEntry","parameters":[{"name":"travelEntryId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TvlentUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TvlentUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"MerchantTravelData","action":"Update"},"description":"Requires the `update` action on `merchantTravelData` for the supplied runtime context","action":"update","resource":"merchantTravelData"}}},"/travel-entries":{"get":{"tags":["Merchants"],"description":"Return a page of travel entries, newest first unless `sort` says otherwise. Name the owner with `merchantId` or the `Merchant-Id` header, or the merchant their files were uploaded for with `uploadedForMerchantId`; naming neither is a 400. To check that entries belong to a merchant before changing them, query them and read `ownerMerchantId`. Entries a later file replaced are left out unless `includeSuperseded` is true. Text filters match any entry that contains the text, and case matters.","operationId":"queryTravelEntries","parameters":[{"name":"page","in":"query","description":"1-based page number.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"Fields to sort by, comma-delimited, in priority order. Prefix a field with `-` for descending.","required":false,"explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/TvlentSort"}}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/TvlentColumn"}}},{"name":"merchantId","in":"query","description":"Whose entries to read. Omit it when the `Merchant-Id` header names the merchant, or when `uploadedForMerchantId` is given instead.","required":false,"schema":{"type":"string"}},{"name":"travelFileId","in":"query","description":"Entries from this file.","required":false,"schema":{"type":"string"}},{"name":"fileType","in":"query","description":"Narrow to one kind of file.","required":false,"schema":{"$ref":"#/components/schemas/TvlfileType"}},{"name":"documentNumber","in":"query","description":"Entries whose document number contains this text.","required":false,"schema":{"type":"string"}},{"name":"matchStatus","in":"query","description":"Narrow to entries at this stage of matching.","required":false,"schema":{"$ref":"#/components/schemas/TvlentMatchStatus"}},{"name":"dbiStatus","in":"query","description":"Narrow to entries at this stage of the data-based invoicing check.","required":false,"schema":{"$ref":"#/components/schemas/TvlentDbiStatus"}},{"name":"validation","in":"query","description":"Narrow to entries that passed or failed their checks.","required":false,"schema":{"$ref":"#/components/schemas/TvlfileValidation"}},{"name":"createdFrom","in":"query","description":"Entries received at or after this instant.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"createdTo","in":"query","description":"Entries received at or before this instant.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"uploadedForMerchantId","in":"query","description":"Entries from files uploaded for this merchant, which for a distributor's file is not the merchant the entries belong to. Given without `merchantId`, it lists them whoever owns them, for staff; any other caller sees only the entries it also owns.","required":false,"schema":{"type":"string"}},{"name":"includeSuperseded","in":"query","description":"List the entries a later file replaced as well as the live ones.","required":false,"schema":{"type":"boolean"}},{"name":"authorisationStatus","in":"query","description":"Narrow to entries whose authorisation is at this stage.","required":false,"schema":{"$ref":"#/components/schemas/TvlentAuthStatus"}},{"name":"authorisationRefundStatus","in":"query","description":"Narrow to entries whose authorisation refund is at this stage.","required":false,"schema":{"$ref":"#/components/schemas/TvlentAuthStatus"}},{"name":"matchTimedOut","in":"query","description":"Narrow to entries whose matching has, or has not, given up waiting for the payment.","required":false,"schema":{"type":"boolean"}},{"name":"travelBatchId","in":"query","description":"Entries from this batch of a file.","required":false,"schema":{"type":"string"}},{"name":"agencyDeliveryNoteNumber","in":"query","description":"Entries whose agency delivery note number contains this text. Case matters.","required":false,"schema":{"type":"string"}},{"name":"travellerName","in":"query","description":"Entries whose traveller's name contains this text. Case matters.","required":false,"schema":{"type":"string"}},{"name":"transactionId","in":"query","description":"Entries matched to this payment.","required":false,"schema":{"type":"string"}},{"name":"issuerTransactionId","in":"query","description":"Entries matched to this card transaction.","required":false,"schema":{"type":"string"}},{"name":"refundId","in":"query","description":"Entries matched to this refund.","required":false,"schema":{"type":"string"}},{"name":"issuerRefundId","in":"query","description":"Entries matched to this card refund.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TvlentPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"MerchantTravelData","action":"Read"},"description":"Requires the `query` action on `merchantTravelData` for the supplied runtime context","action":"query","resource":"merchantTravelData"}}},"/travel-entries/{travelEntryId}/errors":{"get":{"tags":["Merchants"],"description":"Return the records that failed on this entry, each with the codes it raised.","operationId":"queryTravelEntryErrors","parameters":[{"name":"travelEntryId","in":"path","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"1-based page number.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TvlfileErrorPage"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"MerchantTravelData","action":"Read"},"description":"Requires the `query` action on `merchantTravelData` for the supplied runtime context","action":"query","resource":"merchantTravelData"}}},"/travel-entries/{travelEntryId}/refund-candidates":{"get":{"tags":["Merchants"],"description":"Return the purchases this refund may be a refund of, oldest first, for the staff who relink it with `TvlentUpdateRelinkOriginal`. They are found on the refund's own card, which is never published, and are the owner's matched purchases of the refund's kind of file and processing page with at least the refund's amount still unrefunded. `matchOn` adds the references they must share with it. Only a refund has candidates.","operationId":"queryTravelEntryRefundCandidates","parameters":[{"name":"travelEntryId","in":"path","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"1-based page number.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"matchOn","in":"query","description":"What else a purchase must share with the refund. Repeat the parameter to require several. A purchase is always on the refund's card, owner, kind of file and processing page, with at least the refund's amount unrefunded.","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/TvlentRefundMatchField"},{"type":"array","items":{"$ref":"#/components/schemas/TvlentRefundMatchField"}}]}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TvlentRefundCandidatePage"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"MerchantTravelData","action":"Update"},"description":"Requires the `update` action on `merchantTravelData` for the supplied runtime context","action":"update","resource":"merchantTravelData"}}},"/merchant-travel-settings/{merchantTravelSettingId}":{"get":{"tags":["Merchants"],"description":"Return a merchant's travel settings.","operationId":"getMerchantTravelSetting","parameters":[{"name":"merchantTravelSettingId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TvlsetView","description":"A merchant's travel (Galaxy) settings: the file versions it may send, how its dates are postponed, its reminders to send files, and who gets its quality-check reports. The merchant's own contact and trading details are the merchant's, at `/merchants/{merchantId}`."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"MerchantTravelData","action":"Read"},"description":"Requires the `query` action on `merchantTravelData` for the supplied runtime context","action":"query","resource":"merchantTravelData"}},"patch":{"tags":["Merchants"],"description":"Replace what the merchant may change on its travel settings.","operationId":"updateMerchantTravelSetting","parameters":[{"name":"merchantTravelSettingId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TvlsetUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TvlsetUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"MerchantTravelData","action":"Update"},"description":"Requires the `update` action on `merchantTravelData` for the supplied runtime context","action":"update","resource":"merchantTravelData"}}},"/merchant-travel-settings/{merchantTravelSettingId}/missing-dbi-workbooks/{layout}":{"get":{"tags":["Merchants"],"description":"Return the workbook of the entries of this merchant whose data-based invoicing check failed, read at the merchant's own settings, as the file itself: `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`.\n`Content-Disposition` names the file; the name is stated here too, because generated clients drop headers.\n\nThe entries are those whose data-based invoicing check failed in the last 14 days. `layout` is `Merchant`, the portal's columns,\nauthorised at the merchant the entries belong to, or `Admin`, the back office's, which shows other merchants' details and is\nplatform staff's. None to export is a `404`. The card is never a filter.","operationId":"getMerchantTravelSettingMissingDbiWorkbook","parameters":[{"name":"merchantTravelSettingId","in":"path","required":true,"schema":{"type":"string"}},{"name":"layout","in":"path","description":"Which columns the workbook carries.","required":true,"schema":{"$ref":"#/components/schemas/TvldbiwLayout"}},{"name":"documentNumber","in":"query","description":"Entries whose document number contains this text.","required":false,"schema":{"type":"string"}},{"name":"invoiceNumber","in":"query","description":"Entries whose invoice number contains this text.","required":false,"schema":{"type":"string"}},{"name":"fileType","in":"query","description":"Narrow to one kind of file.","required":false,"schema":{"$ref":"#/components/schemas/TvlfileType"}},{"name":"timezone","in":"query","description":"The IANA timezone the expiry column is written in, `Australia/Sydney`. Without it, UTC.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{"Content-Disposition":{"description":"`attachment` with the file's name: `filename`, plus `filename*` (RFC 5987) when the name is not printable ASCII.","required":true,"schema":{"type":"string"}}},"content":{"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"MerchantTravelData","action":"Read"},"description":"Requires the `query` action on `merchantTravelData` for the supplied runtime context","action":"query","resource":"merchantTravelData"}}},"/merchant-statement-passwords/{merchantStatementPasswordId}":{"get":{"tags":["Merchants"],"description":"Reveal the merchant's statement password. Audited: the read is recorded with who made it.","operationId":"getMerchantStatementPassword","parameters":[{"name":"merchantStatementPasswordId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MspwView","description":"The password the merchant's payout statement files are sealed with. Reading it is an audited reveal: it is recorded who asked, and the password reaches no log. Staff only."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"MerchantStatementPasswords","action":"Update"},"description":"Requires the `update` action on `merchantStatementPasswords` for the supplied runtime context","action":"update","resource":"merchantStatementPasswords"}},"patch":{"tags":["Merchants"],"description":"Replace the merchant's statement password with a newly generated one. Audited. The answer does not carry the new password: read it, which is audited as a reveal.","operationId":"updateMerchantStatementPassword","parameters":[{"name":"merchantStatementPasswordId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MspwUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MspwUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"MerchantStatementPasswords","action":"Update"},"description":"Requires the `update` action on `merchantStatementPasswords` for the supplied runtime context","action":"update","resource":"merchantStatementPasswords"}}},"/statement-receipts":{"get":{"tags":["Loans"],"description":"Return the receipts recorded against a statement, oldest first. A statement has few, so they page by `page` only.","operationId":"queryStatementReceipts","parameters":[{"name":"page","in":"query","description":"1-based page number.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/SrcptColumn"}}},{"name":"loanStatementId","in":"query","description":"The statement whose receipts to read. Required.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SrcptPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"LoanStatements","action":"Read"},"description":"Requires the `query` action on `loanStatements` for the supplied runtime context","action":"query","resource":"loanStatements"}},"post":{"tags":["Loans"],"description":"Record a payment received against a statement and apply it. A `requestReference` already recorded answers with what it holds.","operationId":"createStatementReceipts","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SrcptCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SrcptCreateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"LoanStatements","action":"Update"},"description":"Requires the `update` action on `loanStatements` for the supplied runtime context","action":"update","resource":"loanStatements"}}},"/statement-receipt-batches/{statementReceiptBatchId}":{"get":{"tags":["Loans"],"description":"Return one batch with its receipts.","operationId":"getStatementReceiptBatch","parameters":[{"name":"statementReceiptBatchId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SrbatView","description":"A bank direct-entry batch of receipts: the file sent to the bank, and the bank's answer. The accounts it moves money between are not published."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"LoanStatements","action":"Read"},"description":"Requires the `query` action on `loanStatements` for the supplied runtime context","action":"query","resource":"loanStatements"}},"patch":{"tags":["Loans"],"description":"Settle a batch the bank has accepted: its receipts are marked received and each is applied to its statement.","operationId":"updateStatementReceiptBatch","parameters":[{"name":"statementReceiptBatchId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SrbatUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SrbatUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"LoanStatements","action":"Update"},"description":"Requires the `update` action on `loanStatements` for the supplied runtime context","action":"update","resource":"loanStatements"}}},"/statement-receipt-batches":{"get":{"tags":["Loans"],"description":"Return a page of batches, newest first unless `sort` says otherwise. Staff only: a batch can span any merchant's statements.","operationId":"queryStatementReceiptBatches","parameters":[{"name":"page","in":"query","description":"1-based page number.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"Fields to sort by, comma-delimited, in priority order. Prefix a field with `-` for descending.","required":false,"explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/SrbatSort"}}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/SrbatColumn"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SrbatPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"LoanStatements","action":"Read"},"description":"Requires the `query` action on `loanStatements` for the supplied runtime context","action":"query","resource":"loanStatements"}}},"/daily-card-file-runs":{"get":{"tags":["Loans"],"description":"Return a customer's daily card file runs for a day, withdrawn ones included. A day has few, so they page by `page` only.","operationId":"queryDailyCardFileRuns","parameters":[{"name":"page","in":"query","description":"1-based page number.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/DcfrColumn"}}},{"name":"customerId","in":"query","description":"Whose runs to read. Required.","required":true,"schema":{"type":"string"}},{"name":"day","in":"query","description":"The day the files cover, as a date. Required.","required":true,"schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DcfrPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"LoanStatements","action":"Read"},"description":"Requires the `query` action on `loanStatements` for the supplied runtime context","action":"query","resource":"loanStatements"}}},"/daily-card-file-runs/{dailyCardFileRunId}/files/{format}":{"get":{"tags":["Loans"],"description":"Return the file generated for the run, as the file itself: `application/xml`. `Content-Disposition` names the file; the name\nis stated here too, because generated clients drop headers. A run whose file has not been generated yet is a `404`.","operationId":"getDailyCardFileRunFile","parameters":[{"name":"dailyCardFileRunId","in":"path","required":true,"schema":{"type":"string"}},{"name":"format","in":"path","description":"Which layout of the daily file.","required":true,"schema":{"$ref":"#/components/schemas/DcfrFormat"}}],"responses":{"200":{"description":"","headers":{"Content-Disposition":{"description":"`attachment` with the file's name: `filename`, plus `filename*` (RFC 5987) when the name is not printable ASCII.","required":true,"schema":{"type":"string"}}},"content":{"application/xml":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"LoanStatements","action":"Read"},"description":"Requires the `query` action on `loanStatements` for the supplied runtime context","action":"query","resource":"loanStatements"}}},"/loan-statement-lines":{"get":{"tags":["Loans"],"description":"Return the lines of loan statements that a search names. Platform staff only. Lines page by `page`.","operationId":"queryLoanStatementLines","parameters":[{"name":"page","in":"query","description":"1-based page number.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/SlinColumn"}}},{"name":"loanStatementId","in":"query","description":"Lines of this statement, or of any of these, up to 100 by repeating the parameter.","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]}},{"name":"customerId","in":"query","description":"Lines of this customer's statements.","required":false,"schema":{"type":"string"}},{"name":"loanId","in":"query","description":"Lines of this loan's statements.","required":false,"schema":{"type":"string"}},{"name":"createdFrom","in":"query","description":"Lines of statements made at or after this instant.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"createdTo","in":"query","description":"Lines of statements made at or before this instant.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"amountFrom","in":"query","description":"Lines of at least this amount, in minor units of the statement's currency. A refund's amount is negative.","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"amountTo","in":"query","description":"Lines of at most this amount, in minor units of the statement's currency. A refund's amount is negative.","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"ticketNumber","in":"query","description":"Lines whose ticket number contains this text. Case matters.","required":false,"schema":{"type":"string"}},{"name":"travellerName","in":"query","description":"Lines whose traveller's name contains this text. Case matters.","required":false,"schema":{"type":"string"}},{"name":"dbiField","in":"query","description":"Which data-based invoicing reference `dbiValue` is of. Give it with `dbiValue`.","required":false,"schema":{"$ref":"#/components/schemas/SlinDbiField"}},{"name":"dbiValue","in":"query","description":"Lines whose `dbiField` reference is exactly this. Give it with `dbiField`.","required":false,"schema":{"type":"string"}},{"name":"issuerTransactionId","in":"query","description":"Lines of this card transaction, a whole identifier.","required":false,"schema":{"type":"string"}},{"name":"transactionId","in":"query","description":"Lines of the card transactions linked to this one, a whole identifier.","required":false,"schema":{"type":"string"}},{"name":"galaxyTransactionId","in":"query","description":"Lines whose Galaxy transaction reference is exactly this.","required":false,"schema":{"type":"string"}},{"name":"financialTransactionId","in":"query","description":"Lines whose financial transaction identifier is exactly this.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SlinPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"LoanStatements","action":"Read"},"description":"Requires the `query` action on `loanStatements` for the supplied runtime context","action":"query","resource":"loanStatements"}}},"/travel-dbi-corrections":{"get":{"tags":["Merchants"],"description":"Return the corrections staged for a merchant's entries and not yet applied. Name the merchant with `merchantId` or the `Merchant-Id` header. A merchant has few, so they page by `page` only.","operationId":"queryTravelDbiCorrections","parameters":[{"name":"page","in":"query","description":"1-based page number.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Maximum items per page.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"columns","in":"query","description":"Columns to include, in order, when asking for `text/csv`. Omit for all of them. Sending it with `application/json` is a 400.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/TvldbicColumn"}}},{"name":"merchantId","in":"query","description":"Whose staged corrections to read. Omit it when the `Merchant-Id` header names the merchant.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TvldbicPage"}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"MerchantTravelData","action":"Read"},"description":"Requires the `query` action on `merchantTravelData` for the supplied runtime context","action":"query","resource":"merchantTravelData"}},"post":{"tags":["Merchants"],"description":"Correct the references of one or more entries and apply them. Answers with what was staged, refused and skipped, and what applying did.","operationId":"createTravelDbiCorrections","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TvldbicCmd"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TvldbicResult"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"MerchantTravelData","action":"Update"},"description":"Requires the `update` action on `merchantTravelData` for the supplied runtime context","action":"update","resource":"merchantTravelData"}}},"/statement-dbi-batches/{statementDbiBatchId}":{"get":{"tags":["Loans"],"description":"Return what is staged for the statement, an empty batch when nothing is.","operationId":"getStatementDbiBatch","parameters":[{"name":"statementDbiBatchId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SdbiView","description":"The corrections staged against a statement's transactions, until they are applied and the statement's documents are made again. A statement with nothing staged reads as an empty batch."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"LoanStatements","action":"Read"},"description":"Requires the `query` action on `loanStatements` for the supplied runtime context","action":"query","resource":"loanStatements"}},"put":{"tags":["Loans"],"description":"Stage the references of the statement's transactions, replacing anything already staged.","operationId":"replaceStatementDbiBatch","parameters":[{"name":"statementDbiBatchId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SdbiReplace"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SdbiView","description":"The corrections staged against a statement's transactions, until they are applied and the statement's documents are made again. A statement with nothing staged reads as an empty batch."}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"LoanStatements","action":"Update"},"description":"Requires the `update` action on `loanStatements` for the supplied runtime context","action":"update","resource":"loanStatements"}},"patch":{"tags":["Loans"],"description":"Add references to what is staged, or apply the batch and have the statement's documents made again.","operationId":"updateStatementDbiBatch","parameters":[{"name":"statementDbiBatchId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SdbiUpdate"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SdbiUpdateRsp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":[]}],"x-required-action":{"grant":{"resource":"LoanStatements","action":"Update"},"description":"Requires the `update` action on `loanStatements` for the supplied runtime context","action":"update","resource":"loanStatements"}}},"/oidc/.well-known/openid-configuration":{"get":{"tags":["Identity"],"description":"OpenID Connect discovery document advertising this provider's endpoints and capabilities.","operationId":"oidcDiscovery","responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OidcDiscovery"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/oidc/oauth2/jwks":{"get":{"tags":["Identity"],"description":"Public keys relying parties use to verify id_token signatures. Published with an overlap during rotation.","operationId":"oidcJwks","responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OidcJwks"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/oidc/oauth2/authorise":{"get":{"tags":["Identity"],"description":"Begin an authorisation-code flow with PKCE. Answers with a redirect carrying the code.","operationId":"oidcAuthorise","parameters":[{"name":"response_type","in":"query","required":true,"schema":{"type":"string"}},{"name":"client_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"redirect_uri","in":"query","required":true,"schema":{"type":"string"}},{"name":"scope","in":"query","required":false,"schema":{"type":"string"}},{"name":"state","in":"query","required":false,"schema":{"type":"string"}},{"name":"code_challenge","in":"query","required":false,"schema":{"type":"string"}},{"name":"code_challenge_method","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{"Location":{"required":true,"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/oidc/oauth2/token":{"post":{"tags":["Identity"],"description":"Exchange an authorisation code for tokens. Form-encoded per OpenID Connect Core 1.0.","operationId":"oidcToken","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/OidcTokenRequest"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OidcTokenResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"httpAuth":[]}]}},"/oidc/oauth2/userinfo":{"get":{"tags":["Identity"],"description":"The claims a relying party reads with an access token. Claim names are the standard's.","operationId":"oidcUserInfo","responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OidcUserInfo"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"httpAuth1":[]}]}},"/oidc/.extension/sso/launch":{"post":{"tags":["Identity"],"description":"Just-in-time SSO launch. Submit as a top-level form POST; the answer sets a first-party session cookie and redirects the browser to `target`. Form-encoded and cookie-setting because it is a browser navigation, not a fetch.","operationId":"oidcSsoLaunch","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/OidcSsoLaunchRequest"}}},"required":true},"responses":{"200":{"description":"","headers":{"Set-Cookie":{"required":true,"schema":{"type":"string"}},"Location":{"required":true,"schema":{"type":"string"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"405":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"406":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"501":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}}},"webhooks":{"MerchantCreated":{"post":{"tags":["Webhooks"],"summary":"MerchantCreated","description":"A sub-merchant of a marketplace has been created and has started onboarding.\n\nWe `POST` this to the subscription's url as `application/json`, signed with the subscription's secret in\n`Payload-Signature`. Every key is always present, `null` when it has no value.\n\nA delivery is retried until it is accepted, rejected or its delivery window runs out, so the same event can\narrive more than once: process it idempotently. Deliveries are not ordered.","operationId":"MerchantCreated","parameters":[{"name":"Payload-Signature","in":"header","description":"Base64 of the HMAC-SHA256 of the request body's exact bytes, keyed with the subscription's signing secret as UTF-8. Compute it over the raw body before parsing it, and compare in constant time.","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","description":"Always `APG-Webhooks/1.0`.","required":true,"schema":{"type":"string"},"example":"APG-Webhooks/1.0"}],"requestBody":{"description":"A `MchtEvent`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MchtEvent"}}},"required":true},"responses":{"2XX":{"description":"Accepted. Any 2xx is an acceptance, and its body is recorded on the delivery but not read."},"default":{"description":"Not accepted. A 3xx (redirects are not followed), 401, 403, 408, 429 or 5xx, or no answer at all, is retried within the delivery window. Any other 4xx is a rejection, and the delivery is recorded `Failed` and not retried."}}}},"MerchantActivated":{"post":{"tags":["Webhooks"],"summary":"MerchantActivated","description":"A sub-merchant of a marketplace has been fully onboarded and can accept payments.\n\nWe `POST` this to the subscription's url as `application/json`, signed with the subscription's secret in\n`Payload-Signature`. Every key is always present, `null` when it has no value.\n\nA delivery is retried until it is accepted, rejected or its delivery window runs out, so the same event can\narrive more than once: process it idempotently. Deliveries are not ordered.","operationId":"MerchantActivated","parameters":[{"name":"Payload-Signature","in":"header","description":"Base64 of the HMAC-SHA256 of the request body's exact bytes, keyed with the subscription's signing secret as UTF-8. Compute it over the raw body before parsing it, and compare in constant time.","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","description":"Always `APG-Webhooks/1.0`.","required":true,"schema":{"type":"string"},"example":"APG-Webhooks/1.0"}],"requestBody":{"description":"A `MchtEvent`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MchtEvent"}}},"required":true},"responses":{"2XX":{"description":"Accepted. Any 2xx is an acceptance, and its body is recorded on the delivery but not read."},"default":{"description":"Not accepted. A 3xx (redirects are not followed), 401, 403, 408, 429 or 5xx, or no answer at all, is retried within the delivery window. Any other 4xx is a rejection, and the delivery is recorded `Failed` and not retried."}}}},"MerchantSuspended":{"post":{"tags":["Webhooks"],"summary":"MerchantSuspended","description":"A sub-merchant of a marketplace has been suspended, so it cannot take new payments.\n\nWe `POST` this to the subscription's url as `application/json`, signed with the subscription's secret in\n`Payload-Signature`. Every key is always present, `null` when it has no value.\n\nA delivery is retried until it is accepted, rejected or its delivery window runs out, so the same event can\narrive more than once: process it idempotently. Deliveries are not ordered.","operationId":"MerchantSuspended","parameters":[{"name":"Payload-Signature","in":"header","description":"Base64 of the HMAC-SHA256 of the request body's exact bytes, keyed with the subscription's signing secret as UTF-8. Compute it over the raw body before parsing it, and compare in constant time.","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","description":"Always `APG-Webhooks/1.0`.","required":true,"schema":{"type":"string"},"example":"APG-Webhooks/1.0"}],"requestBody":{"description":"A `MchtEvent`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MchtEvent"}}},"required":true},"responses":{"2XX":{"description":"Accepted. Any 2xx is an acceptance, and its body is recorded on the delivery but not read."},"default":{"description":"Not accepted. A 3xx (redirects are not followed), 401, 403, 408, 429 or 5xx, or no answer at all, is retried within the delivery window. Any other 4xx is a rejection, and the delivery is recorded `Failed` and not retried."}}}},"MerchantAvailableBalanceUpdated":{"post":{"tags":["Webhooks"],"summary":"MerchantAvailableBalanceUpdated","description":"A merchant's available balance has changed.\n\nWe `POST` this to the subscription's url as `application/json`, signed with the subscription's secret in\n`Payload-Signature`. Every key is always present, `null` when it has no value.\n\nA delivery is retried until it is accepted, rejected or its delivery window runs out, so the same event can\narrive more than once: process it idempotently. Deliveries are not ordered.","operationId":"MerchantAvailableBalanceUpdated","parameters":[{"name":"Payload-Signature","in":"header","description":"Base64 of the HMAC-SHA256 of the request body's exact bytes, keyed with the subscription's signing secret as UTF-8. Compute it over the raw body before parsing it, and compare in constant time.","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","description":"Always `APG-Webhooks/1.0`.","required":true,"schema":{"type":"string"},"example":"APG-Webhooks/1.0"}],"requestBody":{"description":"A `MchtEvent`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MchtEvent"}}},"required":true},"responses":{"2XX":{"description":"Accepted. Any 2xx is an acceptance, and its body is recorded on the delivery but not read."},"default":{"description":"Not accepted. A 3xx (redirects are not followed), 401, 403, 408, 429 or 5xx, or no answer at all, is retried within the delivery window. Any other 4xx is a rejection, and the delivery is recorded `Failed` and not retried."}}}},"MerchantBankAccountAdded":{"post":{"tags":["Webhooks"],"summary":"MerchantBankAccountAdded","description":"A bank account has been added to a merchant.\n\nWe `POST` this to the subscription's url as `application/json`, signed with the subscription's secret in\n`Payload-Signature`. Every key is always present, `null` when it has no value.\n\nA delivery is retried until it is accepted, rejected or its delivery window runs out, so the same event can\narrive more than once: process it idempotently. Deliveries are not ordered.","operationId":"MerchantBankAccountAdded","parameters":[{"name":"Payload-Signature","in":"header","description":"Base64 of the HMAC-SHA256 of the request body's exact bytes, keyed with the subscription's signing secret as UTF-8. Compute it over the raw body before parsing it, and compare in constant time.","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","description":"Always `APG-Webhooks/1.0`.","required":true,"schema":{"type":"string"},"example":"APG-Webhooks/1.0"}],"requestBody":{"description":"A `MchtEvent`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MchtEvent"}}},"required":true},"responses":{"2XX":{"description":"Accepted. Any 2xx is an acceptance, and its body is recorded on the delivery but not read."},"default":{"description":"Not accepted. A 3xx (redirects are not followed), 401, 403, 408, 429 or 5xx, or no answer at all, is retried within the delivery window. Any other 4xx is a rejection, and the delivery is recorded `Failed` and not retried."}}}},"MerchantPrimaryBankAccountUpdated":{"post":{"tags":["Webhooks"],"summary":"MerchantPrimaryBankAccountUpdated","description":"A merchant's primary bank account, the one automated payouts are paid to and the default for manual payouts, has changed.\n\nWe `POST` this to the subscription's url as `application/json`, signed with the subscription's secret in\n`Payload-Signature`. Every key is always present, `null` when it has no value.\n\nA delivery is retried until it is accepted, rejected or its delivery window runs out, so the same event can\narrive more than once: process it idempotently. Deliveries are not ordered.","operationId":"MerchantPrimaryBankAccountUpdated","parameters":[{"name":"Payload-Signature","in":"header","description":"Base64 of the HMAC-SHA256 of the request body's exact bytes, keyed with the subscription's signing secret as UTF-8. Compute it over the raw body before parsing it, and compare in constant time.","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","description":"Always `APG-Webhooks/1.0`.","required":true,"schema":{"type":"string"},"example":"APG-Webhooks/1.0"}],"requestBody":{"description":"A `MchtEvent`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MchtEvent"}}},"required":true},"responses":{"2XX":{"description":"Accepted. Any 2xx is an acceptance, and its body is recorded on the delivery but not read."},"default":{"description":"Not accepted. A 3xx (redirects are not followed), 401, 403, 408, 429 or 5xx, or no answer at all, is retried within the delivery window. Any other 4xx is a rejection, and the delivery is recorded `Failed` and not retried."}}}},"PayPlanCreated":{"post":{"tags":["Webhooks"],"summary":"PayPlanCreated","description":"A pay plan has been created, and is not yet attached to an order.\n\nDeprecated: pay plans are not on Bezel, and no Bezel operation creates or reads one. Still delivered to a subscription that names it.\n\nWe `POST` this to the subscription's url as `application/json`, signed with the subscription's secret in\n`Payload-Signature`. Every key is always present, `null` when it has no value.\n\nA delivery is retried until it is accepted, rejected or its delivery window runs out, so the same event can\narrive more than once: process it idempotently. Deliveries are not ordered.","operationId":"PayPlanCreated","parameters":[{"name":"Payload-Signature","in":"header","description":"Base64 of the HMAC-SHA256 of the request body's exact bytes, keyed with the subscription's signing secret as UTF-8. Compute it over the raw body before parsing it, and compare in constant time.","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","description":"Always `APG-Webhooks/1.0`.","required":true,"schema":{"type":"string"},"example":"APG-Webhooks/1.0"}],"requestBody":{"description":"A `PlanEvent`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanEvent"}}},"required":true},"responses":{"2XX":{"description":"Accepted. Any 2xx is an acceptance, and its body is recorded on the delivery but not read."},"default":{"description":"Not accepted. A 3xx (redirects are not followed), 401, 403, 408, 429 or 5xx, or no answer at all, is retried within the delivery window. Any other 4xx is a rejection, and the delivery is recorded `Failed` and not retried."}},"deprecated":true}},"PayPlanActivated":{"post":{"tags":["Webhooks"],"summary":"PayPlanActivated","description":"A pay plan has been established: any initial payment has been received and instalments remain.\n\nDeprecated: pay plans are not on Bezel, and no Bezel operation creates or reads one. Still delivered to a subscription that names it.\n\nWe `POST` this to the subscription's url as `application/json`, signed with the subscription's secret in\n`Payload-Signature`. Every key is always present, `null` when it has no value.\n\nA delivery is retried until it is accepted, rejected or its delivery window runs out, so the same event can\narrive more than once: process it idempotently. Deliveries are not ordered.","operationId":"PayPlanActivated","parameters":[{"name":"Payload-Signature","in":"header","description":"Base64 of the HMAC-SHA256 of the request body's exact bytes, keyed with the subscription's signing secret as UTF-8. Compute it over the raw body before parsing it, and compare in constant time.","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","description":"Always `APG-Webhooks/1.0`.","required":true,"schema":{"type":"string"},"example":"APG-Webhooks/1.0"}],"requestBody":{"description":"A `PlanEvent`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanEvent"}}},"required":true},"responses":{"2XX":{"description":"Accepted. Any 2xx is an acceptance, and its body is recorded on the delivery but not read."},"default":{"description":"Not accepted. A 3xx (redirects are not followed), 401, 403, 408, 429 or 5xx, or no answer at all, is retried within the delivery window. Any other 4xx is a rejection, and the delivery is recorded `Failed` and not retried."}},"deprecated":true}},"PayPlanCompleted":{"post":{"tags":["Webhooks"],"summary":"PayPlanCompleted","description":"A pay plan has been paid in full, including any fees.\n\nDeprecated: pay plans are not on Bezel, and no Bezel operation creates or reads one. Still delivered to a subscription that names it.\n\nWe `POST` this to the subscription's url as `application/json`, signed with the subscription's secret in\n`Payload-Signature`. Every key is always present, `null` when it has no value.\n\nA delivery is retried until it is accepted, rejected or its delivery window runs out, so the same event can\narrive more than once: process it idempotently. Deliveries are not ordered.","operationId":"PayPlanCompleted","parameters":[{"name":"Payload-Signature","in":"header","description":"Base64 of the HMAC-SHA256 of the request body's exact bytes, keyed with the subscription's signing secret as UTF-8. Compute it over the raw body before parsing it, and compare in constant time.","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","description":"Always `APG-Webhooks/1.0`.","required":true,"schema":{"type":"string"},"example":"APG-Webhooks/1.0"}],"requestBody":{"description":"A `PlanEvent`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanEvent"}}},"required":true},"responses":{"2XX":{"description":"Accepted. Any 2xx is an acceptance, and its body is recorded on the delivery but not read."},"default":{"description":"Not accepted. A 3xx (redirects are not followed), 401, 403, 408, 429 or 5xx, or no answer at all, is retried within the delivery window. Any other 4xx is a rejection, and the delivery is recorded `Failed` and not retried."}},"deprecated":true}},"PayPlanInDefault":{"post":{"tags":["Webhooks"],"summary":"PayPlanInDefault","description":"A pay plan is overdue and has not been paid after several collection attempts.\n\nDeprecated: pay plans are not on Bezel, and no Bezel operation creates or reads one. Still delivered to a subscription that names it.\n\nWe `POST` this to the subscription's url as `application/json`, signed with the subscription's secret in\n`Payload-Signature`. Every key is always present, `null` when it has no value.\n\nA delivery is retried until it is accepted, rejected or its delivery window runs out, so the same event can\narrive more than once: process it idempotently. Deliveries are not ordered.","operationId":"PayPlanInDefault","parameters":[{"name":"Payload-Signature","in":"header","description":"Base64 of the HMAC-SHA256 of the request body's exact bytes, keyed with the subscription's signing secret as UTF-8. Compute it over the raw body before parsing it, and compare in constant time.","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","description":"Always `APG-Webhooks/1.0`.","required":true,"schema":{"type":"string"},"example":"APG-Webhooks/1.0"}],"requestBody":{"description":"A `PlanEvent`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanEvent"}}},"required":true},"responses":{"2XX":{"description":"Accepted. Any 2xx is an acceptance, and its body is recorded on the delivery but not read."},"default":{"description":"Not accepted. A 3xx (redirects are not followed), 401, 403, 408, 429 or 5xx, or no answer at all, is retried within the delivery window. Any other 4xx is a rejection, and the delivery is recorded `Failed` and not retried."}},"deprecated":true}},"PayInFullCreated":{"post":{"tags":["Webhooks"],"summary":"PayInFullCreated","description":"A payment token for a full payment has been created. No money has moved.\n\nWe `POST` this to the subscription's url as `application/json`, signed with the subscription's secret in\n`Payload-Signature`. Every key is always present, `null` when it has no value.\n\nA delivery is retried until it is accepted, rejected or its delivery window runs out, so the same event can\narrive more than once: process it idempotently. Deliveries are not ordered.","operationId":"PayInFullCreated","parameters":[{"name":"Payload-Signature","in":"header","description":"Base64 of the HMAC-SHA256 of the request body's exact bytes, keyed with the subscription's signing secret as UTF-8. Compute it over the raw body before parsing it, and compare in constant time.","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","description":"Always `APG-Webhooks/1.0`.","required":true,"schema":{"type":"string"},"example":"APG-Webhooks/1.0"}],"requestBody":{"description":"A `PtknEvent`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PtknEvent"}}},"required":true},"responses":{"2XX":{"description":"Accepted. Any 2xx is an acceptance, and its body is recorded on the delivery but not read."},"default":{"description":"Not accepted. A 3xx (redirects are not followed), 401, 403, 408, 429 or 5xx, or no answer at all, is retried within the delivery window. Any other 4xx is a rejection, and the delivery is recorded `Failed` and not retried."}}}},"PayInFullAccepted":{"post":{"tags":["Webhooks"],"summary":"PayInFullAccepted","description":"A full payment has been accepted by the customer, and its payment method is asynchronous, a direct debit or a bank transfer.\n\nWe `POST` this to the subscription's url as `application/json`, signed with the subscription's secret in\n`Payload-Signature`. Every key is always present, `null` when it has no value.\n\nA delivery is retried until it is accepted, rejected or its delivery window runs out, so the same event can\narrive more than once: process it idempotently. Deliveries are not ordered.","operationId":"PayInFullAccepted","parameters":[{"name":"Payload-Signature","in":"header","description":"Base64 of the HMAC-SHA256 of the request body's exact bytes, keyed with the subscription's signing secret as UTF-8. Compute it over the raw body before parsing it, and compare in constant time.","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","description":"Always `APG-Webhooks/1.0`.","required":true,"schema":{"type":"string"},"example":"APG-Webhooks/1.0"}],"requestBody":{"description":"A `PtknEvent`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PtknEvent"}}},"required":true},"responses":{"2XX":{"description":"Accepted. Any 2xx is an acceptance, and its body is recorded on the delivery but not read."},"default":{"description":"Not accepted. A 3xx (redirects are not followed), 401, 403, 408, 429 or 5xx, or no answer at all, is retried within the delivery window. Any other 4xx is a rejection, and the delivery is recorded `Failed` and not retried."}}}},"PayInFullAuthorised":{"post":{"tags":["Webhooks"],"summary":"PayInFullAuthorised","description":"A card payment has been authorised, reserving the funds, and not yet captured.\n\nWe `POST` this to the subscription's url as `application/json`, signed with the subscription's secret in\n`Payload-Signature`. Every key is always present, `null` when it has no value.\n\nA delivery is retried until it is accepted, rejected or its delivery window runs out, so the same event can\narrive more than once: process it idempotently. Deliveries are not ordered.","operationId":"PayInFullAuthorised","parameters":[{"name":"Payload-Signature","in":"header","description":"Base64 of the HMAC-SHA256 of the request body's exact bytes, keyed with the subscription's signing secret as UTF-8. Compute it over the raw body before parsing it, and compare in constant time.","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","description":"Always `APG-Webhooks/1.0`.","required":true,"schema":{"type":"string"},"example":"APG-Webhooks/1.0"}],"requestBody":{"description":"A `PtknEvent`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PtknEvent"}}},"required":true},"responses":{"2XX":{"description":"Accepted. Any 2xx is an acceptance, and its body is recorded on the delivery but not read."},"default":{"description":"Not accepted. A 3xx (redirects are not followed), 401, 403, 408, 429 or 5xx, or no answer at all, is retried within the delivery window. Any other 4xx is a rejection, and the delivery is recorded `Failed` and not retried."}}}},"PayInFullCompleted":{"post":{"tags":["Webhooks"],"summary":"PayInFullCompleted","description":"A full payment has been paid.\n\nWe `POST` this to the subscription's url as `application/json`, signed with the subscription's secret in\n`Payload-Signature`. Every key is always present, `null` when it has no value.\n\nA delivery is retried until it is accepted, rejected or its delivery window runs out, so the same event can\narrive more than once: process it idempotently. Deliveries are not ordered.","operationId":"PayInFullCompleted","parameters":[{"name":"Payload-Signature","in":"header","description":"Base64 of the HMAC-SHA256 of the request body's exact bytes, keyed with the subscription's signing secret as UTF-8. Compute it over the raw body before parsing it, and compare in constant time.","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","description":"Always `APG-Webhooks/1.0`.","required":true,"schema":{"type":"string"},"example":"APG-Webhooks/1.0"}],"requestBody":{"description":"A `PtknEvent`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PtknEvent"}}},"required":true},"responses":{"2XX":{"description":"Accepted. Any 2xx is an acceptance, and its body is recorded on the delivery but not read."},"default":{"description":"Not accepted. A 3xx (redirects are not followed), 401, 403, 408, 429 or 5xx, or no answer at all, is retried within the delivery window. Any other 4xx is a rejection, and the delivery is recorded `Failed` and not retried."}}}},"TransactionPaid":{"post":{"tags":["Webhooks"],"summary":"TransactionPaid","description":"An order has been paid from the merchant's point of view: a full payment has completed, or a pay plan has been activated.\n\nWe `POST` this to the subscription's url as `application/json`, signed with the subscription's secret in\n`Payload-Signature`. Every key is always present, `null` when it has no value.\n\nA delivery is retried until it is accepted, rejected or its delivery window runs out, so the same event can\narrive more than once: process it idempotently. Deliveries are not ordered.","operationId":"TransactionPaid","parameters":[{"name":"Payload-Signature","in":"header","description":"Base64 of the HMAC-SHA256 of the request body's exact bytes, keyed with the subscription's signing secret as UTF-8. Compute it over the raw body before parsing it, and compare in constant time.","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","description":"Always `APG-Webhooks/1.0`.","required":true,"schema":{"type":"string"},"example":"APG-Webhooks/1.0"}],"requestBody":{"description":"A `TranEvent`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranEvent"}}},"required":true},"responses":{"2XX":{"description":"Accepted. Any 2xx is an acceptance, and its body is recorded on the delivery but not read."},"default":{"description":"Not accepted. A 3xx (redirects are not followed), 401, 403, 408, 429 or 5xx, or no answer at all, is retried within the delivery window. Any other 4xx is a rejection, and the delivery is recorded `Failed` and not retried."}}}},"TransactionFailed":{"post":{"tags":["Webhooks"],"summary":"TransactionFailed","description":"An attempt to pay for an order has failed.\n\nWe `POST` this to the subscription's url as `application/json`, signed with the subscription's secret in\n`Payload-Signature`. Every key is always present, `null` when it has no value.\n\nA delivery is retried until it is accepted, rejected or its delivery window runs out, so the same event can\narrive more than once: process it idempotently. Deliveries are not ordered.","operationId":"TransactionFailed","parameters":[{"name":"Payload-Signature","in":"header","description":"Base64 of the HMAC-SHA256 of the request body's exact bytes, keyed with the subscription's signing secret as UTF-8. Compute it over the raw body before parsing it, and compare in constant time.","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","description":"Always `APG-Webhooks/1.0`.","required":true,"schema":{"type":"string"},"example":"APG-Webhooks/1.0"}],"requestBody":{"description":"A `TranEvent`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranEvent"}}},"required":true},"responses":{"2XX":{"description":"Accepted. Any 2xx is an acceptance, and its body is recorded on the delivery but not read."},"default":{"description":"Not accepted. A 3xx (redirects are not followed), 401, 403, 408, 429 or 5xx, or no answer at all, is retried within the delivery window. Any other 4xx is a rejection, and the delivery is recorded `Failed` and not retried."}}}},"DisputeCreated":{"post":{"tags":["Webhooks"],"summary":"DisputeCreated","description":"A customer has disputed a payment with their card issuer or bank.\n\nWe `POST` this to the subscription's url as `application/json`, signed with the subscription's secret in\n`Payload-Signature`. Every key is always present, `null` when it has no value.\n\nA delivery is retried until it is accepted, rejected or its delivery window runs out, so the same event can\narrive more than once: process it idempotently. Deliveries are not ordered.","operationId":"DisputeCreated","parameters":[{"name":"Payload-Signature","in":"header","description":"Base64 of the HMAC-SHA256 of the request body's exact bytes, keyed with the subscription's signing secret as UTF-8. Compute it over the raw body before parsing it, and compare in constant time.","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","description":"Always `APG-Webhooks/1.0`.","required":true,"schema":{"type":"string"},"example":"APG-Webhooks/1.0"}],"requestBody":{"description":"A `DisputeEvent`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeEvent"}}},"required":true},"responses":{"2XX":{"description":"Accepted. Any 2xx is an acceptance, and its body is recorded on the delivery but not read."},"default":{"description":"Not accepted. A 3xx (redirects are not followed), 401, 403, 408, 429 or 5xx, or no answer at all, is retried within the delivery window. Any other 4xx is a rejection, and the delivery is recorded `Failed` and not retried."}}}},"DisputeUpdated":{"post":{"tags":["Webhooks"],"summary":"DisputeUpdated","description":"An existing dispute has been updated.\n\nWe `POST` this to the subscription's url as `application/json`, signed with the subscription's secret in\n`Payload-Signature`. Every key is always present, `null` when it has no value.\n\nA delivery is retried until it is accepted, rejected or its delivery window runs out, so the same event can\narrive more than once: process it idempotently. Deliveries are not ordered.","operationId":"DisputeUpdated","parameters":[{"name":"Payload-Signature","in":"header","description":"Base64 of the HMAC-SHA256 of the request body's exact bytes, keyed with the subscription's signing secret as UTF-8. Compute it over the raw body before parsing it, and compare in constant time.","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","description":"Always `APG-Webhooks/1.0`.","required":true,"schema":{"type":"string"},"example":"APG-Webhooks/1.0"}],"requestBody":{"description":"A `DisputeEvent`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeEvent"}}},"required":true},"responses":{"2XX":{"description":"Accepted. Any 2xx is an acceptance, and its body is recorded on the delivery but not read."},"default":{"description":"Not accepted. A 3xx (redirects are not followed), 401, 403, 408, 429 or 5xx, or no answer at all, is retried within the delivery window. Any other 4xx is a rejection, and the delivery is recorded `Failed` and not retried."}}}},"PayoutCreated":{"post":{"tags":["Webhooks"],"summary":"PayoutCreated","description":"A payout's details have been confirmed.\n\nWe `POST` this to the subscription's url as `application/json`, signed with the subscription's secret in\n`Payload-Signature`. Every key is always present, `null` when it has no value.\n\nA delivery is retried until it is accepted, rejected or its delivery window runs out, so the same event can\narrive more than once: process it idempotently. Deliveries are not ordered.","operationId":"PayoutCreated","parameters":[{"name":"Payload-Signature","in":"header","description":"Base64 of the HMAC-SHA256 of the request body's exact bytes, keyed with the subscription's signing secret as UTF-8. Compute it over the raw body before parsing it, and compare in constant time.","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","description":"Always `APG-Webhooks/1.0`.","required":true,"schema":{"type":"string"},"example":"APG-Webhooks/1.0"}],"requestBody":{"description":"A `PayoutEvent`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutEvent"}}},"required":true},"responses":{"2XX":{"description":"Accepted. Any 2xx is an acceptance, and its body is recorded on the delivery but not read."},"default":{"description":"Not accepted. A 3xx (redirects are not followed), 401, 403, 408, 429 or 5xx, or no answer at all, is retried within the delivery window. Any other 4xx is a rejection, and the delivery is recorded `Failed` and not retried."}}}},"PayoutPending":{"post":{"tags":["Webhooks"],"summary":"PayoutPending","description":"A payout is being prepared for disbursement.\n\nWe `POST` this to the subscription's url as `application/json`, signed with the subscription's secret in\n`Payload-Signature`. Every key is always present, `null` when it has no value.\n\nA delivery is retried until it is accepted, rejected or its delivery window runs out, so the same event can\narrive more than once: process it idempotently. Deliveries are not ordered.","operationId":"PayoutPending","parameters":[{"name":"Payload-Signature","in":"header","description":"Base64 of the HMAC-SHA256 of the request body's exact bytes, keyed with the subscription's signing secret as UTF-8. Compute it over the raw body before parsing it, and compare in constant time.","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","description":"Always `APG-Webhooks/1.0`.","required":true,"schema":{"type":"string"},"example":"APG-Webhooks/1.0"}],"requestBody":{"description":"A `PayoutEvent`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutEvent"}}},"required":true},"responses":{"2XX":{"description":"Accepted. Any 2xx is an acceptance, and its body is recorded on the delivery but not read."},"default":{"description":"Not accepted. A 3xx (redirects are not followed), 401, 403, 408, 429 or 5xx, or no answer at all, is retried within the delivery window. Any other 4xx is a rejection, and the delivery is recorded `Failed` and not retried."}}}},"PayoutFailed":{"post":{"tags":["Webhooks"],"summary":"PayoutFailed","description":"A payout to a merchant's primary bank account could not be made.\n\nWe `POST` this to the subscription's url as `application/json`, signed with the subscription's secret in\n`Payload-Signature`. Every key is always present, `null` when it has no value.\n\nA delivery is retried until it is accepted, rejected or its delivery window runs out, so the same event can\narrive more than once: process it idempotently. Deliveries are not ordered.","operationId":"PayoutFailed","parameters":[{"name":"Payload-Signature","in":"header","description":"Base64 of the HMAC-SHA256 of the request body's exact bytes, keyed with the subscription's signing secret as UTF-8. Compute it over the raw body before parsing it, and compare in constant time.","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","description":"Always `APG-Webhooks/1.0`.","required":true,"schema":{"type":"string"},"example":"APG-Webhooks/1.0"}],"requestBody":{"description":"A `PayoutEvent`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutEvent"}}},"required":true},"responses":{"2XX":{"description":"Accepted. Any 2xx is an acceptance, and its body is recorded on the delivery but not read."},"default":{"description":"Not accepted. A 3xx (redirects are not followed), 401, 403, 408, 429 or 5xx, or no answer at all, is retried within the delivery window. Any other 4xx is a rejection, and the delivery is recorded `Failed` and not retried."}}}},"PayoutPaid":{"post":{"tags":["Webhooks"],"summary":"PayoutPaid","description":"A payout has been delivered to a merchant's primary bank account.\n\nWe `POST` this to the subscription's url as `application/json`, signed with the subscription's secret in\n`Payload-Signature`. Every key is always present, `null` when it has no value.\n\nA delivery is retried until it is accepted, rejected or its delivery window runs out, so the same event can\narrive more than once: process it idempotently. Deliveries are not ordered.","operationId":"PayoutPaid","parameters":[{"name":"Payload-Signature","in":"header","description":"Base64 of the HMAC-SHA256 of the request body's exact bytes, keyed with the subscription's signing secret as UTF-8. Compute it over the raw body before parsing it, and compare in constant time.","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","description":"Always `APG-Webhooks/1.0`.","required":true,"schema":{"type":"string"},"example":"APG-Webhooks/1.0"}],"requestBody":{"description":"A `PayoutEvent`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutEvent"}}},"required":true},"responses":{"2XX":{"description":"Accepted. Any 2xx is an acceptance, and its body is recorded on the delivery but not read."},"default":{"description":"Not accepted. A 3xx (redirects are not followed), 401, 403, 408, 429 or 5xx, or no answer at all, is retried within the delivery window. Any other 4xx is a rejection, and the delivery is recorded `Failed` and not retried."}}}},"PayoutReversed":{"post":{"tags":["Webhooks"],"summary":"PayoutReversed","description":"A payout has been returned and credited back to the merchant.\n\nWe `POST` this to the subscription's url as `application/json`, signed with the subscription's secret in\n`Payload-Signature`. Every key is always present, `null` when it has no value.\n\nA delivery is retried until it is accepted, rejected or its delivery window runs out, so the same event can\narrive more than once: process it idempotently. Deliveries are not ordered.","operationId":"PayoutReversed","parameters":[{"name":"Payload-Signature","in":"header","description":"Base64 of the HMAC-SHA256 of the request body's exact bytes, keyed with the subscription's signing secret as UTF-8. Compute it over the raw body before parsing it, and compare in constant time.","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","description":"Always `APG-Webhooks/1.0`.","required":true,"schema":{"type":"string"},"example":"APG-Webhooks/1.0"}],"requestBody":{"description":"A `PayoutEvent`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutEvent"}}},"required":true},"responses":{"2XX":{"description":"Accepted. Any 2xx is an acceptance, and its body is recorded on the delivery but not read."},"default":{"description":"Not accepted. A 3xx (redirects are not followed), 401, 403, 408, 429 or 5xx, or no answer at all, is retried within the delivery window. Any other 4xx is a rejection, and the delivery is recorded `Failed` and not retried."}}}},"InvoiceIssued":{"post":{"tags":["Webhooks"],"summary":"InvoiceIssued","description":"An invoice for outstanding platform fees has been issued to a gross settlement merchant.\n\nWe `POST` this to the subscription's url as `application/json`, signed with the subscription's secret in\n`Payload-Signature`. Every key is always present, `null` when it has no value.\n\nA delivery is retried until it is accepted, rejected or its delivery window runs out, so the same event can\narrive more than once: process it idempotently. Deliveries are not ordered.","operationId":"InvoiceIssued","parameters":[{"name":"Payload-Signature","in":"header","description":"Base64 of the HMAC-SHA256 of the request body's exact bytes, keyed with the subscription's signing secret as UTF-8. Compute it over the raw body before parsing it, and compare in constant time.","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","description":"Always `APG-Webhooks/1.0`.","required":true,"schema":{"type":"string"},"example":"APG-Webhooks/1.0"}],"requestBody":{"description":"A `MinvEvent`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MinvEvent"}}},"required":true},"responses":{"2XX":{"description":"Accepted. Any 2xx is an acceptance, and its body is recorded on the delivery but not read."},"default":{"description":"Not accepted. A 3xx (redirects are not followed), 401, 403, 408, 429 or 5xx, or no answer at all, is retried within the delivery window. Any other 4xx is a rejection, and the delivery is recorded `Failed` and not retried."}}}},"InvoiceDue":{"post":{"tags":["Webhooks"],"summary":"InvoiceDue","description":"An outstanding invoice has fallen due.\n\nWe `POST` this to the subscription's url as `application/json`, signed with the subscription's secret in\n`Payload-Signature`. Every key is always present, `null` when it has no value.\n\nA delivery is retried until it is accepted, rejected or its delivery window runs out, so the same event can\narrive more than once: process it idempotently. Deliveries are not ordered.","operationId":"InvoiceDue","parameters":[{"name":"Payload-Signature","in":"header","description":"Base64 of the HMAC-SHA256 of the request body's exact bytes, keyed with the subscription's signing secret as UTF-8. Compute it over the raw body before parsing it, and compare in constant time.","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","description":"Always `APG-Webhooks/1.0`.","required":true,"schema":{"type":"string"},"example":"APG-Webhooks/1.0"}],"requestBody":{"description":"A `MinvEvent`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MinvEvent"}}},"required":true},"responses":{"2XX":{"description":"Accepted. Any 2xx is an acceptance, and its body is recorded on the delivery but not read."},"default":{"description":"Not accepted. A 3xx (redirects are not followed), 401, 403, 408, 429 or 5xx, or no answer at all, is retried within the delivery window. Any other 4xx is a rejection, and the delivery is recorded `Failed` and not retried."}}}},"InvoicePaymentFailed":{"post":{"tags":["Webhooks"],"summary":"InvoicePaymentFailed","description":"A payment towards an invoice has failed.\n\nWe `POST` this to the subscription's url as `application/json`, signed with the subscription's secret in\n`Payload-Signature`. Every key is always present, `null` when it has no value.\n\nA delivery is retried until it is accepted, rejected or its delivery window runs out, so the same event can\narrive more than once: process it idempotently. Deliveries are not ordered.","operationId":"InvoicePaymentFailed","parameters":[{"name":"Payload-Signature","in":"header","description":"Base64 of the HMAC-SHA256 of the request body's exact bytes, keyed with the subscription's signing secret as UTF-8. Compute it over the raw body before parsing it, and compare in constant time.","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","description":"Always `APG-Webhooks/1.0`.","required":true,"schema":{"type":"string"},"example":"APG-Webhooks/1.0"}],"requestBody":{"description":"A `MinvEvent`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MinvEvent"}}},"required":true},"responses":{"2XX":{"description":"Accepted. Any 2xx is an acceptance, and its body is recorded on the delivery but not read."},"default":{"description":"Not accepted. A 3xx (redirects are not followed), 401, 403, 408, 429 or 5xx, or no answer at all, is retried within the delivery window. Any other 4xx is a rejection, and the delivery is recorded `Failed` and not retried."}}}},"InvoicePaid":{"post":{"tags":["Webhooks"],"summary":"InvoicePaid","description":"An invoice has been paid.\n\nWe `POST` this to the subscription's url as `application/json`, signed with the subscription's secret in\n`Payload-Signature`. Every key is always present, `null` when it has no value.\n\nA delivery is retried until it is accepted, rejected or its delivery window runs out, so the same event can\narrive more than once: process it idempotently. Deliveries are not ordered.","operationId":"InvoicePaid","parameters":[{"name":"Payload-Signature","in":"header","description":"Base64 of the HMAC-SHA256 of the request body's exact bytes, keyed with the subscription's signing secret as UTF-8. Compute it over the raw body before parsing it, and compare in constant time.","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","description":"Always `APG-Webhooks/1.0`.","required":true,"schema":{"type":"string"},"example":"APG-Webhooks/1.0"}],"requestBody":{"description":"A `MinvEvent`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MinvEvent"}}},"required":true},"responses":{"2XX":{"description":"Accepted. Any 2xx is an acceptance, and its body is recorded on the delivery but not read."},"default":{"description":"Not accepted. A 3xx (redirects are not followed), 401, 403, 408, 429 or 5xx, or no answer at all, is retried within the delivery window. Any other 4xx is a rejection, and the delivery is recorded `Failed` and not retried."}}}},"PaymentSourceCreated":{"post":{"tags":["Webhooks"],"summary":"PaymentSourceCreated","description":"A customer's payment source has been created.\n\nWe `POST` this to the subscription's url as `application/json`, signed with the subscription's secret in\n`Payload-Signature`. Every key is always present, `null` when it has no value.\n\nA delivery is retried until it is accepted, rejected or its delivery window runs out, so the same event can\narrive more than once: process it idempotently. Deliveries are not ordered.","operationId":"PaymentSourceCreated","parameters":[{"name":"Payload-Signature","in":"header","description":"Base64 of the HMAC-SHA256 of the request body's exact bytes, keyed with the subscription's signing secret as UTF-8. Compute it over the raw body before parsing it, and compare in constant time.","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","description":"Always `APG-Webhooks/1.0`.","required":true,"schema":{"type":"string"},"example":"APG-Webhooks/1.0"}],"requestBody":{"description":"A `PsrcEvent`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PsrcEvent"}}},"required":true},"responses":{"2XX":{"description":"Accepted. Any 2xx is an acceptance, and its body is recorded on the delivery but not read."},"default":{"description":"Not accepted. A 3xx (redirects are not followed), 401, 403, 408, 429 or 5xx, or no answer at all, is retried within the delivery window. Any other 4xx is a rejection, and the delivery is recorded `Failed` and not retried."}}}},"PaymentSourceMethodUpdated":{"post":{"tags":["Webhooks"],"summary":"PaymentSourceMethodUpdated","description":"A customer's payment source has a new payment method.\n\nWe `POST` this to the subscription's url as `application/json`, signed with the subscription's secret in\n`Payload-Signature`. Every key is always present, `null` when it has no value.\n\nA delivery is retried until it is accepted, rejected or its delivery window runs out, so the same event can\narrive more than once: process it idempotently. Deliveries are not ordered.","operationId":"PaymentSourceMethodUpdated","parameters":[{"name":"Payload-Signature","in":"header","description":"Base64 of the HMAC-SHA256 of the request body's exact bytes, keyed with the subscription's signing secret as UTF-8. Compute it over the raw body before parsing it, and compare in constant time.","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","description":"Always `APG-Webhooks/1.0`.","required":true,"schema":{"type":"string"},"example":"APG-Webhooks/1.0"}],"requestBody":{"description":"A `PsrcEvent`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PsrcEvent"}}},"required":true},"responses":{"2XX":{"description":"Accepted. Any 2xx is an acceptance, and its body is recorded on the delivery but not read."},"default":{"description":"Not accepted. A 3xx (redirects are not followed), 401, 403, 408, 429 or 5xx, or no answer at all, is retried within the delivery window. Any other 4xx is a rejection, and the delivery is recorded `Failed` and not retried."}}}},"PaymentSourceDeleted":{"post":{"tags":["Webhooks"],"summary":"PaymentSourceDeleted","description":"A customer's payment source has been deleted.\n\nWe `POST` this to the subscription's url as `application/json`, signed with the subscription's secret in\n`Payload-Signature`. Every key is always present, `null` when it has no value.\n\nA delivery is retried until it is accepted, rejected or its delivery window runs out, so the same event can\narrive more than once: process it idempotently. Deliveries are not ordered.","operationId":"PaymentSourceDeleted","parameters":[{"name":"Payload-Signature","in":"header","description":"Base64 of the HMAC-SHA256 of the request body's exact bytes, keyed with the subscription's signing secret as UTF-8. Compute it over the raw body before parsing it, and compare in constant time.","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","description":"Always `APG-Webhooks/1.0`.","required":true,"schema":{"type":"string"},"example":"APG-Webhooks/1.0"}],"requestBody":{"description":"A `PsrcEvent`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PsrcEvent"}}},"required":true},"responses":{"2XX":{"description":"Accepted. Any 2xx is an acceptance, and its body is recorded on the delivery but not read."},"default":{"description":"Not accepted. A 3xx (redirects are not followed), 401, 403, 408, 429 or 5xx, or no answer at all, is retried within the delivery window. Any other 4xx is a rejection, and the delivery is recorded `Failed` and not retried."}}}},"LoanCreated":{"post":{"tags":["Webhooks"],"summary":"LoanCreated","description":"A loan has been created.\n\nWe `POST` this to the subscription's url as `application/json`, signed with the subscription's secret in\n`Payload-Signature`. Every key is always present, `null` when it has no value.\n\nA delivery is retried until it is accepted, rejected or its delivery window runs out, so the same event can\narrive more than once: process it idempotently. Deliveries are not ordered.","operationId":"LoanCreated","parameters":[{"name":"Payload-Signature","in":"header","description":"Base64 of the HMAC-SHA256 of the request body's exact bytes, keyed with the subscription's signing secret as UTF-8. Compute it over the raw body before parsing it, and compare in constant time.","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","description":"Always `APG-Webhooks/1.0`.","required":true,"schema":{"type":"string"},"example":"APG-Webhooks/1.0"}],"requestBody":{"description":"A `LoanEvent`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoanEvent"}}},"required":true},"responses":{"2XX":{"description":"Accepted. Any 2xx is an acceptance, and its body is recorded on the delivery but not read."},"default":{"description":"Not accepted. A 3xx (redirects are not followed), 401, 403, 408, 429 or 5xx, or no answer at all, is retried within the delivery window. Any other 4xx is a rejection, and the delivery is recorded `Failed` and not retried."}}}},"LoanStatementCreated":{"post":{"tags":["Webhooks"],"summary":"LoanStatementCreated","description":"A loan statement has been created, and not yet issued to the customer.\n\nWe `POST` this to the subscription's url as `application/json`, signed with the subscription's secret in\n`Payload-Signature`. Every key is always present, `null` when it has no value.\n\nA delivery is retried until it is accepted, rejected or its delivery window runs out, so the same event can\narrive more than once: process it idempotently. Deliveries are not ordered.","operationId":"LoanStatementCreated","parameters":[{"name":"Payload-Signature","in":"header","description":"Base64 of the HMAC-SHA256 of the request body's exact bytes, keyed with the subscription's signing secret as UTF-8. Compute it over the raw body before parsing it, and compare in constant time.","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","description":"Always `APG-Webhooks/1.0`.","required":true,"schema":{"type":"string"},"example":"APG-Webhooks/1.0"}],"requestBody":{"description":"A `LoanEvent`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoanEvent"}}},"required":true},"responses":{"2XX":{"description":"Accepted. Any 2xx is an acceptance, and its body is recorded on the delivery but not read."},"default":{"description":"Not accepted. A 3xx (redirects are not followed), 401, 403, 408, 429 or 5xx, or no answer at all, is retried within the delivery window. Any other 4xx is a rejection, and the delivery is recorded `Failed` and not retried."}}}},"LoanStatementIssued":{"post":{"tags":["Webhooks"],"summary":"LoanStatementIssued","description":"A loan statement has been issued to the customer.\n\nWe `POST` this to the subscription's url as `application/json`, signed with the subscription's secret in\n`Payload-Signature`. Every key is always present, `null` when it has no value.\n\nA delivery is retried until it is accepted, rejected or its delivery window runs out, so the same event can\narrive more than once: process it idempotently. Deliveries are not ordered.","operationId":"LoanStatementIssued","parameters":[{"name":"Payload-Signature","in":"header","description":"Base64 of the HMAC-SHA256 of the request body's exact bytes, keyed with the subscription's signing secret as UTF-8. Compute it over the raw body before parsing it, and compare in constant time.","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","description":"Always `APG-Webhooks/1.0`.","required":true,"schema":{"type":"string"},"example":"APG-Webhooks/1.0"}],"requestBody":{"description":"A `LoanEvent`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoanEvent"}}},"required":true},"responses":{"2XX":{"description":"Accepted. Any 2xx is an acceptance, and its body is recorded on the delivery but not read."},"default":{"description":"Not accepted. A 3xx (redirects are not followed), 401, 403, 408, 429 or 5xx, or no answer at all, is retried within the delivery window. Any other 4xx is a rejection, and the delivery is recorded `Failed` and not retried."}}}},"LoanStatementDue":{"post":{"tags":["Webhooks"],"summary":"LoanStatementDue","description":"A loan statement has reached its due date with a balance outstanding.\n\nWe `POST` this to the subscription's url as `application/json`, signed with the subscription's secret in\n`Payload-Signature`. Every key is always present, `null` when it has no value.\n\nA delivery is retried until it is accepted, rejected or its delivery window runs out, so the same event can\narrive more than once: process it idempotently. Deliveries are not ordered.","operationId":"LoanStatementDue","parameters":[{"name":"Payload-Signature","in":"header","description":"Base64 of the HMAC-SHA256 of the request body's exact bytes, keyed with the subscription's signing secret as UTF-8. Compute it over the raw body before parsing it, and compare in constant time.","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","description":"Always `APG-Webhooks/1.0`.","required":true,"schema":{"type":"string"},"example":"APG-Webhooks/1.0"}],"requestBody":{"description":"A `LoanEvent`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoanEvent"}}},"required":true},"responses":{"2XX":{"description":"Accepted. Any 2xx is an acceptance, and its body is recorded on the delivery but not read."},"default":{"description":"Not accepted. A 3xx (redirects are not followed), 401, 403, 408, 429 or 5xx, or no answer at all, is retried within the delivery window. Any other 4xx is a rejection, and the delivery is recorded `Failed` and not retried."}}}},"LoanStatementPaid":{"post":{"tags":["Webhooks"],"summary":"LoanStatementPaid","description":"A loan statement has been paid.\n\nWe `POST` this to the subscription's url as `application/json`, signed with the subscription's secret in\n`Payload-Signature`. Every key is always present, `null` when it has no value.\n\nA delivery is retried until it is accepted, rejected or its delivery window runs out, so the same event can\narrive more than once: process it idempotently. Deliveries are not ordered.","operationId":"LoanStatementPaid","parameters":[{"name":"Payload-Signature","in":"header","description":"Base64 of the HMAC-SHA256 of the request body's exact bytes, keyed with the subscription's signing secret as UTF-8. Compute it over the raw body before parsing it, and compare in constant time.","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","description":"Always `APG-Webhooks/1.0`.","required":true,"schema":{"type":"string"},"example":"APG-Webhooks/1.0"}],"requestBody":{"description":"A `LoanEvent`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoanEvent"}}},"required":true},"responses":{"2XX":{"description":"Accepted. Any 2xx is an acceptance, and its body is recorded on the delivery but not read."},"default":{"description":"Not accepted. A 3xx (redirects are not followed), 401, 403, 408, 429 or 5xx, or no answer at all, is retried within the delivery window. Any other 4xx is a rejection, and the delivery is recorded `Failed` and not retried."}}}},"LoanPaymentFailed":{"post":{"tags":["Webhooks"],"summary":"LoanPaymentFailed","description":"A payment towards a loan has failed.\n\n**Not yet delivered.** A subscription may name it, and nothing sends it today.\n\nWe `POST` this to the subscription's url as `application/json`, signed with the subscription's secret in\n`Payload-Signature`. Every key is always present, `null` when it has no value.\n\nA delivery is retried until it is accepted, rejected or its delivery window runs out, so the same event can\narrive more than once: process it idempotently. Deliveries are not ordered.","operationId":"LoanPaymentFailed","parameters":[{"name":"Payload-Signature","in":"header","description":"Base64 of the HMAC-SHA256 of the request body's exact bytes, keyed with the subscription's signing secret as UTF-8. Compute it over the raw body before parsing it, and compare in constant time.","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","description":"Always `APG-Webhooks/1.0`.","required":true,"schema":{"type":"string"},"example":"APG-Webhooks/1.0"}],"requestBody":{"description":"A `LoanEvent`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoanEvent"}}},"required":true},"responses":{"2XX":{"description":"Accepted. Any 2xx is an acceptance, and its body is recorded on the delivery but not read."},"default":{"description":"Not accepted. A 3xx (redirects are not followed), 401, 403, 408, 429 or 5xx, or no answer at all, is retried within the delivery window. Any other 4xx is a rejection, and the delivery is recorded `Failed` and not retried."}}}}},"components":{"schemas":{"AbnlkCmd":{"oneOf":[{"$ref":"#/components/schemas/AbnlkCmdByNumber"}],"discriminator":{"propertyName":"type","mapping":{"AbnlkCmdByNumber":"#/components/schemas/AbnlkCmdByNumber"}}},"AbnlkCmdByNumber":{"title":"AbnlkCmdByNumber","description":"Ask the register about an ABN.","examples":[{"type":"AbnlkCmdByNumber","abn":"example"}],"type":"object","required":["type","abn"],"properties":{"type":{"description":"Always `AbnlkCmdByNumber`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["AbnlkCmdByNumber"]},"abn":{"description":"The ABN, digits only. The register is asked directly, so an unknown one is a `404` from it rather than from us.","type":"string"}}},"AbnlkCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/AbnlkCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"AbnlkCreateRspAttributes":"#/components/schemas/AbnlkCreateRspAttributes"}}},"AbnlkCreateRspAttributes":{"title":"AbnlkCreateRspAttributes","examples":[{"type":"AbnlkCreateRspAttributes","created":{"type":"AbnlkViewAttributes","abn":{"type":"AbnlkIdentifierAttributes","value":"example","currentIndicator":"example"},"lastUpdated":"2026-08-19","entityStatus":{"type":"AbnlkStatusAttributes","code":"example","effectiveFrom":"2026-08-19","effectiveTo":"2026-08-19"},"entityType":{"type":"AbnlkEntityTypeAttributes","code":"example","description":"A short description."},"gstStatus":{"type":"AbnlkPeriodAttributes","effectiveFrom":"2026-08-19","effectiveTo":"2026-08-19"},"asicNumber":"example","legalNames":[{"type":"AbnlkNameAttributes","name":"Ada Lovelace","effectiveFrom":"2026-08-19","effectiveTo":"2026-08-19"}],"tradingNames":[{"type":"AbnlkNameAttributes","name":"Ada Lovelace","effectiveFrom":"2026-08-19","effectiveTo":"2026-08-19"}],"locations":[{"type":"AbnlkLocationAttributes","state":"example","postcode":"3000","effectiveFrom":"2026-08-19","effectiveTo":"2026-08-19"}]}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `AbnlkCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["AbnlkCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/AbnlkView"}}},"AbnlkEntityType":{"description":"The entity's type, as the register classifies it.","oneOf":[{"$ref":"#/components/schemas/AbnlkEntityTypeAttributes"}],"discriminator":{"propertyName":"type","mapping":{"AbnlkEntityTypeAttributes":"#/components/schemas/AbnlkEntityTypeAttributes"}}},"AbnlkEntityTypeAttributes":{"title":"AbnlkEntityTypeAttributes","description":"How the register classifies an entity.","examples":[{"type":"AbnlkEntityTypeAttributes","code":"example","description":"A short description."}],"type":"object","required":["type","code","description"],"properties":{"type":{"description":"Always `AbnlkEntityTypeAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["AbnlkEntityTypeAttributes"]},"code":{"description":"The register's own code, `PRV` for an Australian private company.","type":"string"},"description":{"description":"The same thing in words.","type":"string"}}},"AbnlkIdentifier":{"description":"The ABN as the register holds it, and whether it is the entity's current one.","oneOf":[{"$ref":"#/components/schemas/AbnlkIdentifierAttributes"}],"discriminator":{"propertyName":"type","mapping":{"AbnlkIdentifierAttributes":"#/components/schemas/AbnlkIdentifierAttributes"}}},"AbnlkIdentifierAttributes":{"title":"AbnlkIdentifierAttributes","description":"An ABN, and whether the register considers it current.","examples":[{"type":"AbnlkIdentifierAttributes","value":"example","currentIndicator":"example"}],"type":"object","required":["type","value","currentIndicator"],"properties":{"type":{"description":"Always `AbnlkIdentifierAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["AbnlkIdentifierAttributes"]},"value":{"type":"string"},"currentIndicator":{"description":"The register's own indicator, verbatim, `Y` where this is the entity's current ABN.","type":"string"}}},"AbnlkLocation":{"description":"Where the entity does business, and when it did.","oneOf":[{"$ref":"#/components/schemas/AbnlkLocationAttributes"}],"discriminator":{"propertyName":"type","mapping":{"AbnlkLocationAttributes":"#/components/schemas/AbnlkLocationAttributes"}}},"AbnlkLocationAttributes":{"title":"AbnlkLocationAttributes","description":"Where the entity does business, and when it did.","examples":[{"type":"AbnlkLocationAttributes","state":"example","postcode":"3000","effectiveFrom":"2026-08-19","effectiveTo":"2026-08-19"}],"type":"object","required":["type","state","postcode","effectiveFrom"],"properties":{"type":{"description":"Always `AbnlkLocationAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["AbnlkLocationAttributes"]},"state":{"description":"Australian state or territory code, `NSW`, `VIC`.","type":"string"},"postcode":{"type":"string"},"effectiveFrom":{"type":"string","format":"date"},"effectiveTo":{"type":"string","format":"date"}}},"AbnlkName":{"description":"A name the entity went by, and when.","oneOf":[{"$ref":"#/components/schemas/AbnlkNameAttributes"}],"discriminator":{"propertyName":"type","mapping":{"AbnlkNameAttributes":"#/components/schemas/AbnlkNameAttributes"}}},"AbnlkNameAttributes":{"title":"AbnlkNameAttributes","description":"A name the entity went by, and when.","examples":[{"type":"AbnlkNameAttributes","name":"Ada Lovelace","effectiveFrom":"2026-08-19","effectiveTo":"2026-08-19"}],"type":"object","required":["type","name","effectiveFrom"],"properties":{"type":{"description":"Always `AbnlkNameAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["AbnlkNameAttributes"]},"name":{"type":"string"},"effectiveFrom":{"type":"string","format":"date"},"effectiveTo":{"description":"Absent means it is still in use.","type":"string","format":"date"}}},"AbnlkPeriod":{"description":"When the entity was registered for GST, and until when. Absent where it never has been.","oneOf":[{"$ref":"#/components/schemas/AbnlkPeriodAttributes"}],"discriminator":{"propertyName":"type","mapping":{"AbnlkPeriodAttributes":"#/components/schemas/AbnlkPeriodAttributes"}}},"AbnlkPeriodAttributes":{"title":"AbnlkPeriodAttributes","description":"A stretch of time something applied for.","examples":[{"type":"AbnlkPeriodAttributes","effectiveFrom":"2026-08-19","effectiveTo":"2026-08-19"}],"type":"object","required":["type","effectiveFrom"],"properties":{"type":{"description":"Always `AbnlkPeriodAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["AbnlkPeriodAttributes"]},"effectiveFrom":{"type":"string","format":"date"},"effectiveTo":{"description":"Absent means it still applies.","type":"string","format":"date"}}},"AbnlkStatus":{"description":"The entity's registration status over time. More than one record means it has lapsed and resumed.","oneOf":[{"$ref":"#/components/schemas/AbnlkStatusAttributes"}],"discriminator":{"propertyName":"type","mapping":{"AbnlkStatusAttributes":"#/components/schemas/AbnlkStatusAttributes"}}},"AbnlkStatusAttributes":{"title":"AbnlkStatusAttributes","description":"A registration status, and when it applied.","examples":[{"type":"AbnlkStatusAttributes","code":"example","effectiveFrom":"2026-08-19","effectiveTo":"2026-08-19"}],"type":"object","required":["type","code","effectiveFrom"],"properties":{"type":{"description":"Always `AbnlkStatusAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["AbnlkStatusAttributes"]},"code":{"description":"The register's own status code, `ACT` for active, `CAN` for cancelled.","type":"string"},"effectiveFrom":{"type":"string","format":"date"},"effectiveTo":{"description":"When it stopped applying. Absent means it still does.","type":"string","format":"date"}}},"AbnlkView":{"description":"The resource that was created.","oneOf":[{"$ref":"#/components/schemas/AbnlkViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"AbnlkViewAttributes":"#/components/schemas/AbnlkViewAttributes"}}},"AbnlkViewAttributes":{"title":"AbnlkViewAttributes","description":"What the Australian Business Register says about an ABN. Every fact is effective-dated.","examples":[{"type":"AbnlkViewAttributes","abn":{"type":"AbnlkIdentifierAttributes","value":"example","currentIndicator":"example"},"lastUpdated":"2026-08-19","entityStatus":{"type":"AbnlkStatusAttributes","code":"example","effectiveFrom":"2026-08-19","effectiveTo":"2026-08-19"},"entityType":{"type":"AbnlkEntityTypeAttributes","code":"example","description":"A short description."},"gstStatus":{"type":"AbnlkPeriodAttributes","effectiveFrom":"2026-08-19","effectiveTo":"2026-08-19"},"asicNumber":"example","legalNames":[{"type":"AbnlkNameAttributes","name":"Ada Lovelace","effectiveFrom":"2026-08-19","effectiveTo":"2026-08-19"}],"tradingNames":[{"type":"AbnlkNameAttributes","name":"Ada Lovelace","effectiveFrom":"2026-08-19","effectiveTo":"2026-08-19"}],"locations":[{"type":"AbnlkLocationAttributes","state":"example","postcode":"3000","effectiveFrom":"2026-08-19","effectiveTo":"2026-08-19"}]}],"type":"object","required":["type","abn","lastUpdated","entityStatus","entityType"],"properties":{"type":{"description":"Always `AbnlkViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["AbnlkViewAttributes"]},"abn":{"$ref":"#/components/schemas/AbnlkIdentifier"},"lastUpdated":{"description":"When the register last revised this entity's record.","type":"string","format":"date"},"entityStatus":{"$ref":"#/components/schemas/AbnlkStatus"},"entityType":{"$ref":"#/components/schemas/AbnlkEntityType"},"gstStatus":{"$ref":"#/components/schemas/AbnlkPeriod"},"asicNumber":{"description":"The ASIC company number, where the entity has one.","type":"string"},"legalNames":{"description":"The entity's legal names over time.","type":"array","items":{"$ref":"#/components/schemas/AbnlkName"}},"tradingNames":{"description":"Its registered trading names over time. A business trades under these; it contracts under a legal name.","type":"array","items":{"$ref":"#/components/schemas/AbnlkName"}},"locations":{"description":"Where the entity does business, by state and postcode, over time.","type":"array","items":{"$ref":"#/components/schemas/AbnlkLocation"}}}},"ApgnumColumn":{"title":"ApgnumColumn","type":"string","enum":["Kind","Number","Id"]},"ApgnumKind":{"title":"ApgnumKind","type":"string","enum":["DailyCardFileRun","IssuerTransaction","LoanStatement","Merchant","StatementReceipt","StatementReceiptBatch","TravelBatch","TravelEntry","TravelFile","TravelUpload"]},"ApgnumPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/ApgnumPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"ApgnumPageAttributes":"#/components/schemas/ApgnumPageAttributes"}}},"ApgnumPageAttributes":{"title":"ApgnumPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"ApgnumPageAttributes","data":[{"type":"ApgnumViewAttributes","kind":"DailyCardFileRun","number":1250,"id":"abc123"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `ApgnumPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ApgnumPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/ApgnumView"}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"ApgnumView":{"description":"The record an APG number names: the kind of record, the number, and the identifier the record has on this API. Read the record at the resource of its kind with that identifier.","oneOf":[{"$ref":"#/components/schemas/ApgnumViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"ApgnumViewAttributes":"#/components/schemas/ApgnumViewAttributes"}}},"ApgnumViewAttributes":{"title":"ApgnumViewAttributes","description":"The record an APG number names: the kind of record, the number, and the identifier the record has on this API. Read the record at the resource of its kind with that identifier.","examples":[{"type":"ApgnumViewAttributes","kind":"DailyCardFileRun","number":1250,"id":"abc123"}],"type":"object","required":["type","kind","number","id"],"properties":{"type":{"description":"Always `ApgnumViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ApgnumViewAttributes"]},"kind":{"$ref":"#/components/schemas/ApgnumKind"},"number":{"description":"The APG number that was looked up, or that the record holds.","type":"integer","format":"int64"},"id":{"description":"The record's identifier on this API, such as `tvlent_...` for a travel entry or `mcht_...` for a merchant. A merchant's travel settings are read with the merchant's own identifier.","type":"string"}}},"ApiError":{"title":"ApiError","type":"object","required":["statusCode","errorCode","message"],"properties":{"statusCode":{"description":"HTTP status code for this error","type":"integer","format":"int32"},"errorCode":{"description":"An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.","type":"string"},"message":{"description":"Human readable description of the error","type":"string"},"tracer":{"description":"An unique identifier for the request. Provide this to the support team if you wish to query a particular error.","type":"string"},"detail":{"description":"Optional additional details for the error.","type":"string"},"errorTypeDescription":{"description":"A description of the category of errors for the given `statusCode`.","type":"string"},"metadata":{"description":"Optional key value list of metadata"}}},"ApiKeyAction":{"title":"ApiKeyAction","type":"string","enum":["Query","Search","ViewPII","Create","Upsert","UpsertMinimal","UpsertPlugin","Apply","Activate","Update","UpdatePermissions","Link","Delete","Verify","Impersonate","Simulate","Pay","Transfer","SpecifySurcharge","Orchestrate","Unknown"]},"ApiKeyCmd":{"oneOf":[{"$ref":"#/components/schemas/ApiKeyCmdCreate"}],"discriminator":{"propertyName":"type","mapping":{"ApiKeyCmdCreate":"#/components/schemas/ApiKeyCmdCreate"}}},"ApiKeyCmdCreate":{"title":"ApiKeyCmdCreate","description":"Issue a service token. The secret is returned once, in the response.","examples":[{"type":"ApiKeyCmdCreate","description":"A short description.","scope":{"type":"ApiKeyScopeEnterprise","enterpriseId":"ent_9f2Kd8QpLzXw"},"permissions":{"type":"ApiKeyPermissionsExplicit","grants":[{"type":"ApiKeyGrantAttributes","resource":"BlockedCard","actions":["Query"]}]},"expiresAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","description","scope","permissions"],"properties":{"type":{"description":"Always `ApiKeyCmdCreate`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ApiKeyCmdCreate"]},"description":{"description":"What the token is for. This is the only way to tell two secrets apart later, so make it specific.","type":"string"},"scope":{"$ref":"#/components/schemas/ApiKeyScope"},"permissions":{"$ref":"#/components/schemas/ApiKeyPermissions"},"expiresAt":{"description":"When it stops working. Omit for a token that does not expire.","type":"string","format":"date-time"}}},"ApiKeyColumn":{"title":"ApiKeyColumn","type":"string","enum":["ApiKeyId","Description","Status","Value","ExpiresAt","CreatedBy","CreatedAt","UpdatedAt"]},"ApiKeyCreateRsp":{"description":"A newly issued service token, and its secret.","oneOf":[{"$ref":"#/components/schemas/ApiKeyCreateRspIssued"}],"discriminator":{"propertyName":"type","mapping":{"ApiKeyCreateRspIssued":"#/components/schemas/ApiKeyCreateRspIssued"}}},"ApiKeyCreateRspIssued":{"title":"ApiKeyCreateRspIssued","description":"A newly issued service token, and its secret.","examples":[{"type":"ApiKeyCreateRspIssued","created":{"type":"ApiKeyViewAttributes","apiKeyId":"key_9f2Kd8QpLzXw","description":"A short description.","scope":{"type":"ApiKeyScopeEnterprise","enterpriseId":"ent_9f2Kd8QpLzXw"},"permissions":{"type":"ApiKeyPermissionsExplicit","grants":[{"type":"ApiKeyGrantAttributes","resource":"BlockedCard","actions":["Query"]}]},"status":"Enabled","value":"example","expiresAt":"2026-08-19T04:21:07Z","createdBy":"example","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"},"secret":"example"}],"type":"object","required":["type","created","secret"],"properties":{"type":{"description":"Always `ApiKeyCreateRspIssued`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ApiKeyCreateRspIssued"]},"created":{"$ref":"#/components/schemas/ApiKeyView","description":"The token as it will read from now on."},"secret":{"description":"The secret. Returned once, here, and never retrievable again, store it now.","type":"string"}}},"ApiKeyGrant":{"description":"What an API key permits: a set of actions on one resource.","oneOf":[{"$ref":"#/components/schemas/ApiKeyGrantAttributes"}],"discriminator":{"propertyName":"type","mapping":{"ApiKeyGrantAttributes":"#/components/schemas/ApiKeyGrantAttributes"}}},"ApiKeyGrantAttributes":{"title":"ApiKeyGrantAttributes","description":"What an API key permits: a set of actions on one resource.","examples":[{"type":"ApiKeyGrantAttributes","resource":"BlockedCard","actions":["Query"]}],"type":"object","required":["type","resource"],"properties":{"type":{"description":"Always `ApiKeyGrantAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ApiKeyGrantAttributes"]},"resource":{"$ref":"#/components/schemas/ApiKeyResource"},"actions":{"description":"The actions this grant allows on the resource.","type":"array","items":{"$ref":"#/components/schemas/ApiKeyAction"}}}},"ApiKeyId":{"title":"ApiKeyId","description":"Identifier of a service token.","examples":["key_9f2Kd8QpLzXw"],"type":"string"},"ApiKeyPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/ApiKeyPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"ApiKeyPageAttributes":"#/components/schemas/ApiKeyPageAttributes"}}},"ApiKeyPageAttributes":{"title":"ApiKeyPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"ApiKeyPageAttributes","data":[{"type":"ApiKeyViewAttributes","apiKeyId":"key_9f2Kd8QpLzXw","description":"A short description.","scope":{"type":"ApiKeyScopeEnterprise","enterpriseId":"ent_9f2Kd8QpLzXw"},"permissions":{"type":"ApiKeyPermissionsExplicit","grants":[{"type":"ApiKeyGrantAttributes","resource":"BlockedCard","actions":["Query"]}]},"status":"Enabled","value":"example","expiresAt":"2026-08-19T04:21:07Z","createdBy":"example","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `ApiKeyPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ApiKeyPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/ApiKeyView","description":"A credential a backend service authenticates with."}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"ApiKeyPermissions":{"oneOf":[{"$ref":"#/components/schemas/ApiKeyPermissionsExplicit"},{"$ref":"#/components/schemas/ApiKeyPermissionsStandard"}],"discriminator":{"propertyName":"type","mapping":{"ApiKeyPermissionsExplicit":"#/components/schemas/ApiKeyPermissionsExplicit","ApiKeyPermissionsStandard":"#/components/schemas/ApiKeyPermissionsStandard"}}},"ApiKeyPermissionsExplicit":{"title":"ApiKeyPermissionsExplicit","description":"Only these actions, on only these resources. Cannot grant anything the issuing credential lacks.","examples":[{"type":"ApiKeyPermissionsExplicit","grants":[{"type":"ApiKeyGrantAttributes","resource":"BlockedCard","actions":["Query"]}]}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `ApiKeyPermissionsExplicit`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ApiKeyPermissionsExplicit"]},"grants":{"type":"array","items":{"$ref":"#/components/schemas/ApiKeyGrant"}}}},"ApiKeyPermissionsStandard":{"title":"ApiKeyPermissionsStandard","description":"Everything the issuing credential's own policy allows. The token is as capable as its issuer, and no more.","examples":[{"type":"ApiKeyPermissionsStandard"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `ApiKeyPermissionsStandard`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ApiKeyPermissionsStandard"]}}},"ApiKeyResource":{"title":"ApiKeyResource","description":"The resource this grant is over.","type":"string","enum":["BlockedCard","CustomerDelegates","Disputes","Enterprises","Files","FxRates","LoanFacilities","LoanProducts","LoanTransactions","LoanMasterAgreements","Loans","LoanStatements","CreditCards","Marketplaces","MarketplaceUsers","Merchants","MerchantCustomers","MerchantKYB","MerchantPaymentProfiles","MerchantFinancials","MerchantBillingPaymentSource","MerchantState","MerchantUsers","Orders","CustomerPaymentSources","TemporaryPaymentSources","PaymentTokens","PayCards","PayPlans","PayToAgreements","Reports","Queues","Simulations","Refunds","MerchantServiceTokens","MarketplaceServiceTokens","EnterpriseServiceTokens","SourceVerifications","SystemJournals","SystemJournalEntries","SystemLedgers","SystemLedgerEntries","Transactions","IssuerTransactions","IssuerTransactionDiscrepancies","WebhookMerchantSubscriptions","WebhookMarketplaceSubscriptions","WebhookSubscriptions","Sessions","ServiceTokens","ReferenceData","Users","Roles","OidcIdps","ReportsAcquiring","ReportsLending","ReportsIssuing","ReportsCustomers","ReportsOperations","ReportsOversight","Organisations","Persons","Suppliers","Rules","MerchantStatementPasswords","MerchantTravelData","Unknown"]},"ApiKeyScope":{"oneOf":[{"$ref":"#/components/schemas/ApiKeyScopeEnterprise"},{"$ref":"#/components/schemas/ApiKeyScopeMarketplace"},{"$ref":"#/components/schemas/ApiKeyScopeMerchantPublishable"},{"$ref":"#/components/schemas/ApiKeyScopeMerchantSecret"}],"discriminator":{"propertyName":"type","mapping":{"ApiKeyScopeEnterprise":"#/components/schemas/ApiKeyScopeEnterprise","ApiKeyScopeMarketplace":"#/components/schemas/ApiKeyScopeMarketplace","ApiKeyScopeMerchantPublishable":"#/components/schemas/ApiKeyScopeMerchantPublishable","ApiKeyScopeMerchantSecret":"#/components/schemas/ApiKeyScopeMerchantSecret"}}},"ApiKeyScopeEnterprise":{"title":"ApiKeyScopeEnterprise","description":"An enterprise's key. Reaches every marketplace and merchant in the enterprise.","examples":[{"type":"ApiKeyScopeEnterprise","enterpriseId":"ent_9f2Kd8QpLzXw"}],"type":"object","required":["type","enterpriseId"],"properties":{"type":{"description":"Always `ApiKeyScopeEnterprise`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ApiKeyScopeEnterprise"]},"enterpriseId":{"$ref":"#/components/schemas/EntId","description":"Identifier of an enterprise."}}},"ApiKeyScopeMarketplace":{"title":"ApiKeyScopeMarketplace","description":"A marketplace's key. Reaches every merchant in the marketplace.","examples":[{"type":"ApiKeyScopeMarketplace","marketplaceId":"mktp_9f2Kd8QpLzXw"}],"type":"object","required":["type","marketplaceId"],"properties":{"type":{"description":"Always `ApiKeyScopeMarketplace`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ApiKeyScopeMarketplace"]},"marketplaceId":{"$ref":"#/components/schemas/MktpId","description":"Identifier of a marketplace."}}},"ApiKeyScopeMerchantPublishable":{"title":"ApiKeyScopeMerchantPublishable","description":"A merchant's publishable key, safe to put in a browser. Its value is returned on every read.","examples":[{"type":"ApiKeyScopeMerchantPublishable","merchantId":"mcht_9f2Kd8QpLzXw"}],"type":"object","required":["type","merchantId"],"properties":{"type":{"description":"Always `ApiKeyScopeMerchantPublishable`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ApiKeyScopeMerchantPublishable"]},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"Identifier of a merchant."}}},"ApiKeyScopeMerchantSecret":{"title":"ApiKeyScopeMerchantSecret","description":"A merchant's secret key.","examples":[{"type":"ApiKeyScopeMerchantSecret","merchantId":"mcht_9f2Kd8QpLzXw"}],"type":"object","required":["type","merchantId"],"properties":{"type":{"description":"Always `ApiKeyScopeMerchantSecret`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ApiKeyScopeMerchantSecret"]},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"Identifier of a merchant."}}},"ApiKeySort":{"title":"ApiKeySort","type":"string","enum":["createdAt","-createdAt","updatedAt","-updatedAt"]},"ApiKeyStatus":{"title":"ApiKeyStatus","type":"string","enum":["Enabled","Disabled","Unknown"]},"ApiKeyType":{"title":"ApiKeyType","type":"string","enum":["MerchantPublishable","MerchantSecret","MarketplaceKey","EnterpriseKey","Unknown"]},"ApiKeyUpdate":{"oneOf":[{"$ref":"#/components/schemas/ApiKeyUpdateDescription"},{"$ref":"#/components/schemas/ApiKeyUpdateExpiration"},{"$ref":"#/components/schemas/ApiKeyUpdatePermissions"},{"$ref":"#/components/schemas/ApiKeyUpdateStatus"}],"discriminator":{"propertyName":"type","mapping":{"ApiKeyUpdateDescription":"#/components/schemas/ApiKeyUpdateDescription","ApiKeyUpdateExpiration":"#/components/schemas/ApiKeyUpdateExpiration","ApiKeyUpdatePermissions":"#/components/schemas/ApiKeyUpdatePermissions","ApiKeyUpdateStatus":"#/components/schemas/ApiKeyUpdateStatus"}}},"ApiKeyUpdateDescription":{"title":"ApiKeyUpdateDescription","description":"Change what the token is for.","examples":[{"type":"ApiKeyUpdateDescription","description":"A short description."}],"type":"object","required":["type","description"],"properties":{"type":{"description":"Always `ApiKeyUpdateDescription`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ApiKeyUpdateDescription"]},"description":{"type":"string"}}},"ApiKeyUpdateExpiration":{"title":"ApiKeyUpdateExpiration","description":"Change when it stops working. Omit the date for a token that does not expire.","examples":[{"type":"ApiKeyUpdateExpiration","expiresAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `ApiKeyUpdateExpiration`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ApiKeyUpdateExpiration"]},"expiresAt":{"type":"string","format":"date-time"}}},"ApiKeyUpdatePermissions":{"title":"ApiKeyUpdatePermissions","description":"Replace what the token is allowed to do. Send the whole set, this is not a merge.","examples":[{"type":"ApiKeyUpdatePermissions","permissions":{"type":"ApiKeyPermissionsExplicit","grants":[{"type":"ApiKeyGrantAttributes","resource":"BlockedCard","actions":["Query"]}]}}],"type":"object","required":["type","permissions"],"properties":{"type":{"description":"Always `ApiKeyUpdatePermissions`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ApiKeyUpdatePermissions"]},"permissions":{"$ref":"#/components/schemas/ApiKeyPermissions"}}},"ApiKeyUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/ApiKeyUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"ApiKeyUpdateRspAttributes":"#/components/schemas/ApiKeyUpdateRspAttributes"}}},"ApiKeyUpdateRspAttributes":{"title":"ApiKeyUpdateRspAttributes","examples":[{"type":"ApiKeyUpdateRspAttributes","updated":{"type":"ApiKeyViewAttributes","apiKeyId":"key_9f2Kd8QpLzXw","description":"A short description.","scope":{"type":"ApiKeyScopeEnterprise","enterpriseId":"ent_9f2Kd8QpLzXw"},"permissions":{"type":"ApiKeyPermissionsExplicit","grants":[{"type":"ApiKeyGrantAttributes","resource":"BlockedCard","actions":["Query"]}]},"status":"Enabled","value":"example","expiresAt":"2026-08-19T04:21:07Z","createdBy":"example","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `ApiKeyUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ApiKeyUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/ApiKeyView","description":"The resource as it stands after the change."}}},"ApiKeyUpdateStatus":{"title":"ApiKeyUpdateStatus","description":"Turn the token off or back on. Reversible, unlike issuing a new one.","examples":[{"type":"ApiKeyUpdateStatus","status":"Enabled"}],"type":"object","required":["type","status"],"properties":{"type":{"description":"Always `ApiKeyUpdateStatus`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ApiKeyUpdateStatus"]},"status":{"$ref":"#/components/schemas/ApiKeyStatus"}}},"ApiKeyView":{"oneOf":[{"$ref":"#/components/schemas/ApiKeyViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"ApiKeyViewAttributes":"#/components/schemas/ApiKeyViewAttributes"}}},"ApiKeyViewAttributes":{"title":"ApiKeyViewAttributes","description":"A credential a backend service authenticates with.","examples":[{"type":"ApiKeyViewAttributes","apiKeyId":"key_9f2Kd8QpLzXw","description":"A short description.","scope":{"type":"ApiKeyScopeEnterprise","enterpriseId":"ent_9f2Kd8QpLzXw"},"permissions":{"type":"ApiKeyPermissionsExplicit","grants":[{"type":"ApiKeyGrantAttributes","resource":"BlockedCard","actions":["Query"]}]},"status":"Enabled","value":"example","expiresAt":"2026-08-19T04:21:07Z","createdBy":"example","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","apiKeyId","description","scope","permissions","status","createdAt","updatedAt"],"properties":{"type":{"description":"Always `ApiKeyViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ApiKeyViewAttributes"]},"apiKeyId":{"$ref":"#/components/schemas/ApiKeyId"},"description":{"description":"What the token is for, in words. This is how you tell two secrets apart, there is nothing else.","type":"string"},"scope":{"$ref":"#/components/schemas/ApiKeyScope"},"permissions":{"$ref":"#/components/schemas/ApiKeyPermissions"},"status":{"$ref":"#/components/schemas/ApiKeyStatus"},"value":{"description":"The token itself, where the platform holds it in the clear, always for a publishable key, and for a merchant secret key too, which is how a dashboard shows a merchant its own. A token stored as a salted hash is never returned. Treat this field as sensitive on every read.","type":"string"},"expiresAt":{"type":"string","format":"date-time"},"createdBy":{"description":"The user who created it. Absent for tokens the platform generated itself.","type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"AtknCmd":{"oneOf":[{"$ref":"#/components/schemas/AtknCmdExchange"},{"$ref":"#/components/schemas/AtknCmdInspect"},{"$ref":"#/components/schemas/AtknCmdIssue"}],"discriminator":{"propertyName":"type","mapping":{"AtknCmdExchange":"#/components/schemas/AtknCmdExchange","AtknCmdInspect":"#/components/schemas/AtknCmdInspect","AtknCmdIssue":"#/components/schemas/AtknCmdIssue"}}},"AtknCmdExchange":{"title":"AtknCmdExchange","description":"Exchange a customer auth token for a bearer. Answers `AtknViewExchanged`.","examples":[{"type":"AtknCmdExchange","token":"tok_9f2Kd8QpLzXwR4mN"}],"type":"object","required":["type","token"],"properties":{"type":{"description":"Always `AtknCmdExchange`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["AtknCmdExchange"]},"token":{"description":"The customer auth token. Sent in the body, never in a URL.","type":"string"}}},"AtknCmdInspect":{"title":"AtknCmdInspect","description":"Ask whether a token is still good, and whose it is. Answers `AtknViewInspected`.","examples":[{"type":"AtknCmdInspect","token":"tok_9f2Kd8QpLzXwR4mN"}],"type":"object","required":["type","token"],"properties":{"type":{"description":"Always `AtknCmdInspect`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["AtknCmdInspect"]},"token":{"description":"The token from the link. Sent in the body, never in a URL.","type":"string"}}},"AtknCmdIssue":{"title":"AtknCmdIssue","description":"Mint an auth token for a user. Answers `AtknViewIssued`. Administrator credentials only.","examples":[{"type":"AtknCmdIssue","subject":{"type":"AtknSubjectAdmin","emailAddress":"ada@example.com"}}],"type":"object","required":["type","subject"],"properties":{"type":{"description":"Always `AtknCmdIssue`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["AtknCmdIssue"]},"subject":{"$ref":"#/components/schemas/AtknSubject","description":"Who the token is for."}}},"AtknCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/AtknCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"AtknCreateRspAttributes":"#/components/schemas/AtknCreateRspAttributes"}}},"AtknCreateRspAttributes":{"title":"AtknCreateRspAttributes","examples":[{"type":"AtknCreateRspAttributes","created":{"type":"AtknViewExchanged","state":"Valid","emailAddress":"ada@example.com","customToken":"tok_9f2Kd8QpLzXwR4mN"}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `AtknCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["AtknCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/AtknView"}}},"AtknState":{"title":"AtknState","type":"string","enum":["Valid","Invalid","Expired","Unknown"]},"AtknSubject":{"oneOf":[{"$ref":"#/components/schemas/AtknSubjectAdmin"},{"$ref":"#/components/schemas/AtknSubjectMarketplaceStaff"},{"$ref":"#/components/schemas/AtknSubjectMerchantCustomer"},{"$ref":"#/components/schemas/AtknSubjectMerchantStaff"}],"discriminator":{"propertyName":"type","mapping":{"AtknSubjectAdmin":"#/components/schemas/AtknSubjectAdmin","AtknSubjectMarketplaceStaff":"#/components/schemas/AtknSubjectMarketplaceStaff","AtknSubjectMerchantCustomer":"#/components/schemas/AtknSubjectMerchantCustomer","AtknSubjectMerchantStaff":"#/components/schemas/AtknSubjectMerchantStaff"}}},"AtknSubjectAdmin":{"title":"AtknSubjectAdmin","description":"An APG Pay administrator.","examples":[{"type":"AtknSubjectAdmin","emailAddress":"ada@example.com"}],"type":"object","required":["type","emailAddress"],"properties":{"type":{"description":"Always `AtknSubjectAdmin`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["AtknSubjectAdmin"]},"emailAddress":{"type":"string"}}},"AtknSubjectMarketplaceStaff":{"title":"AtknSubjectMarketplaceStaff","description":"A marketplace dashboard user.","examples":[{"type":"AtknSubjectMarketplaceStaff","marketplaceId":"mktp_9f2Kd8QpLzXw","emailAddress":"ada@example.com"}],"type":"object","required":["type","marketplaceId","emailAddress"],"properties":{"type":{"description":"Always `AtknSubjectMarketplaceStaff`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["AtknSubjectMarketplaceStaff"]},"marketplaceId":{"$ref":"#/components/schemas/MktpId","description":"Identifier of a marketplace."},"emailAddress":{"type":"string"}}},"AtknSubjectMerchantCustomer":{"title":"AtknSubjectMerchantCustomer","description":"A merchant's customer.","examples":[{"type":"AtknSubjectMerchantCustomer","merchantId":"mcht_9f2Kd8QpLzXw","emailAddress":"ada@example.com"}],"type":"object","required":["type","merchantId","emailAddress"],"properties":{"type":{"description":"Always `AtknSubjectMerchantCustomer`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["AtknSubjectMerchantCustomer"]},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"Identifier of a merchant."},"emailAddress":{"type":"string"}}},"AtknSubjectMerchantStaff":{"title":"AtknSubjectMerchantStaff","description":"A merchant dashboard user.","examples":[{"type":"AtknSubjectMerchantStaff","merchantId":"mcht_9f2Kd8QpLzXw","emailAddress":"ada@example.com"}],"type":"object","required":["type","merchantId","emailAddress"],"properties":{"type":{"description":"Always `AtknSubjectMerchantStaff`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["AtknSubjectMerchantStaff"]},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"Identifier of a merchant."},"emailAddress":{"type":"string"}}},"AtknView":{"description":"The resource that was created.","oneOf":[{"$ref":"#/components/schemas/AtknViewExchanged"},{"$ref":"#/components/schemas/AtknViewInspected"},{"$ref":"#/components/schemas/AtknViewIssued"}],"discriminator":{"propertyName":"type","mapping":{"AtknViewExchanged":"#/components/schemas/AtknViewExchanged","AtknViewInspected":"#/components/schemas/AtknViewInspected","AtknViewIssued":"#/components/schemas/AtknViewIssued"}}},"AtknViewExchanged":{"title":"AtknViewExchanged","description":"A customer auth token, exchanged. Answers even when the token was bad, check `state`.","examples":[{"type":"AtknViewExchanged","state":"Valid","emailAddress":"ada@example.com","customToken":"tok_9f2Kd8QpLzXwR4mN"}],"type":"object","required":["type","state"],"properties":{"type":{"description":"Always `AtknViewExchanged`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["AtknViewExchanged"]},"state":{"$ref":"#/components/schemas/AtknState","description":"Whether the token was usable. `Invalid` and `Expired` both answer `200` with no `customToken`."},"emailAddress":{"description":"The customer's email address. Present when the token was valid or merely expired.","type":"string"},"customToken":{"description":"A bearer for the customer's session, despite the name, present it directly. Present only when the token was valid and unexpired.","type":"string"}}},"AtknViewInspected":{"title":"AtknViewInspected","description":"What an auth token says about itself.","examples":[{"type":"AtknViewInspected","state":"Valid","subject":{"type":"AtknSubjectAdmin","emailAddress":"ada@example.com"},"emailAddress":"ada@example.com","expired":true,"signedInBefore":true}],"type":"object","required":["type","state","subject","emailAddress","expired","signedInBefore"],"properties":{"type":{"description":"Always `AtknViewInspected`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["AtknViewInspected"]},"state":{"$ref":"#/components/schemas/AtknState","description":"Whether the token is usable, stale, or not ours at all. A tampered token never reaches here, that is a `401`."},"subject":{"$ref":"#/components/schemas/AtknSubject","description":"Who it is for."},"emailAddress":{"type":"string"},"expired":{"description":"Whether it has passed its expiry. Separate from `state` because a caller offering to resend the link needs exactly this.","type":"boolean"},"signedInBefore":{"description":"Whether the user has ever signed in. `false` means this is an invitation rather than a password reset.","type":"boolean"}}},"AtknViewIssued":{"title":"AtknViewIssued","description":"A freshly minted auth token. Returned once, there is no way to read it back.","examples":[{"type":"AtknViewIssued","token":"tok_9f2Kd8QpLzXwR4mN"}],"type":"object","required":["type","token"],"properties":{"type":{"description":"Always `AtknViewIssued`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["AtknViewIssued"]},"token":{"description":"The token. Treat it as a credential; it is delivered to the user inside a link.","type":"string"}}},"AuthtypeCmd":{"oneOf":[{"$ref":"#/components/schemas/AuthtypeCmdCreate"}],"discriminator":{"propertyName":"type","mapping":{"AuthtypeCmdCreate":"#/components/schemas/AuthtypeCmdCreate"}}},"AuthtypeCmdCreate":{"title":"AuthtypeCmdCreate","description":"Map a login-capable permission domain to the authentication type its users use.","examples":[{"type":"AuthtypeCmdCreate","permissionDomain":{"type":"AuthtypeDomainCustomer","customerId":"cust_9f2Kd8QpLzXw"},"authenticationType":{"type":"AuthtypeMethodBuiltIn"}}],"type":"object","required":["type","permissionDomain","authenticationType"],"properties":{"type":{"description":"Always `AuthtypeCmdCreate`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["AuthtypeCmdCreate"]},"permissionDomain":{"$ref":"#/components/schemas/AuthtypeDomain"},"authenticationType":{"$ref":"#/components/schemas/AuthtypeMethod"}}},"AuthtypeColumn":{"title":"AuthtypeColumn","type":"string","enum":["AuthTypeId","CreatedAt","UpdatedAt"]},"AuthtypeCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/AuthtypeCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"AuthtypeCreateRspAttributes":"#/components/schemas/AuthtypeCreateRspAttributes"}}},"AuthtypeCreateRspAttributes":{"title":"AuthtypeCreateRspAttributes","examples":[{"type":"AuthtypeCreateRspAttributes","created":{"type":"AuthtypeViewAttributes","authTypeId":"pdauth_9f2Kd8QpLzXw","permissionDomain":{"type":"AuthtypeDomainCustomer","customerId":"cust_9f2Kd8QpLzXw"},"authenticationType":{"type":"AuthtypeMethodBuiltIn"},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `AuthtypeCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["AuthtypeCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/AuthtypeView","description":"The resource that was created."}}},"AuthtypeDomain":{"oneOf":[{"$ref":"#/components/schemas/AuthtypeDomainCustomer"},{"$ref":"#/components/schemas/AuthtypeDomainDelegate"},{"$ref":"#/components/schemas/AuthtypeDomainEnterprise"},{"$ref":"#/components/schemas/AuthtypeDomainMarketplace"},{"$ref":"#/components/schemas/AuthtypeDomainMerchant"},{"$ref":"#/components/schemas/AuthtypeDomainRoot"}],"discriminator":{"propertyName":"type","mapping":{"AuthtypeDomainCustomer":"#/components/schemas/AuthtypeDomainCustomer","AuthtypeDomainDelegate":"#/components/schemas/AuthtypeDomainDelegate","AuthtypeDomainEnterprise":"#/components/schemas/AuthtypeDomainEnterprise","AuthtypeDomainMarketplace":"#/components/schemas/AuthtypeDomainMarketplace","AuthtypeDomainMerchant":"#/components/schemas/AuthtypeDomainMerchant","AuthtypeDomainRoot":"#/components/schemas/AuthtypeDomainRoot"}}},"AuthtypeDomainCustomer":{"title":"AuthtypeDomainCustomer","description":"One customer.","examples":[{"type":"AuthtypeDomainCustomer","customerId":"cust_9f2Kd8QpLzXw"}],"type":"object","required":["type","customerId"],"properties":{"type":{"description":"Always `AuthtypeDomainCustomer`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["AuthtypeDomainCustomer"]},"customerId":{"$ref":"#/components/schemas/CustId","description":"Identifier of a customer."}}},"AuthtypeDomainDelegate":{"title":"AuthtypeDomainDelegate","description":"A delegate acting for one customer.","examples":[{"type":"AuthtypeDomainDelegate","delegateId":"custd_9f2Kd8QpLzXw","forCustomerId":"cust_9f2Kd8QpLzXw"}],"type":"object","required":["type","delegateId","forCustomerId"],"properties":{"type":{"description":"Always `AuthtypeDomainDelegate`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["AuthtypeDomainDelegate"]},"delegateId":{"$ref":"#/components/schemas/CustdId"},"forCustomerId":{"$ref":"#/components/schemas/CustId","description":"Identifier of a customer."}}},"AuthtypeDomainEnterprise":{"title":"AuthtypeDomainEnterprise","description":"One enterprise.","examples":[{"type":"AuthtypeDomainEnterprise","enterpriseId":"ent_9f2Kd8QpLzXw"}],"type":"object","required":["type","enterpriseId"],"properties":{"type":{"description":"Always `AuthtypeDomainEnterprise`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["AuthtypeDomainEnterprise"]},"enterpriseId":{"$ref":"#/components/schemas/EntId","description":"Identifier of an enterprise."}}},"AuthtypeDomainMarketplace":{"title":"AuthtypeDomainMarketplace","description":"One marketplace.","examples":[{"type":"AuthtypeDomainMarketplace","marketplaceId":"mktp_9f2Kd8QpLzXw"}],"type":"object","required":["type","marketplaceId"],"properties":{"type":{"description":"Always `AuthtypeDomainMarketplace`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["AuthtypeDomainMarketplace"]},"marketplaceId":{"$ref":"#/components/schemas/MktpId","description":"Identifier of a marketplace."}}},"AuthtypeDomainMerchant":{"title":"AuthtypeDomainMerchant","description":"One merchant.","examples":[{"type":"AuthtypeDomainMerchant","merchantId":"mcht_9f2Kd8QpLzXw"}],"type":"object","required":["type","merchantId"],"properties":{"type":{"description":"Always `AuthtypeDomainMerchant`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["AuthtypeDomainMerchant"]},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"Identifier of a merchant."}}},"AuthtypeDomainRoot":{"title":"AuthtypeDomainRoot","description":"The whole platform.","examples":[{"type":"AuthtypeDomainRoot"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `AuthtypeDomainRoot`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["AuthtypeDomainRoot"]}}},"AuthtypeId":{"title":"AuthtypeId","description":"Identifier of an authentication-type mapping.","examples":["pdauth_9f2Kd8QpLzXw"],"type":"string"},"AuthtypeMethod":{"oneOf":[{"$ref":"#/components/schemas/AuthtypeMethodBuiltIn"},{"$ref":"#/components/schemas/AuthtypeMethodOidcProvider"}],"discriminator":{"propertyName":"type","mapping":{"AuthtypeMethodBuiltIn":"#/components/schemas/AuthtypeMethodBuiltIn","AuthtypeMethodOidcProvider":"#/components/schemas/AuthtypeMethodOidcProvider"}}},"AuthtypeMethodBuiltIn":{"title":"AuthtypeMethodBuiltIn","description":"The platform verifies the credential itself, a password, a service-token secret, a magic-link HMAC.","examples":[{"type":"AuthtypeMethodBuiltIn"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `AuthtypeMethodBuiltIn`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["AuthtypeMethodBuiltIn"]}}},"AuthtypeMethodOidcProvider":{"title":"AuthtypeMethodOidcProvider","description":"Users are sent to an external OIDC provider.","examples":[{"type":"AuthtypeMethodOidcProvider","oidcProviderId":"oidcidp_9f2Kd8QpLzXw"}],"type":"object","required":["type","oidcProviderId"],"properties":{"type":{"description":"Always `AuthtypeMethodOidcProvider`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["AuthtypeMethodOidcProvider"]},"oidcProviderId":{"$ref":"#/components/schemas/OidcidpId"}}},"AuthtypePage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/AuthtypePageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"AuthtypePageAttributes":"#/components/schemas/AuthtypePageAttributes"}}},"AuthtypePageAttributes":{"title":"AuthtypePageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"AuthtypePageAttributes","data":[{"type":"AuthtypeViewAttributes","authTypeId":"pdauth_9f2Kd8QpLzXw","permissionDomain":{"type":"AuthtypeDomainCustomer","customerId":"cust_9f2Kd8QpLzXw"},"authenticationType":{"type":"AuthtypeMethodBuiltIn"},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `AuthtypePageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["AuthtypePageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/AuthtypeView","description":"How the users of one permission domain sign in."}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"AuthtypeSort":{"title":"AuthtypeSort","type":"string","enum":["createdAt","-createdAt","updatedAt","-updatedAt"]},"AuthtypeUpdate":{"description":"Change how a permission domain's users sign in.","oneOf":[{"$ref":"#/components/schemas/AuthtypeUpdateAttributes"}],"discriminator":{"propertyName":"type","mapping":{"AuthtypeUpdateAttributes":"#/components/schemas/AuthtypeUpdateAttributes"}}},"AuthtypeUpdateAttributes":{"title":"AuthtypeUpdateAttributes","description":"Change how a permission domain's users sign in.","examples":[{"type":"AuthtypeUpdateAttributes","authenticationType":{"type":"AuthtypeMethodBuiltIn"}}],"type":"object","required":["type","authenticationType"],"properties":{"type":{"description":"Always `AuthtypeUpdateAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["AuthtypeUpdateAttributes"]},"authenticationType":{"$ref":"#/components/schemas/AuthtypeMethod"}}},"AuthtypeUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/AuthtypeUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"AuthtypeUpdateRspAttributes":"#/components/schemas/AuthtypeUpdateRspAttributes"}}},"AuthtypeUpdateRspAttributes":{"title":"AuthtypeUpdateRspAttributes","examples":[{"type":"AuthtypeUpdateRspAttributes","updated":{"type":"AuthtypeViewAttributes","authTypeId":"pdauth_9f2Kd8QpLzXw","permissionDomain":{"type":"AuthtypeDomainCustomer","customerId":"cust_9f2Kd8QpLzXw"},"authenticationType":{"type":"AuthtypeMethodBuiltIn"},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `AuthtypeUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["AuthtypeUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/AuthtypeView","description":"The resource as it stands after the change."}}},"AuthtypeView":{"oneOf":[{"$ref":"#/components/schemas/AuthtypeViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"AuthtypeViewAttributes":"#/components/schemas/AuthtypeViewAttributes"}}},"AuthtypeViewAttributes":{"title":"AuthtypeViewAttributes","description":"How the users of one permission domain sign in.","examples":[{"type":"AuthtypeViewAttributes","authTypeId":"pdauth_9f2Kd8QpLzXw","permissionDomain":{"type":"AuthtypeDomainCustomer","customerId":"cust_9f2Kd8QpLzXw"},"authenticationType":{"type":"AuthtypeMethodBuiltIn"},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","authTypeId","permissionDomain","authenticationType","createdAt","updatedAt"],"properties":{"type":{"description":"Always `AuthtypeViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["AuthtypeViewAttributes"]},"authTypeId":{"$ref":"#/components/schemas/AuthtypeId"},"permissionDomain":{"$ref":"#/components/schemas/AuthtypeDomain","description":"The domain these users belong to."},"authenticationType":{"$ref":"#/components/schemas/AuthtypeMethod"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"BalColumn":{"title":"BalColumn","type":"string"},"BalGatewayAmounts":{"description":"What a gateway is holding. Both in the single currency given here.","oneOf":[{"$ref":"#/components/schemas/BalGatewayAmountsAttributes"}],"discriminator":{"propertyName":"type","mapping":{"BalGatewayAmountsAttributes":"#/components/schemas/BalGatewayAmountsAttributes"}}},"BalGatewayAmountsAttributes":{"title":"BalGatewayAmountsAttributes","description":"What a gateway is holding. Both in the single currency given here.","examples":[{"type":"BalGatewayAmountsAttributes","currency":"AUD","available":1250,"pending":1250}],"type":"object","required":["type","currency","available","pending"],"properties":{"type":{"description":"Always `BalGatewayAmountsAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["BalGatewayAmountsAttributes"]},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"available":{"$ref":"#/components/schemas/MinorUnits","description":"Settled at the gateway."},"pending":{"$ref":"#/components/schemas/MinorUnits","description":"Taken but not yet settled at the gateway."}}},"BalLedgerAmounts":{"description":"What the platform's books hold. All in the single currency given here.","oneOf":[{"$ref":"#/components/schemas/BalLedgerAmountsAttributes"}],"discriminator":{"propertyName":"type","mapping":{"BalLedgerAmountsAttributes":"#/components/schemas/BalLedgerAmountsAttributes"}}},"BalLedgerAmountsAttributes":{"title":"BalLedgerAmountsAttributes","description":"What the platform's books hold. All in the single currency given here.","examples":[{"type":"BalLedgerAmountsAttributes","currency":"AUD","available":1250,"inTransit":1250,"pending":1250}],"type":"object","required":["type","currency","available","inTransit","pending"],"properties":{"type":{"description":"Always `BalLedgerAmountsAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["BalLedgerAmountsAttributes"]},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"available":{"$ref":"#/components/schemas/MinorUnits","description":"On the ledger and not yet disbursed or invoiced. This is what a payout can draw on."},"inTransit":{"$ref":"#/components/schemas/MinorUnits","description":"Deducted from the ledger for a payout that has not yet landed."},"pending":{"$ref":"#/components/schemas/MinorUnits","description":"In linked journals and not yet cleared."}}},"BalPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/BalPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"BalPageAttributes":"#/components/schemas/BalPageAttributes"}}},"BalPageAttributes":{"title":"BalPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"BalPageAttributes","data":[{"type":"BalViewGateway","merchantId":"mcht_9f2Kd8QpLzXw","gateway":"example","amounts":{"type":"BalGatewayAmountsAttributes","currency":"AUD","available":1250,"pending":1250}}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `BalPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["BalPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/BalView"}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"BalView":{"oneOf":[{"$ref":"#/components/schemas/BalViewGateway"},{"$ref":"#/components/schemas/BalViewLedger"}],"discriminator":{"propertyName":"type","mapping":{"BalViewGateway":"#/components/schemas/BalViewGateway","BalViewLedger":"#/components/schemas/BalViewLedger"}}},"BalViewGateway":{"title":"BalViewGateway","description":"What one connected payment gateway is holding for a merchant.","examples":[{"type":"BalViewGateway","merchantId":"mcht_9f2Kd8QpLzXw","gateway":"example","amounts":{"type":"BalGatewayAmountsAttributes","currency":"AUD","available":1250,"pending":1250}}],"type":"object","required":["type","merchantId","gateway","amounts"],"properties":{"type":{"description":"Always `BalViewGateway`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["BalViewGateway"]},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"Identifier of a merchant."},"gateway":{"description":"Which gateway, as the platform names it.","type":"string"},"amounts":{"$ref":"#/components/schemas/BalGatewayAmounts"}}},"BalViewLedger":{"title":"BalViewLedger","description":"What the platform's own books hold for a merchant, in its trading currency.","examples":[{"type":"BalViewLedger","merchantId":"mcht_9f2Kd8QpLzXw","amounts":{"type":"BalLedgerAmountsAttributes","currency":"AUD","available":1250,"inTransit":1250,"pending":1250}}],"type":"object","required":["type","merchantId","amounts"],"properties":{"type":{"description":"Always `BalViewLedger`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["BalViewLedger"]},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"Identifier of a merchant."},"amounts":{"$ref":"#/components/schemas/BalLedgerAmounts"}}},"BcardColumn":{"title":"BcardColumn","type":"string","enum":["BlockedCardId","MerchantId","MarketplaceId","CustomerId","TransactionId","SourceId","CardLast4","CardBin","CardBrand","CardFunding","CardExpiryMonth","CardExpiryYear","CardIssuerCountry","CardIssuer","Blocked","Event","Reason","PayerMessage","CreatedAt"]},"BcardDetails":{"description":"The card as it was when the block was raised.","oneOf":[{"$ref":"#/components/schemas/BcardDetailsAttributes"}],"discriminator":{"propertyName":"type","mapping":{"BcardDetailsAttributes":"#/components/schemas/BcardDetailsAttributes"}}},"BcardDetailsAttributes":{"title":"BcardDetailsAttributes","description":"The card as it was when the block was raised.","examples":[{"type":"BcardDetailsAttributes","last4":"4242","bin":"424242","brand":"Visa","funding":"Credit","expiryMonth":6,"expiryYear":2029,"issuerCountry":"AU","issuer":"example"}],"type":"object","required":["type","last4","bin","brand","funding","expiryMonth","expiryYear","issuer"],"properties":{"type":{"description":"Always `BcardDetailsAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["BcardDetailsAttributes"]},"last4":{"description":"Last four digits of the card number.","type":"string"},"bin":{"description":"Issuer identification number, the leading digits of the card number.","type":"string"},"brand":{"$ref":"#/components/schemas/CardBrand"},"funding":{"$ref":"#/components/schemas/CardFunding"},"expiryMonth":{"type":"integer","format":"int32"},"expiryYear":{"type":"integer","format":"int32"},"issuerCountry":{"$ref":"#/components/schemas/IsoCountry","description":"Where the card was issued. Absent where the platform could not resolve it."},"issuer":{"description":"The issuing bank, as the BIN lookup named it.","type":"string"}}},"BcardEvent":{"title":"BcardEvent","type":"string","enum":["Added","Enforced","Removed","Unknown"]},"BcardId":{"title":"BcardId","description":"Identifier of a card block.","examples":["blockedsrc_9f2Kd8QpLzXw"],"type":"string"},"BcardPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/BcardPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"BcardPageAttributes":"#/components/schemas/BcardPageAttributes"}}},"BcardPageAttributes":{"title":"BcardPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"BcardPageAttributes","data":[{"type":"BcardViewAttributes","blockedCardId":"blockedsrc_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","marketplaceId":"mktp_9f2Kd8QpLzXw","customerId":"cust_9f2Kd8QpLzXw","transactionId":"tran_9f2Kd8QpLzXw","sourceId":"psrc_9f2Kd8QpLzXw","card":{"type":"BcardDetailsAttributes","last4":"4242","bin":"424242","brand":"Visa","funding":"Credit","expiryMonth":6,"expiryYear":2029,"issuerCountry":"AU","issuer":"example"},"blocked":true,"event":"Added","reason":"Requested by the customer.","payerMessage":"example","createdAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `BcardPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["BcardPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/BcardView","description":"One event in the life of a card block, the card was blocked, a payment was refused because of it, or the block was lifted."}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"BcardSort":{"title":"BcardSort","type":"string","enum":["createdAt","-createdAt"]},"BcardUpdate":{"oneOf":[{"$ref":"#/components/schemas/BcardUpdateRemoveBlock"}],"discriminator":{"propertyName":"type","mapping":{"BcardUpdateRemoveBlock":"#/components/schemas/BcardUpdateRemoveBlock"}}},"BcardUpdateRemoveBlock":{"title":"BcardUpdateRemoveBlock","description":"Lift the block on this card. Recorded as a new event; the history stays.","examples":[{"type":"BcardUpdateRemoveBlock"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `BcardUpdateRemoveBlock`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["BcardUpdateRemoveBlock"]}}},"BcardUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/BcardUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"BcardUpdateRspAttributes":"#/components/schemas/BcardUpdateRspAttributes"}}},"BcardUpdateRspAttributes":{"title":"BcardUpdateRspAttributes","examples":[{"type":"BcardUpdateRspAttributes","updated":{"type":"BcardViewAttributes","blockedCardId":"blockedsrc_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","marketplaceId":"mktp_9f2Kd8QpLzXw","customerId":"cust_9f2Kd8QpLzXw","transactionId":"tran_9f2Kd8QpLzXw","sourceId":"psrc_9f2Kd8QpLzXw","card":{"type":"BcardDetailsAttributes","last4":"4242","bin":"424242","brand":"Visa","funding":"Credit","expiryMonth":6,"expiryYear":2029,"issuerCountry":"AU","issuer":"example"},"blocked":true,"event":"Added","reason":"Requested by the customer.","payerMessage":"example","createdAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `BcardUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["BcardUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/BcardView","description":"The resource as it stands after the change."}}},"BcardView":{"oneOf":[{"$ref":"#/components/schemas/BcardViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"BcardViewAttributes":"#/components/schemas/BcardViewAttributes"}}},"BcardViewAttributes":{"title":"BcardViewAttributes","description":"One event in the life of a card block, the card was blocked, a payment was refused because of it, or the block was lifted.","examples":[{"type":"BcardViewAttributes","blockedCardId":"blockedsrc_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","marketplaceId":"mktp_9f2Kd8QpLzXw","customerId":"cust_9f2Kd8QpLzXw","transactionId":"tran_9f2Kd8QpLzXw","sourceId":"psrc_9f2Kd8QpLzXw","card":{"type":"BcardDetailsAttributes","last4":"4242","bin":"424242","brand":"Visa","funding":"Credit","expiryMonth":6,"expiryYear":2029,"issuerCountry":"AU","issuer":"example"},"blocked":true,"event":"Added","reason":"Requested by the customer.","payerMessage":"example","createdAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","blockedCardId","merchantId","card","blocked","event","reason","createdAt"],"properties":{"type":{"description":"Always `BcardViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["BcardViewAttributes"]},"blockedCardId":{"$ref":"#/components/schemas/BcardId"},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"The merchant whose customer's card this is."},"marketplaceId":{"$ref":"#/components/schemas/MktpId","description":"The marketplace above that merchant, where there is one."},"customerId":{"$ref":"#/components/schemas/CustId","description":"The customer whose card it is. Absent where the block was raised before a customer was known."},"transactionId":{"$ref":"#/components/schemas/TranId","description":"The transaction that triggered this event. Read it at `/transactions/{transactionId}`."},"sourceId":{"$ref":"#/components/schemas/PsrcId","description":"The stored source the block applies to, where the card was saved. Absent for a card entered once."},"card":{"$ref":"#/components/schemas/BcardDetails"},"blocked":{"description":"Whether the card is blocked **now**. The same on every event for one block, it is the block's state, not the event's.","type":"boolean"},"event":{"$ref":"#/components/schemas/BcardEvent","description":"What happened. `Enforced` is a payment refused because of an existing block, not a new one."},"reason":{"description":"Why, in the platform's own words, `Creating a payment token denied since saved card is blocked`.","type":"string"},"payerMessage":{"description":"What to show the payer. Absent where the platform has nothing safe to say.","type":"string"},"createdAt":{"type":"string","format":"date-time"}}},"BingCmd":{"oneOf":[{"$ref":"#/components/schemas/BingCmdCreate"}],"discriminator":{"propertyName":"type","mapping":{"BingCmdCreate":"#/components/schemas/BingCmdCreate"}}},"BingCmdCreate":{"title":"BingCmdCreate","description":"Create a BIN group with its ranges.","examples":[{"type":"BingCmdCreate","title":"example","ranges":[{"type":"BingRangeAttributes","from":1250,"to":1250,"title":"example"}]}],"type":"object","required":["type","title"],"properties":{"type":{"description":"Always `BingCmdCreate`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["BingCmdCreate"]},"title":{"type":"string"},"ranges":{"type":"array","items":{"$ref":"#/components/schemas/BingRange"}}}},"BingCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/BingCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"BingCreateRspAttributes":"#/components/schemas/BingCreateRspAttributes"}}},"BingCreateRspAttributes":{"title":"BingCreateRspAttributes","examples":[{"type":"BingCreateRspAttributes","created":{"type":"BingViewAttributes","binGroupId":"bing_9f2Kd8QpLzXw","title":"example","ranges":[{"type":"BingRangeAttributes","from":1250,"to":1250,"title":"example"}],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `BingCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["BingCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/BingView","description":"The resource that was created."}}},"BingId":{"title":"BingId","description":"Identifier of a BIN group.","examples":["bing_9f2Kd8QpLzXw"],"type":"string"},"BingRange":{"description":"One inclusive range of card-number prefixes.","oneOf":[{"$ref":"#/components/schemas/BingRangeAttributes"}],"discriminator":{"propertyName":"type","mapping":{"BingRangeAttributes":"#/components/schemas/BingRangeAttributes"}}},"BingRangeAttributes":{"title":"BingRangeAttributes","description":"One inclusive range of card-number prefixes.","examples":[{"type":"BingRangeAttributes","from":1250,"to":1250,"title":"example"}],"type":"object","required":["type","from","to","title"],"properties":{"type":{"description":"Always `BingRangeAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["BingRangeAttributes"]},"from":{"description":"Lowest prefix in the range, inclusive.","type":"integer","format":"int64"},"to":{"description":"Highest prefix in the range, inclusive.","type":"integer","format":"int64"},"title":{"description":"What this range is, the issuer or product it covers.","type":"string"}}},"BingReplace":{"description":"Replace a BIN group's title and ranges. Whole, not partial, the ranges are the group.","oneOf":[{"$ref":"#/components/schemas/BingReplaceRanges"}],"discriminator":{"propertyName":"type","mapping":{"BingReplaceRanges":"#/components/schemas/BingReplaceRanges"}}},"BingReplaceRanges":{"title":"BingReplaceRanges","description":"Replace a BIN group's title and ranges. Whole, not partial, the ranges are the group.","examples":[{"type":"BingReplaceRanges","title":"example","ranges":[{"type":"BingRangeAttributes","from":1250,"to":1250,"title":"example"}]}],"type":"object","required":["type","title"],"properties":{"type":{"description":"Always `BingReplaceRanges`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["BingReplaceRanges"]},"title":{"type":"string"},"ranges":{"type":"array","items":{"$ref":"#/components/schemas/BingRange"}}}},"BingView":{"oneOf":[{"$ref":"#/components/schemas/BingViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"BingViewAttributes":"#/components/schemas/BingViewAttributes"}}},"BingViewAttributes":{"title":"BingViewAttributes","description":"A named set of card-number ranges, which source rules match a card against.","examples":[{"type":"BingViewAttributes","binGroupId":"bing_9f2Kd8QpLzXw","title":"example","ranges":[{"type":"BingRangeAttributes","from":1250,"to":1250,"title":"example"}],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","binGroupId","title","createdAt","updatedAt"],"properties":{"type":{"description":"Always `BingViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["BingViewAttributes"]},"binGroupId":{"$ref":"#/components/schemas/BingId"},"title":{"description":"What the group is, in words.","type":"string"},"ranges":{"type":"array","items":{"$ref":"#/components/schemas/BingRange"}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"CardAmounts":{"description":"A card's limits and what is left. All are in the single currency given here.","oneOf":[{"$ref":"#/components/schemas/CardAmountsAttributes"}],"discriminator":{"propertyName":"type","mapping":{"CardAmountsAttributes":"#/components/schemas/CardAmountsAttributes"}}},"CardAmountsAttributes":{"title":"CardAmountsAttributes","description":"A card's limits and what is left. All are in the single currency given here.","examples":[{"type":"CardAmountsAttributes","currency":"AUD","cardLimit":500000,"transactionLimit":500000,"available":1250}],"type":"object","required":["type","currency"],"properties":{"type":{"description":"Always `CardAmountsAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CardAmountsAttributes"]},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"cardLimit":{"$ref":"#/components/schemas/MinorUnits","description":"Ceiling on total spend for the life of this card."},"transactionLimit":{"$ref":"#/components/schemas/MinorUnits","description":"Ceiling on any single authorisation, where it differs from the card's total."},"available":{"$ref":"#/components/schemas/MinorUnits","description":"Left to spend on this card."}}},"CardBrand":{"title":"CardBrand","type":"string","enum":["Visa","MasterCard","AmericanExpress","DinersClub","Discover","UnionPay","Maestro","Elo","Mir","Hiper","Hipercard","Jcb","Electron","Uatp","Unknown"]},"CardCmd":{"oneOf":[{"$ref":"#/components/schemas/CardCmdCreateMastercard"},{"$ref":"#/components/schemas/CardCmdCreateUatp"}],"discriminator":{"propertyName":"type","mapping":{"CardCmdCreateMastercard":"#/components/schemas/CardCmdCreateMastercard","CardCmdCreateUatp":"#/components/schemas/CardCmdCreateUatp"}}},"CardCmdCreateMastercard":{"title":"CardCmdCreateMastercard","description":"Issue a Mastercard digital card against a loan. The platform issues the card number.","examples":[{"type":"CardCmdCreateMastercard","loanId":"loan_9f2Kd8QpLzXw","spec":{"type":"CardSpecAttributes","cardUser":{"type":"CardUserAttributes","name":"Ada Lovelace","emailAddress":"ada@example.com","phoneNumber":"+61400000000"},"creator":"example","validFrom":"2026-08-19T04:21:07Z","validTo":"2026-08-19T04:21:07Z","limits":{"type":"CardLimitsAttributes","currency":"AUD","cardLimit":500000,"transactionLimit":500000},"usage":"Single","currencies":["AUD"],"metadata":{"yourKey":{}}}}],"type":"object","required":["type","loanId","spec"],"properties":{"type":{"description":"Always `CardCmdCreateMastercard`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CardCmdCreateMastercard"]},"loanId":{"$ref":"#/components/schemas/LoanId","description":"The loan the card draws against."},"spec":{"$ref":"#/components/schemas/CardSpec"}}},"CardCmdCreateUatp":{"title":"CardCmdCreateUatp","description":"Issue a UATP digital card against a loan. The platform allocates the card number from its UATP range.","examples":[{"type":"CardCmdCreateUatp","loanId":"loan_9f2Kd8QpLzXw","country":"AU","product":"TestCard","spec":{"type":"CardSpecAttributes","cardUser":{"type":"CardUserAttributes","name":"Ada Lovelace","emailAddress":"ada@example.com","phoneNumber":"+61400000000"},"creator":"example","validFrom":"2026-08-19T04:21:07Z","validTo":"2026-08-19T04:21:07Z","limits":{"type":"CardLimitsAttributes","currency":"AUD","cardLimit":500000,"transactionLimit":500000},"usage":"Single","currencies":["AUD"],"metadata":{"yourKey":{}}}}],"type":"object","required":["type","loanId","country","product","spec"],"properties":{"type":{"description":"Always `CardCmdCreateUatp`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CardCmdCreateUatp"]},"loanId":{"$ref":"#/components/schemas/LoanId","description":"The loan the card draws against."},"country":{"$ref":"#/components/schemas/IsoCountry","description":"The country the card is issued in."},"product":{"$ref":"#/components/schemas/CardUatpProduct"},"spec":{"$ref":"#/components/schemas/CardSpec"}}},"CardCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/CardCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"CardCreateRspAttributes":"#/components/schemas/CardCreateRspAttributes"}}},"CardCreateRspAttributes":{"title":"CardCreateRspAttributes","examples":[{"type":"CardCreateRspAttributes","created":{"type":"CardViewAttributes","cardId":"dcard_9f2Kd8QpLzXw","cardType":"Virtual","status":"Active","card":{"type":"CardRedactedAttributes","last4":"4242","bin":"424242","brand":"Visa","expiryMonth":6,"expiryYear":2029},"cardUser":{"type":"CardUserAttributes","name":"Ada Lovelace","emailAddress":"ada@example.com","phoneNumber":"+61400000000"},"amounts":{"type":"CardAmountsAttributes","currency":"AUD","cardLimit":500000,"transactionLimit":500000,"available":1250},"validFrom":"2026-08-19T04:21:07Z","validTo":"2026-08-19T04:21:07Z","usage":"Single","currencies":["AUD"],"synonyms":["example"],"creator":"example","providerIdentifier":"example","metadata":{"yourKey":{}},"createdAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `CardCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CardCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/CardView","description":"The resource that was created."}}},"CardFee":{"description":"A fee that applies only to cards of a particular funding type, and optionally a particular brand.","oneOf":[{"$ref":"#/components/schemas/CardFeeAttributes"}],"discriminator":{"propertyName":"type","mapping":{"CardFeeAttributes":"#/components/schemas/CardFeeAttributes"}}},"CardFeeAttributes":{"title":"CardFeeAttributes","description":"A fee that applies only to cards of a particular funding type, and optionally a particular brand.","examples":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}],"type":"object","required":["type","cardFunding","rate","fixed"],"properties":{"type":{"description":"Always `CardFeeAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CardFeeAttributes"]},"cardFunding":{"$ref":"#/components/schemas/CardFunding"},"cardBrand":{"$ref":"#/components/schemas/CardBrand","description":"Omit to match every brand of that funding type."},"rate":{"description":"A ratio of the amount, **not a percentage** `0.0175` is 1.75%. Zero to one.","type":"number"},"fixed":{"description":"Fixed charge in the smallest currency unit.","type":"integer","format":"int64"}}},"CardFunding":{"title":"CardFunding","type":"string","enum":["Credit","Debit","ChargeCard","Prepaid","DeferredDebit","Unknown"]},"CardId":{"title":"CardId","type":"string"},"CardLimits":{"oneOf":[{"$ref":"#/components/schemas/CardLimitsAttributes"}],"discriminator":{"propertyName":"type","mapping":{"CardLimitsAttributes":"#/components/schemas/CardLimitsAttributes"}}},"CardLimitsAttributes":{"title":"CardLimitsAttributes","description":"Ceilings on a card's spending. Both are in the single currency given here.","examples":[{"type":"CardLimitsAttributes","currency":"AUD","cardLimit":500000,"transactionLimit":500000}],"type":"object","required":["type","currency"],"properties":{"type":{"description":"Always `CardLimitsAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CardLimitsAttributes"]},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"cardLimit":{"$ref":"#/components/schemas/MinorUnits","description":"Ceiling on total spend for the life of this card."},"transactionLimit":{"$ref":"#/components/schemas/MinorUnits","description":"Ceiling on any single authorisation, where it differs from the card's total."}}},"CardPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/CardPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"CardPageAttributes":"#/components/schemas/CardPageAttributes"}}},"CardPageAttributes":{"title":"CardPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"CardPageAttributes","data":[{"type":"CardViewAttributes","cardId":"dcard_9f2Kd8QpLzXw","cardType":"Virtual","status":"Active","card":{"type":"CardRedactedAttributes","last4":"4242","bin":"424242","brand":"Visa","expiryMonth":6,"expiryYear":2029},"cardUser":{"type":"CardUserAttributes","name":"Ada Lovelace","emailAddress":"ada@example.com","phoneNumber":"+61400000000"},"amounts":{"type":"CardAmountsAttributes","currency":"AUD","cardLimit":500000,"transactionLimit":500000,"available":1250},"validFrom":"2026-08-19T04:21:07Z","validTo":"2026-08-19T04:21:07Z","usage":"Single","currencies":["AUD"],"synonyms":["example"],"creator":"example","providerIdentifier":"example","metadata":{"yourKey":{}},"createdAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `CardPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CardPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/CardView","description":"A digital card."}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"CardProductType":{"title":"CardProductType","type":"string","enum":["Consumer","Corporate","Unknown"]},"CardRedacted":{"description":"The non-sensitive projection of a card's details.","oneOf":[{"$ref":"#/components/schemas/CardRedactedAttributes"}],"discriminator":{"propertyName":"type","mapping":{"CardRedactedAttributes":"#/components/schemas/CardRedactedAttributes"}}},"CardRedactedAttributes":{"title":"CardRedactedAttributes","description":"The non-sensitive projection of a card's details.","examples":[{"type":"CardRedactedAttributes","last4":"4242","bin":"424242","brand":"Visa","expiryMonth":6,"expiryYear":2029}],"type":"object","required":["type","last4","bin","brand","expiryMonth","expiryYear"],"properties":{"type":{"description":"Always `CardRedactedAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CardRedactedAttributes"]},"last4":{"description":"Last four digits of the card number.","type":"string"},"bin":{"description":"First six to eight digits, identifying the issuer.","type":"string"},"brand":{"$ref":"#/components/schemas/CardBrand"},"expiryMonth":{"description":"Expiry month, 1-12.","type":"integer","format":"int32"},"expiryYear":{"description":"Expiry year, four digits.","type":"integer","format":"int32"}}},"CardSchemeProduct":{"title":"CardSchemeProduct","type":"string","enum":["MasterCardCrPer","MasterCardSignia","MasterCardDrPerInt","MasterCardWorld","AllStar","AmericanExpress","VisaCreditPersonal","VisaDrPerInt","DinersClubDiscover","DinersCreditComEEA","DinersInternational","DinersCreditPerEEA","DinersDebitComEEA","DinersDebitPerEEA","VisaDebitPersonal","VisaDebitCom","DrMasterCardPer","DrMasterCardCom","DebitMasterCardPerInt","EFTPOSPriority1","EFTPOSPriority2","JCB","JCBCreditComEEA","JCBInternational","JCBCreditPerEEA","JCBDebitComEEA","JCBDebitPerEEA","Keyfuels","LaSer","Overdrive","VisaElectronDr","VisaElectronCr","VisaElecPerInt","MaestroPer","MaestroCom","MaestroPer2","MaestroIntlCom","MaestroIntlPer","Supercharge","Sears","MasterCardComm","MasterCardBusiness","MasterCardFleet","MasterCardCorporate","MasterCardPurchase","MasterCardDrCom","VisaBusiness","VisaCommerce","VisaCorporate","VisaPurchasing","VisaDrComIntl","UATP","Unknown"]},"CardSort":{"title":"CardSort","type":"string","enum":["createdAt","-createdAt","updatedAt","-updatedAt"]},"CardSpec":{"description":"What a card is issued with.","oneOf":[{"$ref":"#/components/schemas/CardSpecAttributes"}],"discriminator":{"propertyName":"type","mapping":{"CardSpecAttributes":"#/components/schemas/CardSpecAttributes"}}},"CardSpecAttributes":{"title":"CardSpecAttributes","description":"What a card is issued with.","examples":[{"type":"CardSpecAttributes","cardUser":{"type":"CardUserAttributes","name":"Ada Lovelace","emailAddress":"ada@example.com","phoneNumber":"+61400000000"},"creator":"example","validFrom":"2026-08-19T04:21:07Z","validTo":"2026-08-19T04:21:07Z","limits":{"type":"CardLimitsAttributes","currency":"AUD","cardLimit":500000,"transactionLimit":500000},"usage":"Single","currencies":["AUD"],"metadata":{"yourKey":{}}}],"type":"object","required":["type","cardUser","creator","validFrom","validTo"],"properties":{"type":{"description":"Always `CardSpecAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CardSpecAttributes"]},"cardUser":{"$ref":"#/components/schemas/CardUser","description":"Who the card is for."},"creator":{"description":"Who is issuing it, as you want it recorded against the card.","type":"string"},"validFrom":{"description":"The card cannot be used before this.","type":"string","format":"date-time"},"validTo":{"description":"The card cannot be used after this.","type":"string","format":"date-time"},"limits":{"$ref":"#/components/schemas/CardLimits","description":"Ceilings on what this card may spend. Omit to let the loan's own limits apply."},"usage":{"$ref":"#/components/schemas/CardUsage"},"currencies":{"description":"The currencies this card may be presented in. Empty means the loan's own only.","type":"array","items":{"$ref":"#/components/schemas/IsoCurrency"}},"metadata":{"$ref":"#/components/schemas/Metadata","description":"Free-form data the platform stores and returns untouched."}}},"CardSpecUpdate":{"description":"A card's terms. Omitted fields are taken from the card as it stands.","oneOf":[{"$ref":"#/components/schemas/CardSpecUpdateAttributes"}],"discriminator":{"propertyName":"type","mapping":{"CardSpecUpdateAttributes":"#/components/schemas/CardSpecUpdateAttributes"}}},"CardSpecUpdateAttributes":{"title":"CardSpecUpdateAttributes","description":"A card's terms. Omitted fields are taken from the card as it stands.","examples":[{"type":"CardSpecUpdateAttributes","cardUser":{"type":"CardUserAttributes","name":"Ada Lovelace","emailAddress":"ada@example.com","phoneNumber":"+61400000000"},"validFrom":"2026-08-19T04:21:07Z","validTo":"2026-08-19T04:21:07Z","limits":{"type":"CardLimitsAttributes","currency":"AUD","cardLimit":500000,"transactionLimit":500000},"currencies":["AUD"],"metadata":{"yourKey":{}}}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `CardSpecUpdateAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CardSpecUpdateAttributes"]},"cardUser":{"$ref":"#/components/schemas/CardUser","description":"Who a card is issued to."},"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"limits":{"$ref":"#/components/schemas/CardLimits","description":"Ceilings on what this card may spend. Sending this replaces both."},"currencies":{"description":"The currencies this card may be presented in. Replaces the set.","type":"array","items":{"$ref":"#/components/schemas/IsoCurrency"}},"metadata":{"$ref":"#/components/schemas/Metadata","description":"Free-form data. Replaces what is there."}}},"CardStatus":{"title":"CardStatus","type":"string","enum":["Active","Cancelled","OutOfLifetime","Unknown"]},"CardSynonymType":{"title":"CardSynonymType","type":"string","enum":["RandomPan","Unknown"]},"CardType":{"title":"CardType","description":"Whether the card exists only as a number or was also manufactured.","type":"string","enum":["Virtual","Physical","Unknown"]},"CardUatpProduct":{"title":"CardUatpProduct","description":"Which UATP product this card is on.","type":"string","enum":["TestCard","Travel","TravelTrade","Unknown"]},"CardUpdate":{"oneOf":[{"$ref":"#/components/schemas/CardUpdateActivate"},{"$ref":"#/components/schemas/CardUpdateAmend"},{"$ref":"#/components/schemas/CardUpdateCancel"},{"$ref":"#/components/schemas/CardUpdateGenerateSynonym"}],"discriminator":{"propertyName":"type","mapping":{"CardUpdateActivate":"#/components/schemas/CardUpdateActivate","CardUpdateAmend":"#/components/schemas/CardUpdateAmend","CardUpdateCancel":"#/components/schemas/CardUpdateCancel","CardUpdateGenerateSynonym":"#/components/schemas/CardUpdateGenerateSynonym"}}},"CardUpdateActivate":{"title":"CardUpdateActivate","description":"Lift a cancellation, letting the card authorise again.","examples":[{"type":"CardUpdateActivate"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `CardUpdateActivate`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CardUpdateActivate"]}}},"CardUpdateAmend":{"title":"CardUpdateAmend","description":"Change the card's terms. What you omit is left as it stands.","examples":[{"type":"CardUpdateAmend","spec":{"type":"CardSpecUpdateAttributes","cardUser":{"type":"CardUserAttributes","name":"Ada Lovelace","emailAddress":"ada@example.com","phoneNumber":"+61400000000"},"validFrom":"2026-08-19T04:21:07Z","validTo":"2026-08-19T04:21:07Z","limits":{"type":"CardLimitsAttributes","currency":"AUD","cardLimit":500000,"transactionLimit":500000},"currencies":["AUD"],"metadata":{"yourKey":{}}}}],"type":"object","required":["type","spec"],"properties":{"type":{"description":"Always `CardUpdateAmend`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CardUpdateAmend"]},"spec":{"$ref":"#/components/schemas/CardSpecUpdate"}}},"CardUpdateCancel":{"title":"CardUpdateCancel","description":"Stop further authorisations on the card. Reversible with `CardUpdateActivate`.","examples":[{"type":"CardUpdateCancel"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `CardUpdateCancel`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CardUpdateCancel"]}}},"CardUpdateGenerateSynonym":{"title":"CardUpdateGenerateSynonym","description":"Issue one alternative number the scheme will also recognise. Edge's `CreateSynonymsForDigitalCards`.","examples":[{"type":"CardUpdateGenerateSynonym","synonym":"RandomPan"}],"type":"object","required":["type","synonym"],"properties":{"type":{"description":"Always `CardUpdateGenerateSynonym`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CardUpdateGenerateSynonym"]},"synonym":{"$ref":"#/components/schemas/CardSynonymType"}}},"CardUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/CardUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"CardUpdateRspAttributes":"#/components/schemas/CardUpdateRspAttributes"}}},"CardUpdateRspAttributes":{"title":"CardUpdateRspAttributes","examples":[{"type":"CardUpdateRspAttributes","updated":{"type":"CardViewAttributes","cardId":"dcard_9f2Kd8QpLzXw","cardType":"Virtual","status":"Active","card":{"type":"CardRedactedAttributes","last4":"4242","bin":"424242","brand":"Visa","expiryMonth":6,"expiryYear":2029},"cardUser":{"type":"CardUserAttributes","name":"Ada Lovelace","emailAddress":"ada@example.com","phoneNumber":"+61400000000"},"amounts":{"type":"CardAmountsAttributes","currency":"AUD","cardLimit":500000,"transactionLimit":500000,"available":1250},"validFrom":"2026-08-19T04:21:07Z","validTo":"2026-08-19T04:21:07Z","usage":"Single","currencies":["AUD"],"synonyms":["example"],"creator":"example","providerIdentifier":"example","metadata":{"yourKey":{}},"createdAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `CardUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CardUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/CardView","description":"The resource as it stands after the change."}}},"CardUsage":{"title":"CardUsage","description":"Whether the card may be presented once or repeatedly.","type":"string","enum":["Single","Multiple","Unknown"]},"CardUser":{"oneOf":[{"$ref":"#/components/schemas/CardUserAttributes"}],"discriminator":{"propertyName":"type","mapping":{"CardUserAttributes":"#/components/schemas/CardUserAttributes"}}},"CardUserAttributes":{"title":"CardUserAttributes","description":"Who a card is issued to.","examples":[{"type":"CardUserAttributes","name":"Ada Lovelace","emailAddress":"ada@example.com","phoneNumber":"+61400000000"}],"type":"object","required":["type","name"],"properties":{"type":{"description":"Always `CardUserAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CardUserAttributes"]},"name":{"type":"string"},"emailAddress":{"type":"string"},"phoneNumber":{"type":"string"}}},"CardView":{"oneOf":[{"$ref":"#/components/schemas/CardViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"CardViewAttributes":"#/components/schemas/CardViewAttributes"}}},"CardViewAttributes":{"title":"CardViewAttributes","description":"A digital card.","examples":[{"type":"CardViewAttributes","cardId":"dcard_9f2Kd8QpLzXw","cardType":"Virtual","status":"Active","card":{"type":"CardRedactedAttributes","last4":"4242","bin":"424242","brand":"Visa","expiryMonth":6,"expiryYear":2029},"cardUser":{"type":"CardUserAttributes","name":"Ada Lovelace","emailAddress":"ada@example.com","phoneNumber":"+61400000000"},"amounts":{"type":"CardAmountsAttributes","currency":"AUD","cardLimit":500000,"transactionLimit":500000,"available":1250},"validFrom":"2026-08-19T04:21:07Z","validTo":"2026-08-19T04:21:07Z","usage":"Single","currencies":["AUD"],"synonyms":["example"],"creator":"example","providerIdentifier":"example","metadata":{"yourKey":{}},"createdAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","cardId","cardType","status","card","cardUser","amounts","validFrom","validTo","creator","providerIdentifier","createdAt"],"properties":{"type":{"description":"Always `CardViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CardViewAttributes"]},"cardId":{"$ref":"#/components/schemas/CardId","description":"Identifier of a digital card."},"cardType":{"$ref":"#/components/schemas/CardType"},"status":{"$ref":"#/components/schemas/CardStatus"},"card":{"$ref":"#/components/schemas/CardRedacted"},"cardUser":{"$ref":"#/components/schemas/CardUser","description":"Who the card is issued to."},"amounts":{"$ref":"#/components/schemas/CardAmounts"},"validFrom":{"description":"The card cannot be used before this.","type":"string","format":"date-time"},"validTo":{"description":"The card cannot be used after this. The platform allows three days' leniency either side.","type":"string","format":"date-time"},"usage":{"$ref":"#/components/schemas/CardUsage"},"currencies":{"description":"The currencies this card may be presented in. Empty means the loan's own only.","type":"array","items":{"$ref":"#/components/schemas/IsoCurrency"}},"synonyms":{"description":"Alternative numbers the scheme knows this card by. Mastercard issues them on request; a UATP card has none.","type":"array","items":{"type":"string"}},"creator":{"description":"Who created the card, as the platform recorded it.","type":"string"},"providerIdentifier":{"description":"The card provider's own identifier for this card.","type":"string"},"metadata":{"$ref":"#/components/schemas/Metadata","description":"Free-form data the platform stores and returns untouched."},"createdAt":{"type":"string","format":"date-time"}}},"CustAddress":{"oneOf":[{"$ref":"#/components/schemas/CustAddressAttributes"}],"discriminator":{"propertyName":"type","mapping":{"CustAddressAttributes":"#/components/schemas/CustAddressAttributes"}}},"CustAddressAttributes":{"title":"CustAddressAttributes","description":"A postal address.","examples":[{"type":"CustAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"}],"type":"object","required":["type","streetNumber","streetName","postalCode","country"],"properties":{"type":{"description":"Always `CustAddressAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CustAddressAttributes"]},"unitNumber":{"description":"Unit, shop or level, as written on the building. Free text, `12`, `Shop 4`, `Level 3`. Omit where there is none.","type":"string"},"streetNumber":{"description":"Street number, including any range or letter, `34`, `34A`, `34-36`.","type":"string"},"streetName":{"description":"Street name, without the type, `Smith`, not `Smith Street`.","type":"string"},"streetType":{"description":"`Street`, `Road`, `Avenue`. Optional because not every address has one.","type":"string"},"suburb":{"description":"Suburb. This is where Australia and South Africa keep what other countries call the city.","type":"string"},"city":{"description":"City. **Required in New Zealand.** In Australia and South Africa send `suburb` instead, the platform moves whichever you send to where that country keeps it.","type":"string"},"state":{"description":"State, province or territory. **Required in Australia.**","type":"string"},"postalCode":{"type":"string"},"country":{"description":"ISO 3166-1 alpha-2.","type":"string"}}},"CustBusinessContact":{"description":"Who to contact at the business.","oneOf":[{"$ref":"#/components/schemas/CustBusinessContactAttributes"}],"discriminator":{"propertyName":"type","mapping":{"CustBusinessContactAttributes":"#/components/schemas/CustBusinessContactAttributes"}}},"CustBusinessContactAttributes":{"title":"CustBusinessContactAttributes","description":"Who to contact at the business.","examples":[{"type":"CustBusinessContactAttributes","title":"example","firstName":"Ada Lovelace","lastName":"Ada Lovelace","emailAddress":"ada@example.com","supportEmailAddress":"ada@example.com","phoneNumber":"+61400000000"}],"type":"object","required":["type","title","firstName","lastName","emailAddress","phoneNumber"],"properties":{"type":{"description":"Always `CustBusinessContactAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CustBusinessContactAttributes"]},"title":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"emailAddress":{"type":"string"},"supportEmailAddress":{"description":"Where a payer's support enquiry goes, when it is not the contact address.","type":"string"},"phoneNumber":{"description":"Phone number in E.164 format, such as `+61400000000`.","type":"string"}}},"CustBusinessProfile":{"description":"The business profile, which carries the trading address and the contact person.","oneOf":[{"$ref":"#/components/schemas/CustBusinessProfileAttributes"}],"discriminator":{"propertyName":"type","mapping":{"CustBusinessProfileAttributes":"#/components/schemas/CustBusinessProfileAttributes"}}},"CustBusinessProfileAttributes":{"title":"CustBusinessProfileAttributes","description":"The legal identity of a business customer.","examples":[{"type":"CustBusinessProfileAttributes","legalName":"Ada Lovelace","businessRegistrationNumber":"example","taxRegistrationNumber":"example","businessType":"Company","companyType":"example","industry":"example","website":"example","supportSite":"example","taxCountry":"AU","tradingCountry":"AU","registeredAddress":{"type":"CustAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"},"contact":{"type":"CustBusinessContactAttributes","title":"example","firstName":"Ada Lovelace","lastName":"Ada Lovelace","emailAddress":"ada@example.com","supportEmailAddress":"ada@example.com","phoneNumber":"+61400000000"},"timeZone":"example"}],"type":"object","required":["type","legalName","businessRegistrationNumber","businessType","industry","website","supportSite","taxCountry","registeredAddress","contact","timeZone"],"properties":{"type":{"description":"Always `CustBusinessProfileAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CustBusinessProfileAttributes"]},"legalName":{"description":"Registered legal name, as it appears against the business registration number.","type":"string"},"businessRegistrationNumber":{"description":"ABN in Australia, NZBN in New Zealand.","type":"string"},"taxRegistrationNumber":{"description":"ABN in Australia, IRD number in New Zealand. Absent where the business has not supplied one.","type":"string"},"businessType":{"$ref":"#/components/schemas/MchtBusinessType"},"companyType":{"description":"Required when `businessType` is `Company`.","type":"string"},"industry":{"type":"string"},"website":{"type":"string"},"supportSite":{"description":"Where a payer goes for help with this business.","type":"string"},"taxCountry":{"description":"ISO 3166-1 alpha-2. Where the business is registered for tax.","type":"string"},"tradingCountry":{"description":"ISO 3166-1 alpha-2. Only present where the business trades somewhere other than its tax country.","type":"string"},"registeredAddress":{"$ref":"#/components/schemas/CustAddress","description":"Where the business is registered."},"contact":{"$ref":"#/components/schemas/CustBusinessContact"},"timeZone":{"description":"The business's own time zone, as an IANA name such as `Australia/Sydney`.","type":"string"}}},"CustBusinessProfileReplace":{"description":"An organisation customer's business identity, as a caller states it.","oneOf":[{"$ref":"#/components/schemas/CustBusinessProfileReplaceAttributes"}],"discriminator":{"propertyName":"type","mapping":{"CustBusinessProfileReplaceAttributes":"#/components/schemas/CustBusinessProfileReplaceAttributes"}}},"CustBusinessProfileReplaceAttributes":{"title":"CustBusinessProfileReplaceAttributes","description":"An organisation customer's business identity, as a caller states it.","examples":[{"type":"CustBusinessProfileReplaceAttributes","legalName":"Ada Lovelace","businessRegistrationNumber":"example","taxRegistrationNumber":"example","businessType":"Company","companyType":"example","industry":"example","website":"example","supportSite":"example","tradingCountry":"AU","registeredAddress":{"type":"CustAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"},"contact":{"type":"CustBusinessContactAttributes","title":"example","firstName":"Ada Lovelace","lastName":"Ada Lovelace","emailAddress":"ada@example.com","supportEmailAddress":"ada@example.com","phoneNumber":"+61400000000"},"timeZone":"example","brandName":"Ada Lovelace"}],"type":"object","required":["type","legalName","businessRegistrationNumber","businessType","industry","website","supportSite","registeredAddress","contact","timeZone","brandName"],"properties":{"type":{"description":"Always `CustBusinessProfileReplaceAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CustBusinessProfileReplaceAttributes"]},"legalName":{"description":"Registered legal name, as it appears against the business registration number.","type":"string"},"businessRegistrationNumber":{"description":"ABN in Australia, NZBN in New Zealand.","type":"string"},"taxRegistrationNumber":{"description":"ABN in Australia, IRD number in New Zealand. Validated against the customer's tax country.","type":"string"},"businessType":{"$ref":"#/components/schemas/MchtBusinessType"},"companyType":{"description":"Required when `businessType` is `Company`.","type":"string"},"industry":{"type":"string"},"website":{"type":"string"},"supportSite":{"description":"Where a payer goes for help with this business.","type":"string"},"tradingCountry":{"description":"ISO 3166-1 alpha-2. Only needed where the business trades somewhere other than its tax country.","type":"string"},"registeredAddress":{"$ref":"#/components/schemas/CustAddress","description":"A postal address."},"contact":{"$ref":"#/components/schemas/CustBusinessContact"},"timeZone":{"description":"The business's own time zone, as an IANA name such as `Australia/Sydney`.","type":"string"},"brandName":{"description":"The customer-facing name of the business, where it differs from the legal one.","type":"string"}}},"CustCmd":{"oneOf":[{"$ref":"#/components/schemas/CustCmdCreateConsumer"},{"$ref":"#/components/schemas/CustCmdCreateOrganisation"}],"discriminator":{"propertyName":"type","mapping":{"CustCmdCreateConsumer":"#/components/schemas/CustCmdCreateConsumer","CustCmdCreateOrganisation":"#/components/schemas/CustCmdCreateOrganisation"}}},"CustCmdCreateConsumer":{"title":"CustCmdCreateConsumer","description":"Create an individual customer.","examples":[{"type":"CustCmdCreateConsumer","merchantId":"mcht_9f2Kd8QpLzXw","givenName":"Ada Lovelace","middleName":"Ada Lovelace","familyName":"Ada Lovelace","emailAddress":"ada@example.com","phoneNumber":"+61400000000","referenceCustomerId":"your-own-reference","isVerified":true}],"type":"object","required":["type","merchantId","familyName","emailAddress"],"properties":{"type":{"description":"Always `CustCmdCreateConsumer`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CustCmdCreateConsumer"]},"merchantId":{"type":"string"},"givenName":{"description":"Named as the view names it. The domain's own input says `firstName`; one vocabulary is better than two.","type":"string"},"middleName":{"type":"string"},"familyName":{"type":"string"},"emailAddress":{"type":"string"},"phoneNumber":{"description":"Kept only when `isVerified` is true. On an unverified customer the platform waits for the one-time code to prove the number, and until then the customer reads back without one, so a number sent here with `isVerified` absent is not stored.","type":"string"},"referenceCustomerId":{"type":"string"},"isVerified":{"description":"Whether the contact details are already known to be good. Defaults to unverified.","type":"boolean"}}},"CustCmdCreateOrganisation":{"title":"CustCmdCreateOrganisation","description":"Create a business customer.","examples":[{"type":"CustCmdCreateOrganisation","merchantId":"mcht_9f2Kd8QpLzXw","referenceCustomerId":"your-own-reference","organisationName":"Ada Lovelace","taxId":"abc123","emailAddress":"ada@example.com","organisationKyced":true,"organisationCreditChecked":true,"organisationId":"org_9f2Kd8QpLzXw"}],"type":"object","required":["type","merchantId","referenceCustomerId","organisationName","emailAddress"],"properties":{"type":{"description":"Always `CustCmdCreateOrganisation`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CustCmdCreateOrganisation"]},"merchantId":{"type":"string"},"referenceCustomerId":{"description":"Your own identifier for this organisation. Required, the domain keys an organisation on it.","type":"string"},"organisationName":{"description":"Registered legal name of the organisation.","type":"string"},"taxId":{"description":"Required, unlike on a consumer: a business has a tax identity and the domain insists on it. Leave it out when naming an existing organisation with `organisationId`, whose own registration is used.","type":"string"},"emailAddress":{"type":"string"},"organisationKyced":{"description":"Whether the organisation has already passed KYB.","type":"boolean"},"organisationCreditChecked":{"description":"Whether a credit check has already been run.","type":"boolean"},"organisationId":{"$ref":"#/components/schemas/OrgId","description":"An organisation already in the platform that this customer is, such as one of your merchants that you also bill. It must be one you can read on `/organisations`. The customer then shares that organisation's record instead of a new one being made from `taxId`."}}},"CustColumn":{"title":"CustColumn","type":"string","enum":["Type","CustomerId","PersonId","MerchantId","MarketplaceId","ReferenceCustomerId","GivenName","MiddleName","FamilyName","EmailAddress","PhoneNumber","IsVerified","KycAttemptsWithoutDocument","KycAttemptsWithDriversLicence","KycAttemptsWithPassport","KycAttemptsWithDriversLicenceAndPassport","KycAttemptsLevel","CreatedAt","UpdatedAt","OrganisationId","OrganisationName","TaxId","BusinessProfileLegalName","BusinessProfileBusinessRegistrationNumber","BusinessProfileTaxRegistrationNumber","BusinessProfileBusinessType","BusinessProfileCompanyType","BusinessProfileIndustry","BusinessProfileWebsite","BusinessProfileSupportSite","BusinessProfileTaxCountry","BusinessProfileTradingCountry","BusinessProfileRegisteredAddressUnitNumber","BusinessProfileRegisteredAddressStreetNumber","BusinessProfileRegisteredAddressStreetName","BusinessProfileRegisteredAddressStreetType","BusinessProfileRegisteredAddressSuburb","BusinessProfileRegisteredAddressCity","BusinessProfileRegisteredAddressState","BusinessProfileRegisteredAddressPostalCode","BusinessProfileRegisteredAddressCountry","BusinessProfileContactTitle","BusinessProfileContactFirstName","BusinessProfileContactLastName","BusinessProfileContactEmailAddress","BusinessProfileContactSupportEmailAddress","BusinessProfileContactPhoneNumber","BusinessProfileTimeZone","OrganisationKyced","OrganisationCreditChecked"]},"CustCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/CustCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"CustCreateRspAttributes":"#/components/schemas/CustCreateRspAttributes"}}},"CustCreateRspAttributes":{"title":"CustCreateRspAttributes","examples":[{"type":"CustCreateRspAttributes","created":{"type":"CustViewConsumer","customerId":"cust_9f2Kd8QpLzXw","personId":"pson_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","marketplaceId":"mktp_9f2Kd8QpLzXw","referenceCustomerId":"your-own-reference","givenName":"Ada Lovelace","middleName":"Ada Lovelace","familyName":"Ada Lovelace","emailAddress":"ada@example.com","phoneNumber":"+61400000000","isVerified":true,"kycAttempts":{"type":"CustKycAttemptsAttributes","withoutDocument":1250,"withDriversLicence":1250,"withPassport":1250,"withDriversLicenceAndPassport":1250,"level":"example"},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `CustCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CustCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/CustView","description":"The resource that was created."}}},"CustId":{"title":"CustId","examples":["cust_9f2Kd8QpLzXw"],"type":"string"},"CustKycAttempts":{"oneOf":[{"$ref":"#/components/schemas/CustKycAttemptsAttributes"}],"discriminator":{"propertyName":"type","mapping":{"CustKycAttemptsAttributes":"#/components/schemas/CustKycAttemptsAttributes"}}},"CustKycAttemptsAttributes":{"title":"CustKycAttemptsAttributes","description":"Identity checks attempted, by the evidence they were run with.","examples":[{"type":"CustKycAttemptsAttributes","withoutDocument":1250,"withDriversLicence":1250,"withPassport":1250,"withDriversLicenceAndPassport":1250,"level":"example"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `CustKycAttemptsAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CustKycAttemptsAttributes"]},"withoutDocument":{"description":"Checks run on name and address alone. Absent where none were.","type":"integer","format":"int32"},"withDriversLicence":{"description":"Checks run against a driver licence.","type":"integer","format":"int32"},"withPassport":{"description":"Checks run against a passport.","type":"integer","format":"int32"},"withDriversLicenceAndPassport":{"description":"Checks run against both.","type":"integer","format":"int32"},"level":{"description":"The level reached, where one was.","type":"string"}}},"CustPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/CustPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"CustPageAttributes":"#/components/schemas/CustPageAttributes"}}},"CustPageAttributes":{"title":"CustPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"CustPageAttributes","data":[{"type":"CustViewConsumer","customerId":"cust_9f2Kd8QpLzXw","personId":"pson_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","marketplaceId":"mktp_9f2Kd8QpLzXw","referenceCustomerId":"your-own-reference","givenName":"Ada Lovelace","middleName":"Ada Lovelace","familyName":"Ada Lovelace","emailAddress":"ada@example.com","phoneNumber":"+61400000000","isVerified":true,"kycAttempts":{"type":"CustKycAttemptsAttributes","withoutDocument":1250,"withDriversLicence":1250,"withPassport":1250,"withDriversLicenceAndPassport":1250,"level":"example"},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `CustPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CustPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/CustView"}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"CustSort":{"title":"CustSort","type":"string","enum":["createdAt","-createdAt"]},"CustUpdate":{"oneOf":[{"$ref":"#/components/schemas/CustUpdateBusinessProfile"},{"$ref":"#/components/schemas/CustUpdateEmailAddress"},{"$ref":"#/components/schemas/CustUpdateMetadata"},{"$ref":"#/components/schemas/CustUpdateName"},{"$ref":"#/components/schemas/CustUpdateOrganisation"},{"$ref":"#/components/schemas/CustUpdatePhoneNumber"},{"$ref":"#/components/schemas/CustUpdateResetKycAttempts"}],"discriminator":{"propertyName":"type","mapping":{"CustUpdateBusinessProfile":"#/components/schemas/CustUpdateBusinessProfile","CustUpdateEmailAddress":"#/components/schemas/CustUpdateEmailAddress","CustUpdateMetadata":"#/components/schemas/CustUpdateMetadata","CustUpdateName":"#/components/schemas/CustUpdateName","CustUpdateOrganisation":"#/components/schemas/CustUpdateOrganisation","CustUpdatePhoneNumber":"#/components/schemas/CustUpdatePhoneNumber","CustUpdateResetKycAttempts":"#/components/schemas/CustUpdateResetKycAttempts"}}},"CustUpdateBusinessProfile":{"title":"CustUpdateBusinessProfile","description":"Replace an organisation customer's business identity. Whole, not partial, the platform validates the tax number against the country.","examples":[{"type":"CustUpdateBusinessProfile","businessProfile":{"type":"CustBusinessProfileReplaceAttributes","legalName":"Ada Lovelace","businessRegistrationNumber":"example","taxRegistrationNumber":"example","businessType":"Company","companyType":"example","industry":"example","website":"example","supportSite":"example","tradingCountry":"AU","registeredAddress":{"type":"CustAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"},"contact":{"type":"CustBusinessContactAttributes","title":"example","firstName":"Ada Lovelace","lastName":"Ada Lovelace","emailAddress":"ada@example.com","supportEmailAddress":"ada@example.com","phoneNumber":"+61400000000"},"timeZone":"example","brandName":"Ada Lovelace"}}],"type":"object","required":["type","businessProfile"],"properties":{"type":{"description":"Always `CustUpdateBusinessProfile`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CustUpdateBusinessProfile"]},"businessProfile":{"$ref":"#/components/schemas/CustBusinessProfileReplace"}}},"CustUpdateEmailAddress":{"title":"CustUpdateEmailAddress","description":"Change the customer's email address.","examples":[{"type":"CustUpdateEmailAddress","emailAddress":"ada@example.com"}],"type":"object","required":["type","emailAddress"],"properties":{"type":{"description":"Always `CustUpdateEmailAddress`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CustUpdateEmailAddress"]},"emailAddress":{"type":"string"}}},"CustUpdateMetadata":{"title":"CustUpdateMetadata","description":"Replace an organisation customer's free-form data. Only for an organisation.","examples":[{"type":"CustUpdateMetadata","metadata":{"yourKey":{}}}],"type":"object","required":["type","metadata"],"properties":{"type":{"description":"Always `CustUpdateMetadata`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CustUpdateMetadata"]},"metadata":{"$ref":"#/components/schemas/Metadata","description":"Free-form data the platform stores and returns untouched. Values may be nested objects and arrays."}}},"CustUpdateName":{"title":"CustUpdateName","description":"NOT IMPLEMENTED: Change the customer's name. Declared so it can be designed against and argued about; answers 501 today. Blocked on: No targeted operation. The only path is `upsertConsumerCustomer`, which is what `POST /customers` already is, keyed on `referenceCustomerId` and idempotent. A PATCH arm that secretly performed an upsert would be a create wearing a patch's clothes, so this waits for a real rename operation.","examples":[{"type":"CustUpdateName","givenName":"Ada Lovelace","middleName":"Ada Lovelace","familyName":"Ada Lovelace","organisationName":"Ada Lovelace"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `CustUpdateName`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CustUpdateName"]},"givenName":{"type":"string"},"middleName":{"type":"string"},"familyName":{"type":"string"},"organisationName":{"type":"string"}}},"CustUpdateOrganisation":{"title":"CustUpdateOrganisation","description":"Point an organisation customer at another existing organisation, for example where a duplicate record was made by mistake. It must be one you can read on `/organisations`. The organisation it leaves is kept as it is.","examples":[{"type":"CustUpdateOrganisation","organisationId":"org_9f2Kd8QpLzXw"}],"type":"object","required":["type","organisationId"],"properties":{"type":{"description":"Always `CustUpdateOrganisation`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CustUpdateOrganisation"]},"organisationId":{"$ref":"#/components/schemas/OrgId","description":"Identifier of an organisation: a business's legal record, shared by every merchant, customer and owner that is that business."}}},"CustUpdatePhoneNumber":{"title":"CustUpdatePhoneNumber","description":"Change the customer's phone number.","examples":[{"type":"CustUpdatePhoneNumber","phoneNumber":"+61400000000"}],"type":"object","required":["type","phoneNumber"],"properties":{"type":{"description":"Always `CustUpdatePhoneNumber`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CustUpdatePhoneNumber"]},"phoneNumber":{"type":"string"}}},"CustUpdateResetKycAttempts":{"title":"CustUpdateResetKycAttempts","description":"Clear the customer's failed identity-verification counters so they may try again. Platform administrators only.","examples":[{"type":"CustUpdateResetKycAttempts"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `CustUpdateResetKycAttempts`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CustUpdateResetKycAttempts"]}}},"CustUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/CustUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"CustUpdateRspAttributes":"#/components/schemas/CustUpdateRspAttributes"}}},"CustUpdateRspAttributes":{"title":"CustUpdateRspAttributes","examples":[{"type":"CustUpdateRspAttributes","updated":{"type":"CustViewConsumer","customerId":"cust_9f2Kd8QpLzXw","personId":"pson_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","marketplaceId":"mktp_9f2Kd8QpLzXw","referenceCustomerId":"your-own-reference","givenName":"Ada Lovelace","middleName":"Ada Lovelace","familyName":"Ada Lovelace","emailAddress":"ada@example.com","phoneNumber":"+61400000000","isVerified":true,"kycAttempts":{"type":"CustKycAttemptsAttributes","withoutDocument":1250,"withDriversLicence":1250,"withPassport":1250,"withDriversLicenceAndPassport":1250,"level":"example"},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `CustUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CustUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/CustView","description":"The resource as it stands after the change."}}},"CustView":{"oneOf":[{"$ref":"#/components/schemas/CustViewConsumer"},{"$ref":"#/components/schemas/CustViewOrganisation"}],"discriminator":{"propertyName":"type","mapping":{"CustViewConsumer":"#/components/schemas/CustViewConsumer","CustViewOrganisation":"#/components/schemas/CustViewOrganisation"}}},"CustViewConsumer":{"title":"CustViewConsumer","description":"A person buying for themselves.","examples":[{"type":"CustViewConsumer","customerId":"cust_9f2Kd8QpLzXw","personId":"pson_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","marketplaceId":"mktp_9f2Kd8QpLzXw","referenceCustomerId":"your-own-reference","givenName":"Ada Lovelace","middleName":"Ada Lovelace","familyName":"Ada Lovelace","emailAddress":"ada@example.com","phoneNumber":"+61400000000","isVerified":true,"kycAttempts":{"type":"CustKycAttemptsAttributes","withoutDocument":1250,"withDriversLicence":1250,"withPassport":1250,"withDriversLicenceAndPassport":1250,"level":"example"},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","customerId","personId","merchantId","isVerified","createdAt","updatedAt"],"properties":{"type":{"description":"Always `CustViewConsumer`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CustViewConsumer"]},"customerId":{"$ref":"#/components/schemas/CustId","description":"Identifier of a customer."},"personId":{"$ref":"#/components/schemas/PsonId","description":"The person this customer is, read at `GET /persons/{personId}`."},"merchantId":{"type":"string"},"marketplaceId":{"description":"The marketplace the merchant sits under, where there is one.","type":"string"},"referenceCustomerId":{"type":"string"},"givenName":{"type":"string"},"middleName":{"type":"string"},"familyName":{"description":"Absent when the caller may not see personal data, see the note on this view.","type":"string"},"emailAddress":{"description":"Absent when the caller may not see personal data.","type":"string"},"phoneNumber":{"type":"string"},"isVerified":{"description":"Whether the customer's contact details have been verified.","type":"boolean"},"kycAttempts":{"$ref":"#/components/schemas/CustKycAttempts","description":"Identity checks attempted against this customer, by the evidence they were run with."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"CustViewOrganisation":{"title":"CustViewOrganisation","description":"A business buying on account, with its own legal identity and KYB state.","examples":[{"type":"CustViewOrganisation","customerId":"cust_9f2Kd8QpLzXw","organisationId":"org_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","marketplaceId":"mktp_9f2Kd8QpLzXw","referenceCustomerId":"your-own-reference","organisationName":"Ada Lovelace","taxId":"abc123","businessProfile":{"type":"CustBusinessProfileAttributes","legalName":"Ada Lovelace","businessRegistrationNumber":"example","taxRegistrationNumber":"example","businessType":"Company","companyType":"example","industry":"example","website":"example","supportSite":"example","taxCountry":"AU","tradingCountry":"AU","registeredAddress":{"type":"CustAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"},"contact":{"type":"CustBusinessContactAttributes","title":"example","firstName":"Ada Lovelace","lastName":"Ada Lovelace","emailAddress":"ada@example.com","supportEmailAddress":"ada@example.com","phoneNumber":"+61400000000"},"timeZone":"example"},"emailAddress":"ada@example.com","phoneNumber":"+61400000000","isVerified":true,"organisationKyced":true,"organisationCreditChecked":true,"kycAttempts":{"type":"CustKycAttemptsAttributes","withoutDocument":1250,"withDriversLicence":1250,"withPassport":1250,"withDriversLicenceAndPassport":1250,"level":"example"},"metadata":{"yourKey":{}},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","customerId","organisationId","merchantId","referenceCustomerId","organisationName","taxId","isVerified","organisationKyced","organisationCreditChecked","createdAt","updatedAt"],"properties":{"type":{"description":"Always `CustViewOrganisation`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CustViewOrganisation"]},"customerId":{"$ref":"#/components/schemas/CustId","description":"Identifier of a customer."},"organisationId":{"$ref":"#/components/schemas/OrgId","description":"The organisation this customer is, read at `GET /organisations/{organisationId}`."},"merchantId":{"type":"string"},"marketplaceId":{"description":"The marketplace the merchant sits under, where there is one.","type":"string"},"referenceCustomerId":{"description":"Required on an organisation, unlike on a consumer, the domain makes it so.","type":"string"},"organisationName":{"description":"Registered legal name of the organisation.","type":"string"},"taxId":{"type":"string"},"businessProfile":{"$ref":"#/components/schemas/CustBusinessProfile"},"emailAddress":{"description":"Absent when the caller may not see personal data.","type":"string"},"phoneNumber":{"type":"string"},"isVerified":{"description":"Whether the customer's contact details have been verified.","type":"boolean"},"organisationKyced":{"description":"Whether the organisation itself has passed KYB.","type":"boolean"},"organisationCreditChecked":{"description":"Whether a credit check has been run against the organisation.","type":"boolean"},"kycAttempts":{"$ref":"#/components/schemas/CustKycAttempts","description":"Identity checks attempted, by the evidence they were run with."},"metadata":{"$ref":"#/components/schemas/Metadata","description":"Free-form data the platform stores and returns untouched. Values may be nested objects and arrays."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"CustdApproval":{"description":"An approval that has been asked for. The link is emailed to the approver.","oneOf":[{"$ref":"#/components/schemas/CustdApprovalAttributes"}],"discriminator":{"propertyName":"type","mapping":{"CustdApprovalAttributes":"#/components/schemas/CustdApprovalAttributes"}}},"CustdApprovalAttributes":{"title":"CustdApprovalAttributes","description":"An approval that has been asked for. The link is emailed to the approver.","examples":[{"type":"CustdApprovalAttributes","magicLink":"example","token":"tok_9f2Kd8QpLzXwR4mN"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `CustdApprovalAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CustdApprovalAttributes"]},"magicLink":{"description":"Non-production only. The link emailed to the approver, following it approves the addition.","type":"string"},"token":{"description":"Non-production only. The token the link carries.","type":"string"}}},"CustdCmd":{"oneOf":[{"$ref":"#/components/schemas/CustdCmdApproveAddition"},{"$ref":"#/components/schemas/CustdCmdRequestAddition"},{"$ref":"#/components/schemas/CustdCmdUpsert"}],"discriminator":{"propertyName":"type","mapping":{"CustdCmdApproveAddition":"#/components/schemas/CustdCmdApproveAddition","CustdCmdRequestAddition":"#/components/schemas/CustdCmdRequestAddition","CustdCmdUpsert":"#/components/schemas/CustdCmdUpsert"}}},"CustdCmdApproveAddition":{"title":"CustdCmdApproveAddition","description":"Approve a delegate addition you were emailed a link for. The link's token says what is being approved.","examples":[{"type":"CustdCmdApproveAddition"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `CustdCmdApproveAddition`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CustdCmdApproveAddition"]}}},"CustdCmdRequestAddition":{"title":"CustdCmdRequestAddition","description":"Ask the customer's existing delegates to approve adding a new one. Does not add them, the approval does.","examples":[{"type":"CustdCmdRequestAddition","customerId":"cust_9f2Kd8QpLzXw","prospectToken":"tok_9f2Kd8QpLzXwR4mN","givenName":"Ada Lovelace","familyName":"Ada Lovelace","position":"example"}],"type":"object","required":["type","customerId","prospectToken","familyName"],"properties":{"type":{"description":"Always `CustdCmdRequestAddition`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CustdCmdRequestAddition"]},"customerId":{"$ref":"#/components/schemas/CustId","description":"Identifier of a customer."},"prospectToken":{"description":"Token accumulating the prospective organisation customer's details through onboarding.","type":"string"},"givenName":{"type":"string"},"familyName":{"type":"string"},"position":{"description":"What the delegate will be to this customer, a director, a finance contact.","type":"string"}}},"CustdCmdUpsert":{"title":"CustdCmdUpsert","description":"Add a delegate to a customer. Adding an existing person to another customer links them.","examples":[{"type":"CustdCmdUpsert","customerId":"cust_9f2Kd8QpLzXw","emailAddress":"ada@example.com","displayName":"Ada Lovelace","phoneNumber":"+61400000000","position":"example"}],"type":"object","required":["type","customerId","emailAddress"],"properties":{"type":{"description":"Always `CustdCmdUpsert`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CustdCmdUpsert"]},"customerId":{"$ref":"#/components/schemas/CustId","description":"Identifier of a customer."},"emailAddress":{"type":"string"},"displayName":{"description":"The delegate's name. Defaults to the organisation's name plus `-delegate-user`.","type":"string"},"phoneNumber":{"type":"string"},"position":{"description":"What the delegate is to this customer, a director, a finance contact.","type":"string"}}},"CustdColumn":{"title":"CustdColumn","type":"string","enum":["DelegateId","DisplayName","EmailAddress","PhoneNumber","Status","CreatedAt","UpdatedAt"]},"CustdCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/CustdCreateRspApprovalRequested"},{"$ref":"#/components/schemas/CustdCreateRspDelegate"}],"discriminator":{"propertyName":"type","mapping":{"CustdCreateRspApprovalRequested":"#/components/schemas/CustdCreateRspApprovalRequested","CustdCreateRspDelegate":"#/components/schemas/CustdCreateRspDelegate"}}},"CustdCreateRspApprovalRequested":{"title":"CustdCreateRspApprovalRequested","description":"The customer's existing delegates have been asked to approve. No delegate exists yet.","examples":[{"type":"CustdCreateRspApprovalRequested","approvals":[{"type":"CustdApprovalAttributes","magicLink":"example","token":"tok_9f2Kd8QpLzXwR4mN"}]}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `CustdCreateRspApprovalRequested`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CustdCreateRspApprovalRequested"]},"approvals":{"description":"One per delegate asked. The link is emailed to them; it appears here only outside production.","type":"array","items":{"$ref":"#/components/schemas/CustdApproval"}}}},"CustdCreateRspDelegate":{"title":"CustdCreateRspDelegate","description":"The delegate, as it now stands.","examples":[{"type":"CustdCreateRspDelegate","created":{"type":"CustdViewAttributes","delegateId":"custd_9f2Kd8QpLzXw","displayName":"Ada Lovelace","emailAddress":"ada@example.com","phoneNumber":"+61400000000","status":"Enabled","customers":[{"type":"CustdCustomerRefAttributes","customerId":"cust_9f2Kd8QpLzXw","position":"example","loanRole":{"type":"CustdLoanRoleCardUser","viewAllTransactions":true,"canCreateCards":true,"loanIds":["loan_9f2Kd8QpLzXw"]}}],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `CustdCreateRspDelegate`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CustdCreateRspDelegate"]},"created":{"$ref":"#/components/schemas/CustdView","description":"A person authorised to act for one or more organisation customers."}}},"CustdCustomerRef":{"description":"One customer a delegate acts for, and what they may do for it.","oneOf":[{"$ref":"#/components/schemas/CustdCustomerRefAttributes"}],"discriminator":{"propertyName":"type","mapping":{"CustdCustomerRefAttributes":"#/components/schemas/CustdCustomerRefAttributes"}}},"CustdCustomerRefAttributes":{"title":"CustdCustomerRefAttributes","description":"One customer a delegate acts for, and what they may do for it.","examples":[{"type":"CustdCustomerRefAttributes","customerId":"cust_9f2Kd8QpLzXw","position":"example","loanRole":{"type":"CustdLoanRoleCardUser","viewAllTransactions":true,"canCreateCards":true,"loanIds":["loan_9f2Kd8QpLzXw"]}}],"type":"object","required":["type","customerId"],"properties":{"type":{"description":"Always `CustdCustomerRefAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CustdCustomerRefAttributes"]},"customerId":{"$ref":"#/components/schemas/CustId","description":"Identifier of a customer."},"position":{"description":"What the delegate is to this customer, a director, a finance contact.","type":"string"},"loanRole":{"$ref":"#/components/schemas/CustdLoanRole","description":"What the delegate may do on this customer's loans."}}},"CustdId":{"title":"CustdId","description":"Identifier of a customer delegate.","examples":["custd_9f2Kd8QpLzXw"],"type":"string"},"CustdLoanRole":{"oneOf":[{"$ref":"#/components/schemas/CustdLoanRoleCardUser"},{"$ref":"#/components/schemas/CustdLoanRoleFinance"},{"$ref":"#/components/schemas/CustdLoanRoleSuperAdmin"}],"discriminator":{"propertyName":"type","mapping":{"CustdLoanRoleCardUser":"#/components/schemas/CustdLoanRoleCardUser","CustdLoanRoleFinance":"#/components/schemas/CustdLoanRoleFinance","CustdLoanRoleSuperAdmin":"#/components/schemas/CustdLoanRoleSuperAdmin"}}},"CustdLoanRoleCardUser":{"title":"CustdLoanRoleCardUser","description":"Card user, with access to named loans.","examples":[{"type":"CustdLoanRoleCardUser","viewAllTransactions":true,"canCreateCards":true,"loanIds":["loan_9f2Kd8QpLzXw"]}],"type":"object","required":["type","viewAllTransactions","canCreateCards"],"properties":{"type":{"description":"Always `CustdLoanRoleCardUser`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CustdLoanRoleCardUser"]},"viewAllTransactions":{"description":"Whether this delegate sees every transaction on the loans they can access, or only their own.","type":"boolean"},"canCreateCards":{"type":"boolean"},"loanIds":{"description":"The loans this delegate may act on. Empty means none.","type":"array","items":{"type":"string"}}}},"CustdLoanRoleFinance":{"title":"CustdLoanRoleFinance","description":"Finance contact.","examples":[{"type":"CustdLoanRoleFinance","canCreateCards":true}],"type":"object","required":["type","canCreateCards"],"properties":{"type":{"description":"Always `CustdLoanRoleFinance`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CustdLoanRoleFinance"]},"canCreateCards":{"description":"Whether this delegate may issue cards against the customer's loans.","type":"boolean"}}},"CustdLoanRoleSuperAdmin":{"title":"CustdLoanRoleSuperAdmin","description":"Full control of the customer's loans.","examples":[{"type":"CustdLoanRoleSuperAdmin"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `CustdLoanRoleSuperAdmin`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CustdLoanRoleSuperAdmin"]}}},"CustdPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/CustdPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"CustdPageAttributes":"#/components/schemas/CustdPageAttributes"}}},"CustdPageAttributes":{"title":"CustdPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"CustdPageAttributes","data":[{"type":"CustdViewAttributes","delegateId":"custd_9f2Kd8QpLzXw","displayName":"Ada Lovelace","emailAddress":"ada@example.com","phoneNumber":"+61400000000","status":"Enabled","customers":[{"type":"CustdCustomerRefAttributes","customerId":"cust_9f2Kd8QpLzXw","position":"example","loanRole":{"type":"CustdLoanRoleCardUser","viewAllTransactions":true,"canCreateCards":true,"loanIds":["loan_9f2Kd8QpLzXw"]}}],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `CustdPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CustdPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/CustdView","description":"A person authorised to act for one or more organisation customers."}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"CustdSort":{"title":"CustdSort","type":"string","enum":["createdAt","-createdAt","updatedAt","-updatedAt"]},"CustdStatus":{"title":"CustdStatus","type":"string","enum":["Enabled","Disabled","Unknown"]},"CustdUpdate":{"oneOf":[{"$ref":"#/components/schemas/CustdUpdateEmailAddress"},{"$ref":"#/components/schemas/CustdUpdateLinkCustomer"},{"$ref":"#/components/schemas/CustdUpdateLoanRole"},{"$ref":"#/components/schemas/CustdUpdateName"},{"$ref":"#/components/schemas/CustdUpdatePhoneNumber"},{"$ref":"#/components/schemas/CustdUpdatePosition"},{"$ref":"#/components/schemas/CustdUpdateUnlinkCustomer"}],"discriminator":{"propertyName":"type","mapping":{"CustdUpdateEmailAddress":"#/components/schemas/CustdUpdateEmailAddress","CustdUpdateLinkCustomer":"#/components/schemas/CustdUpdateLinkCustomer","CustdUpdateLoanRole":"#/components/schemas/CustdUpdateLoanRole","CustdUpdateName":"#/components/schemas/CustdUpdateName","CustdUpdatePhoneNumber":"#/components/schemas/CustdUpdatePhoneNumber","CustdUpdatePosition":"#/components/schemas/CustdUpdatePosition","CustdUpdateUnlinkCustomer":"#/components/schemas/CustdUpdateUnlinkCustomer"}}},"CustdUpdateEmailAddress":{"title":"CustdUpdateEmailAddress","description":"Change the delegate's email address.","examples":[{"type":"CustdUpdateEmailAddress","emailAddress":"ada@example.com"}],"type":"object","required":["type","emailAddress"],"properties":{"type":{"description":"Always `CustdUpdateEmailAddress`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CustdUpdateEmailAddress"]},"emailAddress":{"type":"string"}}},"CustdUpdateLinkCustomer":{"title":"CustdUpdateLinkCustomer","description":"Let this delegate act for another customer too.","examples":[{"type":"CustdUpdateLinkCustomer","customerId":"cust_9f2Kd8QpLzXw"}],"type":"object","required":["type","customerId"],"properties":{"type":{"description":"Always `CustdUpdateLinkCustomer`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CustdUpdateLinkCustomer"]},"customerId":{"$ref":"#/components/schemas/CustId","description":"Identifier of a customer."}}},"CustdUpdateLoanRole":{"title":"CustdUpdateLoanRole","description":"Change what the delegate may do on one customer's loans.","examples":[{"type":"CustdUpdateLoanRole","customerId":"cust_9f2Kd8QpLzXw","loanRole":{"type":"CustdLoanRoleCardUser","viewAllTransactions":true,"canCreateCards":true,"loanIds":["loan_9f2Kd8QpLzXw"]}}],"type":"object","required":["type","customerId","loanRole"],"properties":{"type":{"description":"Always `CustdUpdateLoanRole`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CustdUpdateLoanRole"]},"customerId":{"$ref":"#/components/schemas/CustId","description":"Identifier of a customer."},"loanRole":{"$ref":"#/components/schemas/CustdLoanRole"}}},"CustdUpdateName":{"title":"CustdUpdateName","description":"Change the delegate's display name.","examples":[{"type":"CustdUpdateName","name":"Ada Lovelace"}],"type":"object","required":["type","name"],"properties":{"type":{"description":"Always `CustdUpdateName`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CustdUpdateName"]},"name":{"type":"string"}}},"CustdUpdatePhoneNumber":{"title":"CustdUpdatePhoneNumber","description":"Change the delegate's phone number.","examples":[{"type":"CustdUpdatePhoneNumber","phoneNumber":"+61400000000"}],"type":"object","required":["type","phoneNumber"],"properties":{"type":{"description":"Always `CustdUpdatePhoneNumber`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CustdUpdatePhoneNumber"]},"phoneNumber":{"type":"string"}}},"CustdUpdatePosition":{"title":"CustdUpdatePosition","description":"Change what the delegate's position is at one customer.","examples":[{"type":"CustdUpdatePosition","customerId":"cust_9f2Kd8QpLzXw","position":"example"}],"type":"object","required":["type","customerId","position"],"properties":{"type":{"description":"Always `CustdUpdatePosition`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CustdUpdatePosition"]},"customerId":{"$ref":"#/components/schemas/CustId","description":"Identifier of a customer."},"position":{"type":"string"}}},"CustdUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/CustdUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"CustdUpdateRspAttributes":"#/components/schemas/CustdUpdateRspAttributes"}}},"CustdUpdateRspAttributes":{"title":"CustdUpdateRspAttributes","examples":[{"type":"CustdUpdateRspAttributes","updated":{"type":"CustdViewAttributes","delegateId":"custd_9f2Kd8QpLzXw","displayName":"Ada Lovelace","emailAddress":"ada@example.com","phoneNumber":"+61400000000","status":"Enabled","customers":[{"type":"CustdCustomerRefAttributes","customerId":"cust_9f2Kd8QpLzXw","position":"example","loanRole":{"type":"CustdLoanRoleCardUser","viewAllTransactions":true,"canCreateCards":true,"loanIds":["loan_9f2Kd8QpLzXw"]}}],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `CustdUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CustdUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/CustdView","description":"The resource as it stands after the change."}}},"CustdUpdateUnlinkCustomer":{"title":"CustdUpdateUnlinkCustomer","description":"Stop this delegate acting for one of the customers they are linked to.","examples":[{"type":"CustdUpdateUnlinkCustomer","customerId":"cust_9f2Kd8QpLzXw"}],"type":"object","required":["type","customerId"],"properties":{"type":{"description":"Always `CustdUpdateUnlinkCustomer`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CustdUpdateUnlinkCustomer"]},"customerId":{"$ref":"#/components/schemas/CustId","description":"Identifier of a customer."}}},"CustdView":{"oneOf":[{"$ref":"#/components/schemas/CustdViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"CustdViewAttributes":"#/components/schemas/CustdViewAttributes"}}},"CustdViewAttributes":{"title":"CustdViewAttributes","description":"A person authorised to act for one or more organisation customers.","examples":[{"type":"CustdViewAttributes","delegateId":"custd_9f2Kd8QpLzXw","displayName":"Ada Lovelace","emailAddress":"ada@example.com","phoneNumber":"+61400000000","status":"Enabled","customers":[{"type":"CustdCustomerRefAttributes","customerId":"cust_9f2Kd8QpLzXw","position":"example","loanRole":{"type":"CustdLoanRoleCardUser","viewAllTransactions":true,"canCreateCards":true,"loanIds":["loan_9f2Kd8QpLzXw"]}}],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","delegateId","displayName","emailAddress","status","createdAt","updatedAt"],"properties":{"type":{"description":"Always `CustdViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CustdViewAttributes"]},"delegateId":{"$ref":"#/components/schemas/CustdId"},"displayName":{"description":"The delegate's name as the platform holds it, one field, not a given/family pair.","type":"string"},"emailAddress":{"type":"string"},"phoneNumber":{"type":"string"},"status":{"$ref":"#/components/schemas/CustdStatus"},"customers":{"description":"The customers this delegate acts for, and what they may do for each.","type":"array","items":{"$ref":"#/components/schemas/CustdCustomerRef"}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"Custkey":{"description":"A customer's new API key. Returned once, it cannot be read back, listed, or revoked.","oneOf":[{"$ref":"#/components/schemas/CustkeyAttributes"}],"discriminator":{"propertyName":"type","mapping":{"CustkeyAttributes":"#/components/schemas/CustkeyAttributes"}}},"CustkeyAttributes":{"title":"CustkeyAttributes","description":"A customer's new API key. Returned once, it cannot be read back, listed, or revoked.","examples":[{"type":"CustkeyAttributes","customerId":"cust_9f2Kd8QpLzXw","apiKey":"example"}],"type":"object","required":["type","customerId","apiKey"],"properties":{"type":{"description":"Always `CustkeyAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CustkeyAttributes"]},"customerId":{"$ref":"#/components/schemas/CustId","description":"Identifier of a customer."},"apiKey":{"description":"The key. Store it now: nothing returns it again, and nothing can take it away.","type":"string"}}},"CustkeyCmd":{"oneOf":[{"$ref":"#/components/schemas/CustkeyCmdIssue"}],"discriminator":{"propertyName":"type","mapping":{"CustkeyCmdIssue":"#/components/schemas/CustkeyCmdIssue"}}},"CustkeyCmdIssue":{"title":"CustkeyCmdIssue","description":"Issue an API key to a customer. The key is returned once, here, and never again.","examples":[{"type":"CustkeyCmdIssue","customerId":"cust_9f2Kd8QpLzXw"}],"type":"object","required":["type","customerId"],"properties":{"type":{"description":"Always `CustkeyCmdIssue`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CustkeyCmdIssue"]},"customerId":{"$ref":"#/components/schemas/CustId","description":"Identifier of a customer."}}},"CvrfColumn":{"title":"CvrfColumn","type":"string","enum":["StateVerified","StateExpired","StateFailedAttempts","StateLastFailedAt","StateCodeGeneratedAt","StateOutstandingCode","StateCreatedAt","StateUpdatedAt"]},"CvrfPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/CvrfPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"CvrfPageAttributes":"#/components/schemas/CvrfPageAttributes"}}},"CvrfPageAttributes":{"title":"CvrfPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"CvrfPageAttributes","data":[{"type":"CvrfViewAttributes","subject":{"type":"CvrfSubjectEmail","emailAddress":"ada@example.com"},"state":{"type":"CvrfStateAttributes","verified":true,"expired":true,"failedAttempts":1250,"lastFailedAt":"2026-08-19T04:21:07Z","codeGeneratedAt":"2026-08-19T04:21:07Z","outstandingCode":"example","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `CvrfPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CvrfPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/CvrfView","description":"The one-time-code state held against one contact detail."}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"CvrfState":{"description":"Absent where no verification has ever been attempted against this contact detail.","oneOf":[{"$ref":"#/components/schemas/CvrfStateAttributes"}],"discriminator":{"propertyName":"type","mapping":{"CvrfStateAttributes":"#/components/schemas/CvrfStateAttributes"}}},"CvrfStateAttributes":{"title":"CvrfStateAttributes","description":"Where a verification has got to. Includes the live code, administrators only.","examples":[{"type":"CvrfStateAttributes","verified":true,"expired":true,"failedAttempts":1250,"lastFailedAt":"2026-08-19T04:21:07Z","codeGeneratedAt":"2026-08-19T04:21:07Z","outstandingCode":"example","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","verified","expired","failedAttempts","codeGeneratedAt","outstandingCode","createdAt","updatedAt"],"properties":{"type":{"description":"Always `CvrfStateAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CvrfStateAttributes"]},"verified":{"description":"The contact detail has been verified.","type":"boolean"},"expired":{"description":"The outstanding code has passed its lifetime and will no longer be accepted.","type":"boolean"},"failedAttempts":{"description":"Failed attempts since the last success. Enough of them and the platform stops accepting codes until this is reset.","type":"integer","format":"int32"},"lastFailedAt":{"type":"string","format":"date-time"},"codeGeneratedAt":{"description":"When the outstanding code was generated.","type":"string","format":"date-time"},"outstandingCode":{"description":"The live code itself. Anyone holding this can pass the verification.","type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"CvrfSubject":{"oneOf":[{"$ref":"#/components/schemas/CvrfSubjectEmail"},{"$ref":"#/components/schemas/CvrfSubjectPhone"}],"discriminator":{"propertyName":"type","mapping":{"CvrfSubjectEmail":"#/components/schemas/CvrfSubjectEmail","CvrfSubjectPhone":"#/components/schemas/CvrfSubjectPhone"}}},"CvrfSubjectEmail":{"title":"CvrfSubjectEmail","description":"An email address.","examples":[{"type":"CvrfSubjectEmail","emailAddress":"ada@example.com"}],"type":"object","required":["type","emailAddress"],"properties":{"type":{"description":"Always `CvrfSubjectEmail`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CvrfSubjectEmail"]},"emailAddress":{"type":"string"}}},"CvrfSubjectPhone":{"title":"CvrfSubjectPhone","description":"A phone number.","examples":[{"type":"CvrfSubjectPhone","phoneNumber":"+61400000000"}],"type":"object","required":["type","phoneNumber"],"properties":{"type":{"description":"Always `CvrfSubjectPhone`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CvrfSubjectPhone"]},"phoneNumber":{"description":"E.164 format, e.g. +61400000000.","type":"string"}}},"CvrfUpdate":{"oneOf":[{"$ref":"#/components/schemas/CvrfUpdateResetEmail"},{"$ref":"#/components/schemas/CvrfUpdateResetPhone"}],"discriminator":{"propertyName":"type","mapping":{"CvrfUpdateResetEmail":"#/components/schemas/CvrfUpdateResetEmail","CvrfUpdateResetPhone":"#/components/schemas/CvrfUpdateResetPhone"}}},"CvrfUpdateResetEmail":{"title":"CvrfUpdateResetEmail","description":"Reset the verification held against an email address: clears the failed attempts and issues a new code.","examples":[{"type":"CvrfUpdateResetEmail","emailAddress":"ada@example.com"}],"type":"object","required":["type","emailAddress"],"properties":{"type":{"description":"Always `CvrfUpdateResetEmail`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CvrfUpdateResetEmail"]},"emailAddress":{"type":"string"}}},"CvrfUpdateResetPhone":{"title":"CvrfUpdateResetPhone","description":"Reset the verification held against a phone number: clears the failed attempts and issues a new code.","examples":[{"type":"CvrfUpdateResetPhone","phoneNumber":"+61400000000"}],"type":"object","required":["type","phoneNumber"],"properties":{"type":{"description":"Always `CvrfUpdateResetPhone`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CvrfUpdateResetPhone"]},"phoneNumber":{"description":"E.164 format, e.g. +61400000000.","type":"string"}}},"CvrfUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/CvrfUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"CvrfUpdateRspAttributes":"#/components/schemas/CvrfUpdateRspAttributes"}}},"CvrfUpdateRspAttributes":{"title":"CvrfUpdateRspAttributes","examples":[{"type":"CvrfUpdateRspAttributes","updated":{"type":"CvrfViewAttributes","subject":{"type":"CvrfSubjectEmail","emailAddress":"ada@example.com"},"state":{"type":"CvrfStateAttributes","verified":true,"expired":true,"failedAttempts":1250,"lastFailedAt":"2026-08-19T04:21:07Z","codeGeneratedAt":"2026-08-19T04:21:07Z","outstandingCode":"example","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `CvrfUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CvrfUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/CvrfView","description":"The resource as it stands after the change."}}},"CvrfView":{"oneOf":[{"$ref":"#/components/schemas/CvrfViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"CvrfViewAttributes":"#/components/schemas/CvrfViewAttributes"}}},"CvrfViewAttributes":{"title":"CvrfViewAttributes","description":"The one-time-code state held against one contact detail.","examples":[{"type":"CvrfViewAttributes","subject":{"type":"CvrfSubjectEmail","emailAddress":"ada@example.com"},"state":{"type":"CvrfStateAttributes","verified":true,"expired":true,"failedAttempts":1250,"lastFailedAt":"2026-08-19T04:21:07Z","codeGeneratedAt":"2026-08-19T04:21:07Z","outstandingCode":"example","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","subject"],"properties":{"type":{"description":"Always `CvrfViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["CvrfViewAttributes"]},"subject":{"$ref":"#/components/schemas/CvrfSubject"},"state":{"$ref":"#/components/schemas/CvrfState"}}},"DcfrColumn":{"title":"DcfrColumn","type":"string","enum":["DailyCardFileRunId","RequestReference","CustomerId","CustomerCode","CustomerName","DailyDate","Timezone","EdiAlias","Currency","TransactionCount","DealStatus","FileStatus","ProcessingStartedAt","ProcessingEndedAt","ErrorMessage","Deleted","DeleteReason","RegeneratedAsRunId","PreviousRunId","FileVersion","AutoGenerate","CreatedAt","UpdatedAt"]},"DcfrDealStatus":{"title":"DcfrDealStatus","type":"string","enum":["Pending","Processing","Processed","Failed","Unknown"]},"DcfrFileStatus":{"title":"DcfrFileStatus","type":"string","enum":["Pending","Generated","GenerationFailed","NotRequired","Unknown"]},"DcfrFormat":{"title":"DcfrFormat","type":"string","enum":["Cdf3"]},"DcfrId":{"title":"DcfrId","description":"Identifier of a run of the daily card file.","examples":["dcfr_9f2Kd8QpLzXw"],"type":"string"},"DcfrLoan":{"description":"One loan's part of a daily card file run: how its transactions were paged and where its processing got to.","oneOf":[{"$ref":"#/components/schemas/DcfrLoanAttributes"}],"discriminator":{"propertyName":"type","mapping":{"DcfrLoanAttributes":"#/components/schemas/DcfrLoanAttributes"}}},"DcfrLoanAttributes":{"title":"DcfrLoanAttributes","description":"One loan's part of a daily card file run: how its transactions were paged and where its processing got to.","examples":[{"type":"DcfrLoanAttributes","loanId":"loan_9f2Kd8QpLzXw","loanAccountNumber":"example","loanAccountName":"Ada Lovelace","ediNumber":"example","dailyDate":"2026-08-19","dealStatus":"Pending","dealtAt":"2026-08-19T04:21:07Z","rowsCount":42,"errorMessage":"example","currency":"AUD","deleted":true}],"type":"object","required":["type","loanId","dailyDate","dealStatus","rowsCount","currency","deleted"],"properties":{"type":{"description":"Always `DcfrLoanAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["DcfrLoanAttributes"]},"loanId":{"$ref":"#/components/schemas/LoanId","description":"Identifier of a loan."},"loanAccountNumber":{"type":"string"},"loanAccountName":{"type":"string"},"ediNumber":{"type":"string"},"dailyDate":{"type":"string","format":"date"},"dealStatus":{"$ref":"#/components/schemas/DcfrDealStatus"},"dealtAt":{"type":"string","format":"date-time"},"rowsCount":{"type":"integer","format":"int32"},"errorMessage":{"type":"string"},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"deleted":{"description":"Whether the loan's part was withdrawn with its run.","type":"boolean"}}},"DcfrPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/DcfrPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"DcfrPageAttributes":"#/components/schemas/DcfrPageAttributes"}}},"DcfrPageAttributes":{"title":"DcfrPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"DcfrPageAttributes","data":[{"type":"DcfrViewAttributes","dailyCardFileRunId":"dcfr_9f2Kd8QpLzXw","requestReference":"your-own-reference","customerId":"cust_9f2Kd8QpLzXw","customerCode":"example","customerName":"Ada Lovelace","dailyDate":"2026-08-19","timezone":"example","ediAlias":"example","currency":"AUD","transactionCount":42,"dealStatus":"Pending","fileStatus":"Pending","processingStartedAt":"2026-08-19T04:21:07Z","processingEndedAt":"2026-08-19T04:21:07Z","errorMessage":"example","deleted":true,"deleteReason":"Requested by the customer.","regeneratedAsRunId":"dcfr_9f2Kd8QpLzXw","previousRunId":"dcfr_9f2Kd8QpLzXw","fileVersion":"example","autoGenerate":true,"loans":[{"type":"DcfrLoanAttributes","loanId":"loan_9f2Kd8QpLzXw","loanAccountNumber":"example","loanAccountName":"Ada Lovelace","ediNumber":"example","dailyDate":"2026-08-19","dealStatus":"Pending","dealtAt":"2026-08-19T04:21:07Z","rowsCount":42,"errorMessage":"example","currency":"AUD","deleted":true}],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `DcfrPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["DcfrPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/DcfrView"}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"DcfrView":{"description":"One run of the daily card file for a customer and a day: the header the file is written from, where its generation got to, and the loans it covers. The card transactions are not kept: the file is written from the issuer's own.","oneOf":[{"$ref":"#/components/schemas/DcfrViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"DcfrViewAttributes":"#/components/schemas/DcfrViewAttributes"}}},"DcfrViewAttributes":{"title":"DcfrViewAttributes","description":"One run of the daily card file for a customer and a day: the header the file is written from, where its generation got to, and the loans it covers. The card transactions are not kept: the file is written from the issuer's own.","examples":[{"type":"DcfrViewAttributes","dailyCardFileRunId":"dcfr_9f2Kd8QpLzXw","requestReference":"your-own-reference","customerId":"cust_9f2Kd8QpLzXw","customerCode":"example","customerName":"Ada Lovelace","dailyDate":"2026-08-19","timezone":"example","ediAlias":"example","currency":"AUD","transactionCount":42,"dealStatus":"Pending","fileStatus":"Pending","processingStartedAt":"2026-08-19T04:21:07Z","processingEndedAt":"2026-08-19T04:21:07Z","errorMessage":"example","deleted":true,"deleteReason":"Requested by the customer.","regeneratedAsRunId":"dcfr_9f2Kd8QpLzXw","previousRunId":"dcfr_9f2Kd8QpLzXw","fileVersion":"example","autoGenerate":true,"loans":[{"type":"DcfrLoanAttributes","loanId":"loan_9f2Kd8QpLzXw","loanAccountNumber":"example","loanAccountName":"Ada Lovelace","ediNumber":"example","dailyDate":"2026-08-19","dealStatus":"Pending","dealtAt":"2026-08-19T04:21:07Z","rowsCount":42,"errorMessage":"example","currency":"AUD","deleted":true}],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","dailyCardFileRunId","requestReference","customerId","dailyDate","timezone","currency","transactionCount","dealStatus","fileStatus","processingStartedAt","deleted","autoGenerate","createdAt","updatedAt"],"properties":{"type":{"description":"Always `DcfrViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["DcfrViewAttributes"]},"dailyCardFileRunId":{"$ref":"#/components/schemas/DcfrId"},"requestReference":{"description":"APG's reference for the run, which makes it idempotent.","type":"string"},"customerId":{"$ref":"#/components/schemas/CustId","description":"Identifier of a customer."},"customerCode":{"type":"string"},"customerName":{"type":"string"},"dailyDate":{"description":"The day the file covers, in the run's `timezone`.","type":"string","format":"date"},"timezone":{"type":"string"},"ediAlias":{"type":"string"},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"transactionCount":{"type":"integer","format":"int32"},"dealStatus":{"$ref":"#/components/schemas/DcfrDealStatus"},"fileStatus":{"$ref":"#/components/schemas/DcfrFileStatus"},"processingStartedAt":{"type":"string","format":"date-time"},"processingEndedAt":{"type":"string","format":"date-time"},"errorMessage":{"type":"string"},"deleted":{"description":"A withdrawn run is kept, and names the run that replaced it.","type":"boolean"},"deleteReason":{"type":"string"},"regeneratedAsRunId":{"$ref":"#/components/schemas/DcfrId"},"previousRunId":{"$ref":"#/components/schemas/DcfrId"},"fileVersion":{"type":"string"},"autoGenerate":{"type":"boolean"},"loans":{"type":"array","items":{"$ref":"#/components/schemas/DcfrLoan"}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"DisputeAmounts":{"description":"What a dispute challenges. Both amounts are in the single currency given here.","oneOf":[{"$ref":"#/components/schemas/DisputeAmountsAttributes"}],"discriminator":{"propertyName":"type","mapping":{"DisputeAmountsAttributes":"#/components/schemas/DisputeAmountsAttributes"}}},"DisputeAmountsAttributes":{"title":"DisputeAmountsAttributes","description":"What a dispute challenges. Both amounts are in the single currency given here.","examples":[{"type":"DisputeAmountsAttributes","currency":"AUD","amount":1250,"transactionAmount":1250}],"type":"object","required":["type","currency","amount"],"properties":{"type":{"description":"Always `DisputeAmountsAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["DisputeAmountsAttributes"]},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"amount":{"$ref":"#/components/schemas/MinorUnits","description":"The amount being challenged."},"transactionAmount":{"$ref":"#/components/schemas/MinorUnits","description":"What the original transaction was for."}}},"DisputeColumn":{"title":"DisputeColumn","type":"string","enum":["DisputeId","MerchantId","CustomerCustomerId","CustomerName","CustomerEmailAddress","CustomerPhoneNumber","Status","GatewayState","AmountsCurrency","AmountsAmount","AmountsTransactionAmount","FeeAmountMinorCurrencyUnits","FeeAmountCurrency","Reason","Description","OrderId","ReferenceOrderId","EvidenceDueBy","CreatedAt","UpdatedAt"]},"DisputeId":{"title":"DisputeId","description":"Identifier of a dispute.","examples":["dispute_9f2Kd8QpLzXw"],"type":"string"},"DisputePage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/DisputePageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"DisputePageAttributes":"#/components/schemas/DisputePageAttributes"}}},"DisputePageAttributes":{"title":"DisputePageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"DisputePageAttributes","data":[{"type":"DisputeViewAttributes","disputeId":"dispute_9f2Kd8QpLzXw","subject":{"type":"RfndSubjectTransaction","transactionId":"tran_9f2Kd8QpLzXw"},"merchantId":"mcht_9f2Kd8QpLzXw","customer":{"type":"RfndCustomerAttributes","customerId":"cust_9f2Kd8QpLzXw","name":"Ada Lovelace","emailAddress":"ada@example.com","phoneNumber":"+61400000000"},"status":"Pending","gatewayState":"example","amounts":{"type":"DisputeAmountsAttributes","currency":"AUD","amount":1250,"transactionAmount":1250},"feeAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"reason":"Requested by the customer.","description":"A short description.","orderId":"ordr_9f2Kd8QpLzXw","referenceOrderId":"your-own-reference","orderMetadata":{"yourKey":{}},"evidenceDueBy":"2026-08-19","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `DisputePageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["DisputePageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/DisputeView","description":"A cardholder's challenge to a transaction, and the platform's response to it."}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"DisputeSort":{"title":"DisputeSort","type":"string","enum":["createdAt","-createdAt"]},"DisputeStatus":{"title":"DisputeStatus","type":"string","enum":["Pending","Won","Lost","Unknown"]},"DisputeUpdate":{"oneOf":[{"$ref":"#/components/schemas/DisputeUpdateLost"},{"$ref":"#/components/schemas/DisputeUpdateWon"}],"discriminator":{"propertyName":"type","mapping":{"DisputeUpdateLost":"#/components/schemas/DisputeUpdateLost","DisputeUpdateWon":"#/components/schemas/DisputeUpdateWon"}}},"DisputeUpdateLost":{"title":"DisputeUpdateLost","description":"Record that the dispute was lost. The funds go back to the cardholder.","examples":[{"type":"DisputeUpdateLost","gatewayState":"example","reverseFees":true}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `DisputeUpdateLost`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["DisputeUpdateLost"]},"gatewayState":{"type":"string"},"reverseFees":{"type":"boolean"}}},"DisputeUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/DisputeUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"DisputeUpdateRspAttributes":"#/components/schemas/DisputeUpdateRspAttributes"}}},"DisputeUpdateRspAttributes":{"title":"DisputeUpdateRspAttributes","examples":[{"type":"DisputeUpdateRspAttributes","updated":{"type":"DisputeViewAttributes","disputeId":"dispute_9f2Kd8QpLzXw","subject":{"type":"RfndSubjectTransaction","transactionId":"tran_9f2Kd8QpLzXw"},"merchantId":"mcht_9f2Kd8QpLzXw","customer":{"type":"RfndCustomerAttributes","customerId":"cust_9f2Kd8QpLzXw","name":"Ada Lovelace","emailAddress":"ada@example.com","phoneNumber":"+61400000000"},"status":"Pending","gatewayState":"example","amounts":{"type":"DisputeAmountsAttributes","currency":"AUD","amount":1250,"transactionAmount":1250},"feeAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"reason":"Requested by the customer.","description":"A short description.","orderId":"ordr_9f2Kd8QpLzXw","referenceOrderId":"your-own-reference","orderMetadata":{"yourKey":{}},"evidenceDueBy":"2026-08-19","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `DisputeUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["DisputeUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/DisputeView","description":"The resource as it stands after the change."}}},"DisputeUpdateWon":{"title":"DisputeUpdateWon","description":"Record that the dispute was won. The platform keeps the funds with the merchant.","examples":[{"type":"DisputeUpdateWon","gatewayState":"example","reverseFees":true}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `DisputeUpdateWon`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["DisputeUpdateWon"]},"gatewayState":{"description":"The gateway's own word for where the case now is.","type":"string"},"reverseFees":{"description":"Give the merchant back what the platform charged it for handling the dispute.","type":"boolean"}}},"DisputeView":{"oneOf":[{"$ref":"#/components/schemas/DisputeViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"DisputeViewAttributes":"#/components/schemas/DisputeViewAttributes"}}},"DisputeViewAttributes":{"title":"DisputeViewAttributes","description":"A cardholder's challenge to a transaction, and the platform's response to it.","examples":[{"type":"DisputeViewAttributes","disputeId":"dispute_9f2Kd8QpLzXw","subject":{"type":"RfndSubjectTransaction","transactionId":"tran_9f2Kd8QpLzXw"},"merchantId":"mcht_9f2Kd8QpLzXw","customer":{"type":"RfndCustomerAttributes","customerId":"cust_9f2Kd8QpLzXw","name":"Ada Lovelace","emailAddress":"ada@example.com","phoneNumber":"+61400000000"},"status":"Pending","gatewayState":"example","amounts":{"type":"DisputeAmountsAttributes","currency":"AUD","amount":1250,"transactionAmount":1250},"feeAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"reason":"Requested by the customer.","description":"A short description.","orderId":"ordr_9f2Kd8QpLzXw","referenceOrderId":"your-own-reference","orderMetadata":{"yourKey":{}},"evidenceDueBy":"2026-08-19","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","disputeId","subject","merchantId","customer","status","amounts","orderId","createdAt","updatedAt"],"properties":{"type":{"description":"Always `DisputeViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["DisputeViewAttributes"]},"disputeId":{"$ref":"#/components/schemas/DisputeId"},"subject":{"$ref":"#/components/schemas/RfndSubject","description":"The transaction this dispute challenges, acquiring or issuing."},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"Identifier of a merchant."},"customer":{"$ref":"#/components/schemas/RfndCustomer","description":"Who was paid back."},"status":{"$ref":"#/components/schemas/DisputeStatus","description":"The scheme's decision, as the platform records it."},"gatewayState":{"description":"The gateway's own word for where the case is. Free-form, because the gateways do not agree on a vocabulary.","type":"string"},"amounts":{"$ref":"#/components/schemas/DisputeAmounts"},"feeAmount":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"What the platform charges the merchant for handling the dispute. Billed in the platform's own currency, which is why it carries one rather than joining the money set."},"reason":{"type":"string"},"description":{"type":"string"},"orderId":{"$ref":"#/components/schemas/OrdrId","description":"The order the disputed payment settled."},"referenceOrderId":{"type":"string"},"orderMetadata":{"$ref":"#/components/schemas/Metadata","description":"Free-form data the platform stores and returns untouched. Values may be nested objects and arrays."},"evidenceDueBy":{"description":"When evidence must be submitted by.","type":"string","format":"date"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"EntBranding":{"oneOf":[{"$ref":"#/components/schemas/EntBrandingAttributes"}],"discriminator":{"propertyName":"type","mapping":{"EntBrandingAttributes":"#/components/schemas/EntBrandingAttributes"}}},"EntBrandingAttributes":{"title":"EntBrandingAttributes","description":"How an enterprise's sites look, and what the dashboards beneath it fall back to where a merchant or marketplace sets nothing of its own. Every field is optional.","examples":[{"type":"EntBrandingAttributes","displayName":"Ada Lovelace","companyName":"Ada Lovelace","supportEmail":"ada@example.com","website":"example","logoUri":"https://example.com/callback","logoDarkUri":"https://example.com/callback","iconUri":"https://example.com/callback","logoAltText":"example","primaryColor":"example","primaryColorDark":"example"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `EntBrandingAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["EntBrandingAttributes"]},"displayName":{"description":"The product's name as a reader sees it.","type":"string"},"companyName":{"description":"The company behind it.","type":"string"},"supportEmail":{"description":"Where a reader writes for help.","type":"string"},"website":{"description":"The brand's website. Must be an https link.","type":"string"},"logoUri":{"description":"The logo. Must be an https link.","type":"string"},"logoDarkUri":{"description":"The logo on a dark background. Omit to use the one logo on both. Must be an https link.","type":"string"},"iconUri":{"description":"The square mark used where a logo will not fit. Must be an https link.","type":"string"},"logoAltText":{"description":"Text shown in place of the logo where the image cannot load.","type":"string"},"primaryColor":{"description":"The brand colour.","type":"string"},"primaryColorDark":{"description":"The brand colour in dark mode. Omit to use the one colour in both.","type":"string"}}},"EntCmd":{"oneOf":[{"$ref":"#/components/schemas/EntCmdCreate"}],"discriminator":{"propertyName":"type","mapping":{"EntCmdCreate":"#/components/schemas/EntCmdCreate"}}},"EntCmdCreate":{"title":"EntCmdCreate","description":"Create an enterprise.","examples":[{"type":"EntCmdCreate","slug":"example","businessName":"Ada Lovelace","website":"example","companyEmail":"ada@example.com","companyPhone":"+61400000000","encryptionKeys":[{"type":"EntEncryptionKeyAttributes","name":"Ada Lovelace","key":"example"}],"registration":{"type":"EntRegistrationAttributes","country":"AU","businessRegistrationNumber":"example","taxRegistrationNumber":"example","registeredAddress":{"type":"MchtAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"}}}],"type":"object","required":["type","slug","businessName","website","companyEmail","companyPhone"],"properties":{"type":{"description":"Always `EntCmdCreate`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["EntCmdCreate"]},"slug":{"description":"URL-safe identifier. Must be unique across the platform.","type":"string"},"businessName":{"type":"string"},"website":{"type":"string"},"companyEmail":{"type":"string"},"companyPhone":{"description":"E.164 format, e.g. +61400000000.","type":"string"},"encryptionKeys":{"description":"Public keys to encrypt card data to, set up at creation.","type":"array","items":{"$ref":"#/components/schemas/EntEncryptionKey"}},"registration":{"$ref":"#/components/schemas/EntRegistration","description":"The enterprise's registration, where it is known at creation. It can be given later with a patch."}}},"EntColumn":{"title":"EntColumn","type":"string","enum":["EnterpriseId","Slug","BusinessName","Status","Website","CompanyEmail","CompanyPhone","RegistrationCountry","RegistrationBusinessRegistrationNumber","RegistrationTaxRegistrationNumber","RegistrationRegisteredAddressUnitNumber","RegistrationRegisteredAddressStreetNumber","RegistrationRegisteredAddressStreetName","RegistrationRegisteredAddressStreetType","RegistrationRegisteredAddressSuburb","RegistrationRegisteredAddressCity","RegistrationRegisteredAddressState","RegistrationRegisteredAddressPostalCode","RegistrationRegisteredAddressCountry","BrandingDisplayName","BrandingCompanyName","BrandingSupportEmail","BrandingWebsite","BrandingLogoUri","BrandingLogoDarkUri","BrandingIconUri","BrandingLogoAltText","BrandingPrimaryColor","BrandingPrimaryColorDark","CreatedAt","UpdatedAt"]},"EntCreateRsp":{"description":"A created enterprise, and the API key that can act as it.","oneOf":[{"$ref":"#/components/schemas/EntCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"EntCreateRspAttributes":"#/components/schemas/EntCreateRspAttributes"}}},"EntCreateRspAttributes":{"title":"EntCreateRspAttributes","description":"A created enterprise, and the API key that can act as it.","examples":[{"type":"EntCreateRspAttributes","created":{"type":"EntViewAttributes","enterpriseId":"ent_9f2Kd8QpLzXw","slug":"example","businessName":"Ada Lovelace","status":"Enabled","website":"example","companyEmail":"ada@example.com","companyPhone":"+61400000000","encryptionKeyNames":["Ada Lovelace"],"registration":{"type":"EntRegistrationAttributes","country":"AU","businessRegistrationNumber":"example","taxRegistrationNumber":"example","registeredAddress":{"type":"MchtAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"}},"branding":{"type":"EntBrandingAttributes","displayName":"Ada Lovelace","companyName":"Ada Lovelace","supportEmail":"ada@example.com","website":"example","logoUri":"https://example.com/callback","logoDarkUri":"https://example.com/callback","iconUri":"https://example.com/callback","logoAltText":"example","primaryColor":"example","primaryColorDark":"example"},"sites":[{"type":"EntSiteAttributes","domain":"example","app":{"type":"EntSiteAppDashboard"}}],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"},"apiKey":"example"}],"type":"object","required":["type","created","apiKey"],"properties":{"type":{"description":"Always `EntCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["EntCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/EntView","description":"A platform tenant, the party that holds the contract everything else sits under."},"apiKey":{"description":"The enterprise's API key. Shown once, here, and never again, store it now.","type":"string"}}},"EntDocsSurface":{"title":"EntDocsSurface","type":"string","enum":["Edge","Bezel","Unknown"]},"EntEncryptionKey":{"description":"A public encryption key, by name.","oneOf":[{"$ref":"#/components/schemas/EntEncryptionKeyAttributes"}],"discriminator":{"propertyName":"type","mapping":{"EntEncryptionKeyAttributes":"#/components/schemas/EntEncryptionKeyAttributes"}}},"EntEncryptionKeyAttributes":{"title":"EntEncryptionKeyAttributes","description":"A public encryption key, by name.","examples":[{"type":"EntEncryptionKeyAttributes","name":"Ada Lovelace","key":"example"}],"type":"object","required":["type","name","key"],"properties":{"type":{"description":"Always `EntEncryptionKeyAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["EntEncryptionKeyAttributes"]},"name":{"description":"What to call this key. Quoted in the `encryption-key-name` header when reading card data.","type":"string"},"key":{"description":"The key itself, PEM-encoded. Write-only, it is never returned.","type":"string"}}},"EntId":{"title":"EntId","examples":["ent_9f2Kd8QpLzXw"],"type":"string"},"EntPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/EntPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"EntPageAttributes":"#/components/schemas/EntPageAttributes"}}},"EntPageAttributes":{"title":"EntPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"EntPageAttributes","data":[{"type":"EntViewAttributes","enterpriseId":"ent_9f2Kd8QpLzXw","slug":"example","businessName":"Ada Lovelace","status":"Enabled","website":"example","companyEmail":"ada@example.com","companyPhone":"+61400000000","encryptionKeyNames":["Ada Lovelace"],"registration":{"type":"EntRegistrationAttributes","country":"AU","businessRegistrationNumber":"example","taxRegistrationNumber":"example","registeredAddress":{"type":"MchtAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"}},"branding":{"type":"EntBrandingAttributes","displayName":"Ada Lovelace","companyName":"Ada Lovelace","supportEmail":"ada@example.com","website":"example","logoUri":"https://example.com/callback","logoDarkUri":"https://example.com/callback","iconUri":"https://example.com/callback","logoAltText":"example","primaryColor":"example","primaryColorDark":"example"},"sites":[{"type":"EntSiteAttributes","domain":"example","app":{"type":"EntSiteAppDashboard"}}],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `EntPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["EntPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/EntView","description":"A platform tenant, the party that holds the contract everything else sits under."}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"EntRegistration":{"oneOf":[{"$ref":"#/components/schemas/EntRegistrationAttributes"}],"discriminator":{"propertyName":"type","mapping":{"EntRegistrationAttributes":"#/components/schemas/EntRegistrationAttributes"}}},"EntRegistrationAttributes":{"title":"EntRegistrationAttributes","description":"The enterprise's own legal identity: the registration it holds the platform contract under, and its registered office.","examples":[{"type":"EntRegistrationAttributes","country":"AU","businessRegistrationNumber":"example","taxRegistrationNumber":"example","registeredAddress":{"type":"MchtAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"}}],"type":"object","required":["type","country","businessRegistrationNumber"],"properties":{"type":{"description":"Always `EntRegistrationAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["EntRegistrationAttributes"]},"country":{"description":"ISO 3166-1 alpha-2. The country the business is registered in.","type":"string"},"businessRegistrationNumber":{"description":"The business registration number: the ABN in Australia, the NZBN in New Zealand.","type":"string"},"taxRegistrationNumber":{"description":"The tax registration number, where it differs: the IRD number in New Zealand. Not read in Australia, where the ABN is both.","type":"string"},"registeredAddress":{"$ref":"#/components/schemas/MchtAddress","description":"The registered office, as the business register records it."}}},"EntSite":{"description":"A host this enterprise serves, and what it serves there.","oneOf":[{"$ref":"#/components/schemas/EntSiteAttributes"}],"discriminator":{"propertyName":"type","mapping":{"EntSiteAttributes":"#/components/schemas/EntSiteAttributes"}}},"EntSiteApp":{"oneOf":[{"$ref":"#/components/schemas/EntSiteAppDashboard"},{"$ref":"#/components/schemas/EntSiteAppDocs"}],"discriminator":{"propertyName":"type","mapping":{"EntSiteAppDashboard":"#/components/schemas/EntSiteAppDashboard","EntSiteAppDocs":"#/components/schemas/EntSiteAppDocs"}}},"EntSiteAppDashboard":{"title":"EntSiteAppDashboard","description":"A dashboard.","examples":[{"type":"EntSiteAppDashboard"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `EntSiteAppDashboard`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["EntSiteAppDashboard"]}}},"EntSiteAppDocs":{"title":"EntSiteAppDocs","description":"A documentation site: one published API surface, the parts of it this host publishes, and the guides beside it. With `guideTags` and `guides` both empty, every guide on the surface is shown.","examples":[{"type":"EntSiteAppDocs","apiSurface":"Edge","apiTags":["example"],"guideTags":["example"],"guides":["example"]}],"type":"object","required":["type","apiSurface"],"properties":{"type":{"description":"Always `EntSiteAppDocs`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["EntSiteAppDocs"]},"apiSurface":{"$ref":"#/components/schemas/EntDocsSurface"},"apiTags":{"description":"The OpenAPI tags of the surface this host publishes, as its reference names them. Empty publishes all of it. An unknown tag is refused.","type":"array","items":{"type":"string"}},"guideTags":{"description":"Guides on the surface in any of these domains are shown: Payments, Refunds, Customers, Merchants, Marketplaces, Identity, Settlement, Loans, Card issuing, FX, PayTo, Reference, Integration.","type":"array","items":{"type":"string"}},"guides":{"description":"Guides shown by slug, besides those `guideTags` selects. Each must be a guide on the surface.","type":"array","items":{"type":"string"}}}},"EntSiteAttributes":{"title":"EntSiteAttributes","description":"A host this enterprise serves, and what it serves there.","examples":[{"type":"EntSiteAttributes","domain":"example","app":{"type":"EntSiteAppDashboard"}}],"type":"object","required":["type","domain","app"],"properties":{"type":{"description":"Always `EntSiteAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["EntSiteAttributes"]},"domain":{"description":"The host, e.g. `docs.example.com`: no scheme, port or path. Stored lower-cased. A host belongs to one enterprise, and claiming one another serves is refused.","type":"string"},"app":{"$ref":"#/components/schemas/EntSiteApp"}}},"EntSort":{"title":"EntSort","type":"string","enum":["createdAt","-createdAt","updatedAt","-updatedAt"]},"EntStatus":{"title":"EntStatus","type":"string","enum":["Enabled","Disabled","Unknown"]},"EntUpdate":{"oneOf":[{"$ref":"#/components/schemas/EntUpdateBranding"},{"$ref":"#/components/schemas/EntUpdateEncryptionKey"},{"$ref":"#/components/schemas/EntUpdateRegistration"},{"$ref":"#/components/schemas/EntUpdateSites"}],"discriminator":{"propertyName":"type","mapping":{"EntUpdateBranding":"#/components/schemas/EntUpdateBranding","EntUpdateEncryptionKey":"#/components/schemas/EntUpdateEncryptionKey","EntUpdateRegistration":"#/components/schemas/EntUpdateRegistration","EntUpdateSites":"#/components/schemas/EntUpdateSites"}}},"EntUpdateBranding":{"title":"EntUpdateBranding","description":"Set the enterprise's branding. It is replaced whole, so send every field you want to keep; a branding with nothing in it removes it. An enterprise's own credential may brand its own enterprise.","examples":[{"type":"EntUpdateBranding","branding":{"type":"EntBrandingAttributes","displayName":"Ada Lovelace","companyName":"Ada Lovelace","supportEmail":"ada@example.com","website":"example","logoUri":"https://example.com/callback","logoDarkUri":"https://example.com/callback","iconUri":"https://example.com/callback","logoAltText":"example","primaryColor":"example","primaryColorDark":"example"}}],"type":"object","required":["type","branding"],"properties":{"type":{"description":"Always `EntUpdateBranding`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["EntUpdateBranding"]},"branding":{"$ref":"#/components/schemas/EntBranding","description":"How an enterprise's sites look, and what the dashboards beneath it fall back to where a merchant or marketplace sets nothing of its own. Every field is optional."}}},"EntUpdateEncryptionKey":{"title":"EntUpdateEncryptionKey","description":"Add or replace a public encryption key, by name. Edge's `SetupPublicEncryptionKey`.","examples":[{"type":"EntUpdateEncryptionKey","encryptionKey":{"type":"EntEncryptionKeyAttributes","name":"Ada Lovelace","key":"example"}}],"type":"object","required":["type","encryptionKey"],"properties":{"type":{"description":"Always `EntUpdateEncryptionKey`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["EntUpdateEncryptionKey"]},"encryptionKey":{"$ref":"#/components/schemas/EntEncryptionKey"}}},"EntUpdateRegistration":{"title":"EntUpdateRegistration","description":"Give or replace the enterprise's registration and registered office.","examples":[{"type":"EntUpdateRegistration","registration":{"type":"EntRegistrationAttributes","country":"AU","businessRegistrationNumber":"example","taxRegistrationNumber":"example","registeredAddress":{"type":"MchtAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"}}}],"type":"object","required":["type","registration"],"properties":{"type":{"description":"Always `EntUpdateRegistration`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["EntUpdateRegistration"]},"registration":{"$ref":"#/components/schemas/EntRegistration","description":"The enterprise's own legal identity: the registration it holds the platform contract under, and its registered office."}}},"EntUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/EntUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"EntUpdateRspAttributes":"#/components/schemas/EntUpdateRspAttributes"}}},"EntUpdateRspAttributes":{"title":"EntUpdateRspAttributes","examples":[{"type":"EntUpdateRspAttributes","updated":{"type":"EntViewAttributes","enterpriseId":"ent_9f2Kd8QpLzXw","slug":"example","businessName":"Ada Lovelace","status":"Enabled","website":"example","companyEmail":"ada@example.com","companyPhone":"+61400000000","encryptionKeyNames":["Ada Lovelace"],"registration":{"type":"EntRegistrationAttributes","country":"AU","businessRegistrationNumber":"example","taxRegistrationNumber":"example","registeredAddress":{"type":"MchtAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"}},"branding":{"type":"EntBrandingAttributes","displayName":"Ada Lovelace","companyName":"Ada Lovelace","supportEmail":"ada@example.com","website":"example","logoUri":"https://example.com/callback","logoDarkUri":"https://example.com/callback","iconUri":"https://example.com/callback","logoAltText":"example","primaryColor":"example","primaryColorDark":"example"},"sites":[{"type":"EntSiteAttributes","domain":"example","app":{"type":"EntSiteAppDashboard"}}],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `EntUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["EntUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/EntView","description":"The resource as it stands after the change."}}},"EntUpdateSites":{"title":"EntUpdateSites","description":"Set the hosts the enterprise serves. The list is replaced whole, so send every site you want to keep; an empty list gives up every host. The platform's admin alone may claim hosts.","examples":[{"type":"EntUpdateSites","sites":[{"type":"EntSiteAttributes","domain":"example","app":{"type":"EntSiteAppDashboard"}}]}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `EntUpdateSites`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["EntUpdateSites"]},"sites":{"type":"array","items":{"$ref":"#/components/schemas/EntSite"}}}},"EntView":{"oneOf":[{"$ref":"#/components/schemas/EntViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"EntViewAttributes":"#/components/schemas/EntViewAttributes"}}},"EntViewAttributes":{"title":"EntViewAttributes","description":"A platform tenant, the party that holds the contract everything else sits under.","examples":[{"type":"EntViewAttributes","enterpriseId":"ent_9f2Kd8QpLzXw","slug":"example","businessName":"Ada Lovelace","status":"Enabled","website":"example","companyEmail":"ada@example.com","companyPhone":"+61400000000","encryptionKeyNames":["Ada Lovelace"],"registration":{"type":"EntRegistrationAttributes","country":"AU","businessRegistrationNumber":"example","taxRegistrationNumber":"example","registeredAddress":{"type":"MchtAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"}},"branding":{"type":"EntBrandingAttributes","displayName":"Ada Lovelace","companyName":"Ada Lovelace","supportEmail":"ada@example.com","website":"example","logoUri":"https://example.com/callback","logoDarkUri":"https://example.com/callback","iconUri":"https://example.com/callback","logoAltText":"example","primaryColor":"example","primaryColorDark":"example"},"sites":[{"type":"EntSiteAttributes","domain":"example","app":{"type":"EntSiteAppDashboard"}}],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","enterpriseId","slug","businessName","status","website","companyEmail","companyPhone","createdAt","updatedAt"],"properties":{"type":{"description":"Always `EntViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["EntViewAttributes"]},"enterpriseId":{"$ref":"#/components/schemas/EntId","description":"Identifier of an enterprise."},"slug":{"description":"URL-safe identifier. Unique across the platform.","type":"string"},"businessName":{"description":"Registered name of the business holding the contract.","type":"string"},"status":{"$ref":"#/components/schemas/EntStatus"},"website":{"type":"string"},"companyEmail":{"description":"Where the platform writes when it needs a person.","type":"string"},"companyPhone":{"description":"E.164 format, e.g. +61400000000.","type":"string"},"encryptionKeyNames":{"description":"Names of the public keys the platform encrypts card data to for this enterprise. **The keys themselves are never returned** only that they are configured, and under what name.","type":"array","items":{"type":"string"}},"registration":{"$ref":"#/components/schemas/EntRegistration","description":"The registration the enterprise holds the contract under, once it has been given."},"branding":{"$ref":"#/components/schemas/EntBranding","description":"How this enterprise's sites and the dashboards beneath it look. Absent where it has set none."},"sites":{"description":"The hosts this enterprise serves, one site each. Empty where it serves none.","type":"array","items":{"$ref":"#/components/schemas/EntSite"}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"ExceptColumn":{"title":"ExceptColumn","type":"string"},"ExceptId":{"title":"ExceptId","description":"Identifier of an issuer-transaction exception.","examples":["except_9f2Kd8QpLzXw"],"type":"string"},"ExceptKind":{"title":"ExceptKind","type":"string","enum":["UatpRefundUnknownTransaction","UatpRefundAmountExceedsAvailable","UatpCaptureUnknownApprovalCode","MastercardRefundUnknownTransaction","MastercardRefundError","Unknown"]},"ExceptNote":{"description":"A note written against an exception.","oneOf":[{"$ref":"#/components/schemas/ExceptNoteAttributes"}],"discriminator":{"propertyName":"type","mapping":{"ExceptNoteAttributes":"#/components/schemas/ExceptNoteAttributes"}}},"ExceptNoteAttributes":{"title":"ExceptNoteAttributes","description":"A note written against an exception.","examples":[{"type":"ExceptNoteAttributes","kind":"Comment","text":"example","author":"example","createdAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","kind","text","author","createdAt"],"properties":{"type":{"description":"Always `ExceptNoteAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ExceptNoteAttributes"]},"kind":{"$ref":"#/components/schemas/ExceptNoteKind"},"text":{"type":"string"},"author":{"description":"Who wrote the note.","type":"string"},"createdAt":{"type":"string","format":"date-time"}}},"ExceptNoteKind":{"title":"ExceptNoteKind","type":"string","enum":["Comment","Resolution","Unknown"]},"ExceptPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/ExceptPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"ExceptPageAttributes":"#/components/schemas/ExceptPageAttributes"}}},"ExceptPageAttributes":{"title":"ExceptPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"ExceptPageAttributes","data":[{"type":"ExceptViewMastercardRefundError","exceptionId":"except_9f2Kd8QpLzXw","status":"Outstanding","card":{"type":"ItxnCardAttributes","cardId":"dcard_9f2Kd8QpLzXw","cardReference":"your-own-reference","last4":"4242","bin":"424242","brand":"Visa","expiryMonth":6,"expiryYear":2029,"country":"AU","cardHolderName":"Ada Lovelace"},"customerId":"cust_9f2Kd8QpLzXw","referenceTransactionId":"your-own-reference","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"transactionId":"tran_9f2Kd8QpLzXw","schemeError":"example","reconciledTransactionIds":["tran_9f2Kd8QpLzXw"],"generatedRefundId":"rfnd_9f2Kd8QpLzXw","suggestion":{"type":"ExceptSuggestionAcceptCapture"},"notes":[{"type":"ExceptNoteAttributes","kind":"Comment","text":"example","author":"example","createdAt":"2026-08-19T04:21:07Z"}],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `ExceptPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ExceptPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExceptView"}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"ExceptResolution":{"description":"How to resolve it. Which resolutions are accepted depends on the kind of exception.","oneOf":[{"$ref":"#/components/schemas/ExceptResolutionAcceptCapture"},{"$ref":"#/components/schemas/ExceptResolutionResolveRefund"},{"$ref":"#/components/schemas/ExceptResolutionResolveWithNote"},{"$ref":"#/components/schemas/ExceptResolutionResubmitRefund"}],"discriminator":{"propertyName":"type","mapping":{"ExceptResolutionAcceptCapture":"#/components/schemas/ExceptResolutionAcceptCapture","ExceptResolutionResolveRefund":"#/components/schemas/ExceptResolutionResolveRefund","ExceptResolutionResolveWithNote":"#/components/schemas/ExceptResolutionResolveWithNote","ExceptResolutionResubmitRefund":"#/components/schemas/ExceptResolutionResubmitRefund"}}},"ExceptResolutionAcceptCapture":{"title":"ExceptResolutionAcceptCapture","description":"Accept a capture that quoted an unknown approval code. The platform creates the authorisation to match it.","examples":[{"type":"ExceptResolutionAcceptCapture"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `ExceptResolutionAcceptCapture`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ExceptResolutionAcceptCapture"]}}},"ExceptResolutionResolveRefund":{"title":"ExceptResolutionResolveRefund","description":"Reconcile an unmatched refund against transactions you name, raising a credit for anything left over.","examples":[{"type":"ExceptResolutionResolveRefund","reconciledTransactionIds":["tran_9f2Kd8QpLzXw"],"manualCreditDescription":"A short description."}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `ExceptResolutionResolveRefund`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ExceptResolutionResolveRefund"]},"reconciledTransactionIds":{"description":"The transactions to absorb the refund. Omit to let the platform raise a credit for the whole amount.","type":"array","items":{"$ref":"#/components/schemas/ItxnId","description":"Identifier of an issuer transaction."}},"manualCreditDescription":{"description":"The description for the credit raised where the named transactions cannot absorb the refund.","type":"string"}}},"ExceptResolutionResolveWithNote":{"title":"ExceptResolutionResolveWithNote","description":"Resolve the exception without moving any money, because its money movement has already been settled by other means and is no longer needed. Not a credit: `ExceptResolutionResolveRefund` with a `manualCreditDescription` credits the refund to the account.","examples":[{"type":"ExceptResolutionResolveWithNote","note":"example"}],"type":"object","required":["type","note"],"properties":{"type":{"description":"Always `ExceptResolutionResolveWithNote`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ExceptResolutionResolveWithNote"]},"note":{"description":"Why the money movement is no longer needed. Kept as the exception's resolution note.","type":"string"}}},"ExceptResolutionResubmitRefund":{"title":"ExceptResolutionResubmitRefund","description":"Submit the refund to the scheme again. Mastercard only, the platform refuses it for UATP.","examples":[{"type":"ExceptResolutionResubmitRefund"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `ExceptResolutionResubmitRefund`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ExceptResolutionResubmitRefund"]}}},"ExceptSort":{"title":"ExceptSort","type":"string","enum":["createdAt","-createdAt","updatedAt","-updatedAt"]},"ExceptStatus":{"title":"ExceptStatus","type":"string","enum":["Outstanding","Resolved","Unknown"]},"ExceptSuggestion":{"oneOf":[{"$ref":"#/components/schemas/ExceptSuggestionAcceptCapture"},{"$ref":"#/components/schemas/ExceptSuggestionCandidates"}],"discriminator":{"propertyName":"type","mapping":{"ExceptSuggestionAcceptCapture":"#/components/schemas/ExceptSuggestionAcceptCapture","ExceptSuggestionCandidates":"#/components/schemas/ExceptSuggestionCandidates"}}},"ExceptSuggestionAcceptCapture":{"title":"ExceptSuggestionAcceptCapture","description":"Accept the capture as it stands. The platform will create the authorisation to match it.","examples":[{"type":"ExceptSuggestionAcceptCapture"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `ExceptSuggestionAcceptCapture`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ExceptSuggestionAcceptCapture"]}}},"ExceptSuggestionCandidates":{"title":"ExceptSuggestionCandidates","description":"These are the transactions the unmatched refund might belong to. Pick the ones it does.","examples":[{"type":"ExceptSuggestionCandidates","candidateTransactionIds":["tran_9f2Kd8QpLzXw"]}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `ExceptSuggestionCandidates`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ExceptSuggestionCandidates"]},"candidateTransactionIds":{"description":"The transactions the platform thinks the refund could be reconciled against.","type":"array","items":{"$ref":"#/components/schemas/ItxnId","description":"Identifier of an issuer transaction."}}}},"ExceptUpdate":{"oneOf":[{"$ref":"#/components/schemas/ExceptUpdateAddNote"},{"$ref":"#/components/schemas/ExceptUpdateAttributes"}],"discriminator":{"propertyName":"type","mapping":{"ExceptUpdateAddNote":"#/components/schemas/ExceptUpdateAddNote","ExceptUpdateAttributes":"#/components/schemas/ExceptUpdateAttributes"}}},"ExceptUpdateAddNote":{"title":"ExceptUpdateAddNote","description":"Add a note to the exception, for example why it was resolved as it was. Accepted whether or not it is resolved.","examples":[{"type":"ExceptUpdateAddNote","note":"example"}],"type":"object","required":["type","note"],"properties":{"type":{"description":"Always `ExceptUpdateAddNote`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ExceptUpdateAddNote"]},"note":{"type":"string"}}},"ExceptUpdateAttributes":{"title":"ExceptUpdateAttributes","description":"Resolve an issuer-transaction exception.","examples":[{"type":"ExceptUpdateAttributes","resolution":{"type":"ExceptResolutionAcceptCapture"}}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `ExceptUpdateAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ExceptUpdateAttributes"]},"resolution":{"$ref":"#/components/schemas/ExceptResolution"}}},"ExceptUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/ExceptUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"ExceptUpdateRspAttributes":"#/components/schemas/ExceptUpdateRspAttributes"}}},"ExceptUpdateRspAttributes":{"title":"ExceptUpdateRspAttributes","examples":[{"type":"ExceptUpdateRspAttributes","updated":{"type":"ExceptViewMastercardRefundError","exceptionId":"except_9f2Kd8QpLzXw","status":"Outstanding","card":{"type":"ItxnCardAttributes","cardId":"dcard_9f2Kd8QpLzXw","cardReference":"your-own-reference","last4":"4242","bin":"424242","brand":"Visa","expiryMonth":6,"expiryYear":2029,"country":"AU","cardHolderName":"Ada Lovelace"},"customerId":"cust_9f2Kd8QpLzXw","referenceTransactionId":"your-own-reference","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"transactionId":"tran_9f2Kd8QpLzXw","schemeError":"example","reconciledTransactionIds":["tran_9f2Kd8QpLzXw"],"generatedRefundId":"rfnd_9f2Kd8QpLzXw","suggestion":{"type":"ExceptSuggestionAcceptCapture"},"notes":[{"type":"ExceptNoteAttributes","kind":"Comment","text":"example","author":"example","createdAt":"2026-08-19T04:21:07Z"}],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `ExceptUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ExceptUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/ExceptView","description":"The resource as it stands after the change."}}},"ExceptView":{"oneOf":[{"$ref":"#/components/schemas/ExceptViewMastercardRefundError"},{"$ref":"#/components/schemas/ExceptViewMastercardRefundUnknown"},{"$ref":"#/components/schemas/ExceptViewUatpCaptureUnknownApprovalCode"},{"$ref":"#/components/schemas/ExceptViewUatpRefundExceedsAvailable"},{"$ref":"#/components/schemas/ExceptViewUatpRefundUnknown"}],"discriminator":{"propertyName":"type","mapping":{"ExceptViewMastercardRefundError":"#/components/schemas/ExceptViewMastercardRefundError","ExceptViewMastercardRefundUnknown":"#/components/schemas/ExceptViewMastercardRefundUnknown","ExceptViewUatpCaptureUnknownApprovalCode":"#/components/schemas/ExceptViewUatpCaptureUnknownApprovalCode","ExceptViewUatpRefundExceedsAvailable":"#/components/schemas/ExceptViewUatpRefundExceedsAvailable","ExceptViewUatpRefundUnknown":"#/components/schemas/ExceptViewUatpRefundUnknown"}}},"ExceptViewMastercardRefundError":{"title":"ExceptViewMastercardRefundError","description":"The scheme rejected a refund the platform submitted. This is the one an operator can resubmit.","examples":[{"type":"ExceptViewMastercardRefundError","exceptionId":"except_9f2Kd8QpLzXw","status":"Outstanding","card":{"type":"ItxnCardAttributes","cardId":"dcard_9f2Kd8QpLzXw","cardReference":"your-own-reference","last4":"4242","bin":"424242","brand":"Visa","expiryMonth":6,"expiryYear":2029,"country":"AU","cardHolderName":"Ada Lovelace"},"customerId":"cust_9f2Kd8QpLzXw","referenceTransactionId":"your-own-reference","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"transactionId":"tran_9f2Kd8QpLzXw","schemeError":"example","reconciledTransactionIds":["tran_9f2Kd8QpLzXw"],"generatedRefundId":"rfnd_9f2Kd8QpLzXw","suggestion":{"type":"ExceptSuggestionAcceptCapture"},"notes":[{"type":"ExceptNoteAttributes","kind":"Comment","text":"example","author":"example","createdAt":"2026-08-19T04:21:07Z"}],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","exceptionId","status","card","referenceTransactionId","amount","createdAt","updatedAt"],"properties":{"type":{"description":"Always `ExceptViewMastercardRefundError`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ExceptViewMastercardRefundError"]},"exceptionId":{"$ref":"#/components/schemas/ExceptId"},"status":{"$ref":"#/components/schemas/ExceptStatus"},"card":{"$ref":"#/components/schemas/ItxnCard"},"customerId":{"$ref":"#/components/schemas/CustId","description":"The customer the transaction is made against, where it is made against one."},"referenceTransactionId":{"type":"string"},"amount":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"What the platform tried to refund."},"transactionId":{"$ref":"#/components/schemas/ItxnId","description":"The transaction the refund was against."},"schemeError":{"description":"What the scheme said when it refused.","type":"string"},"reconciledTransactionIds":{"type":"array","items":{"$ref":"#/components/schemas/ItxnId","description":"Identifier of an issuer transaction."}},"generatedRefundId":{"$ref":"#/components/schemas/RfndId","description":"Identifier of a refund."},"suggestion":{"$ref":"#/components/schemas/ExceptSuggestion"},"notes":{"description":"Notes written against the exception, oldest first.","type":"array","items":{"$ref":"#/components/schemas/ExceptNote"}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"ExceptViewMastercardRefundUnknown":{"title":"ExceptViewMastercardRefundUnknown","description":"A refund arrived for a Mastercard authorisation the platform has no record of.","examples":[{"type":"ExceptViewMastercardRefundUnknown","exceptionId":"except_9f2Kd8QpLzXw","status":"Outstanding","card":{"type":"ItxnCardAttributes","cardId":"dcard_9f2Kd8QpLzXw","cardReference":"your-own-reference","last4":"4242","bin":"424242","brand":"Visa","expiryMonth":6,"expiryYear":2029,"country":"AU","cardHolderName":"Ada Lovelace"},"customerId":"cust_9f2Kd8QpLzXw","referenceTransactionId":"your-own-reference","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"reconciledTransactionIds":["tran_9f2Kd8QpLzXw"],"manualCreditDescription":"A short description.","generatedRefundId":"rfnd_9f2Kd8QpLzXw","suggestion":{"type":"ExceptSuggestionAcceptCapture"},"notes":[{"type":"ExceptNoteAttributes","kind":"Comment","text":"example","author":"example","createdAt":"2026-08-19T04:21:07Z"}],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","exceptionId","status","card","referenceTransactionId","amount","createdAt","updatedAt"],"properties":{"type":{"description":"Always `ExceptViewMastercardRefundUnknown`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ExceptViewMastercardRefundUnknown"]},"exceptionId":{"$ref":"#/components/schemas/ExceptId"},"status":{"$ref":"#/components/schemas/ExceptStatus"},"card":{"$ref":"#/components/schemas/ItxnCard"},"customerId":{"$ref":"#/components/schemas/CustId","description":"The customer the transaction is made against, where it is made against one."},"referenceTransactionId":{"type":"string"},"amount":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"What the scheme asked to refund."},"reconciledTransactionIds":{"type":"array","items":{"$ref":"#/components/schemas/ItxnId","description":"Identifier of an issuer transaction."}},"manualCreditDescription":{"type":"string"},"generatedRefundId":{"$ref":"#/components/schemas/RfndId","description":"Identifier of a refund."},"suggestion":{"$ref":"#/components/schemas/ExceptSuggestion"},"notes":{"description":"Notes written against the exception, oldest first.","type":"array","items":{"$ref":"#/components/schemas/ExceptNote"}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"ExceptViewUatpCaptureUnknownApprovalCode":{"title":"ExceptViewUatpCaptureUnknownApprovalCode","description":"A UATP capture arrived quoting an approval code the platform has no authorisation for.","examples":[{"type":"ExceptViewUatpCaptureUnknownApprovalCode","exceptionId":"except_9f2Kd8QpLzXw","status":"Outstanding","card":{"type":"ItxnCardAttributes","cardId":"dcard_9f2Kd8QpLzXw","cardReference":"your-own-reference","last4":"4242","bin":"424242","brand":"Visa","expiryMonth":6,"expiryYear":2029,"country":"AU","cardHolderName":"Ada Lovelace"},"customerId":"cust_9f2Kd8QpLzXw","referenceTransactionId":"your-own-reference","approvalCode":"example","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"acquiringMerchant":{"type":"ItxnAcquiringMerchantAttributes","name":"Ada Lovelace","merchantCategoryCode":"example","iataNumber":"example","taxId":"abc123","country":"AU","city":"example","postCode":"3000","emailAddress":"ada@example.com","phoneNumber":"+61400000000"},"suggestion":{"type":"ExceptSuggestionAcceptCapture"},"notes":[{"type":"ExceptNoteAttributes","kind":"Comment","text":"example","author":"example","createdAt":"2026-08-19T04:21:07Z"}],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","exceptionId","status","card","referenceTransactionId","approvalCode","amount","acquiringMerchant","createdAt","updatedAt"],"properties":{"type":{"description":"Always `ExceptViewUatpCaptureUnknownApprovalCode`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ExceptViewUatpCaptureUnknownApprovalCode"]},"exceptionId":{"$ref":"#/components/schemas/ExceptId"},"status":{"$ref":"#/components/schemas/ExceptStatus"},"card":{"$ref":"#/components/schemas/ItxnCard"},"customerId":{"$ref":"#/components/schemas/CustId","description":"The customer the transaction is made against, where it is made against one."},"referenceTransactionId":{"type":"string"},"approvalCode":{"description":"The approval code the capture quoted.","type":"string"},"amount":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"What the scheme asked to capture."},"acquiringMerchant":{"$ref":"#/components/schemas/ItxnAcquiringMerchant","description":"The merchant the capture named, as the scheme reported it."},"suggestion":{"$ref":"#/components/schemas/ExceptSuggestion"},"notes":{"description":"Notes written against the exception, oldest first.","type":"array","items":{"$ref":"#/components/schemas/ExceptNote"}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"ExceptViewUatpRefundExceedsAvailable":{"title":"ExceptViewUatpRefundExceedsAvailable","description":"A UATP refund arrived for more than the ticket has left to refund.","examples":[{"type":"ExceptViewUatpRefundExceedsAvailable","exceptionId":"except_9f2Kd8QpLzXw","status":"Outstanding","card":{"type":"ItxnCardAttributes","cardId":"dcard_9f2Kd8QpLzXw","cardReference":"your-own-reference","last4":"4242","bin":"424242","brand":"Visa","expiryMonth":6,"expiryYear":2029,"country":"AU","cardHolderName":"Ada Lovelace"},"customerId":"cust_9f2Kd8QpLzXw","referenceTransactionId":"your-own-reference","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"referenceRefundId":"your-own-reference","transactionId":"tran_9f2Kd8QpLzXw","reconciledTransactionIds":["tran_9f2Kd8QpLzXw"],"manualCreditDescription":"A short description.","generatedRefundId":"rfnd_9f2Kd8QpLzXw","suggestion":{"type":"ExceptSuggestionAcceptCapture"},"notes":[{"type":"ExceptNoteAttributes","kind":"Comment","text":"example","author":"example","createdAt":"2026-08-19T04:21:07Z"}],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","exceptionId","status","card","referenceTransactionId","amount","createdAt","updatedAt"],"properties":{"type":{"description":"Always `ExceptViewUatpRefundExceedsAvailable`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ExceptViewUatpRefundExceedsAvailable"]},"exceptionId":{"$ref":"#/components/schemas/ExceptId"},"status":{"$ref":"#/components/schemas/ExceptStatus"},"card":{"$ref":"#/components/schemas/ItxnCard"},"customerId":{"$ref":"#/components/schemas/CustId","description":"The customer the transaction is made against, where it is made against one."},"referenceTransactionId":{"type":"string"},"amount":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"What the scheme asked to refund."},"referenceRefundId":{"type":"string"},"transactionId":{"$ref":"#/components/schemas/ItxnId","description":"The transaction the refund named, which does not have the funds."},"reconciledTransactionIds":{"type":"array","items":{"$ref":"#/components/schemas/ItxnId","description":"Identifier of an issuer transaction."}},"manualCreditDescription":{"type":"string"},"generatedRefundId":{"$ref":"#/components/schemas/RfndId","description":"Identifier of a refund."},"suggestion":{"$ref":"#/components/schemas/ExceptSuggestion"},"notes":{"description":"Notes written against the exception, oldest first.","type":"array","items":{"$ref":"#/components/schemas/ExceptNote"}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"ExceptViewUatpRefundUnknown":{"title":"ExceptViewUatpRefundUnknown","description":"A refund arrived for a UATP ticket the platform has no record of.","examples":[{"type":"ExceptViewUatpRefundUnknown","exceptionId":"except_9f2Kd8QpLzXw","status":"Outstanding","card":{"type":"ItxnCardAttributes","cardId":"dcard_9f2Kd8QpLzXw","cardReference":"your-own-reference","last4":"4242","bin":"424242","brand":"Visa","expiryMonth":6,"expiryYear":2029,"country":"AU","cardHolderName":"Ada Lovelace"},"customerId":"cust_9f2Kd8QpLzXw","referenceTransactionId":"your-own-reference","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"referenceRefundId":"your-own-reference","reconciledTransactionIds":["tran_9f2Kd8QpLzXw"],"manualCreditDescription":"A short description.","generatedRefundId":"rfnd_9f2Kd8QpLzXw","suggestion":{"type":"ExceptSuggestionAcceptCapture"},"notes":[{"type":"ExceptNoteAttributes","kind":"Comment","text":"example","author":"example","createdAt":"2026-08-19T04:21:07Z"}],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","exceptionId","status","card","referenceTransactionId","amount","createdAt","updatedAt"],"properties":{"type":{"description":"Always `ExceptViewUatpRefundUnknown`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ExceptViewUatpRefundUnknown"]},"exceptionId":{"$ref":"#/components/schemas/ExceptId"},"status":{"$ref":"#/components/schemas/ExceptStatus"},"card":{"$ref":"#/components/schemas/ItxnCard"},"customerId":{"$ref":"#/components/schemas/CustId","description":"The customer the transaction is made against, where it is made against one."},"referenceTransactionId":{"description":"The ticket the refund quoted.","type":"string"},"amount":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"What the scheme asked to refund."},"referenceRefundId":{"description":"Your own reference for the refund, where the scheme sent one.","type":"string"},"reconciledTransactionIds":{"description":"Once reconciled, the transactions this refund was matched to.","type":"array","items":{"$ref":"#/components/schemas/ItxnId","description":"Identifier of an issuer transaction."}},"manualCreditDescription":{"description":"Where the refund could not be absorbed by the matched transactions, the description used for the credit raised instead.","type":"string"},"generatedRefundId":{"$ref":"#/components/schemas/RfndId","description":"Once reconciled, the refund the platform generated."},"suggestion":{"$ref":"#/components/schemas/ExceptSuggestion"},"notes":{"description":"Notes written against the exception, oldest first.","type":"array","items":{"$ref":"#/components/schemas/ExceptNote"}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"ExptCmd":{"oneOf":[{"$ref":"#/components/schemas/ExptCmdRun"}],"discriminator":{"propertyName":"type","mapping":{"ExptCmdRun":"#/components/schemas/ExptCmdRun"}}},"ExptCmdRun":{"title":"ExptCmdRun","description":"Export the rows a source reads, as CSV. The source authorises you exactly as its own read does, and reads only what you may read. Each source names the parameters it takes.","examples":[{"type":"ExptCmdRun","source":"example","parameters":[{"type":"ExptParameterAttributes","name":"Ada Lovelace","value":"example"}],"mode":"Auto"}],"type":"object","required":["type","source"],"properties":{"type":{"description":"Always `ExptCmdRun`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ExptCmdRun"]},"source":{"description":"What to export.","type":"string"},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/ExptParameter"}},"mode":{"$ref":"#/components/schemas/ExptMode"}}},"ExptColumn":{"title":"ExptColumn","type":"string","enum":["ExportId","Source","SourceKind","Summary","State","RowsWritten","BytesWritten","FailureCode","Failure","DownloadUrl","DownloadUrlExpiresAt","CreatedAt","StartedAt","FinishedAt"]},"ExptCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/ExptCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"ExptCreateRspAttributes":"#/components/schemas/ExptCreateRspAttributes"}}},"ExptCreateRspAttributes":{"title":"ExptCreateRspAttributes","examples":[{"type":"ExptCreateRspAttributes","created":{"type":"ExptViewAttributes","exportId":"expt_9f2Kd8QpLzXw","source":"example","sourceKind":"List","summary":"example","state":"Queued","rowsWritten":1250,"bytesWritten":1250,"failureCode":"Refused","failure":"example","downloadUrl":"https://example.com/callback","downloadUrlExpiresAt":"2026-08-19T04:21:07Z","createdAt":"2026-08-19T04:21:07Z","startedAt":"2026-08-19T04:21:07Z","finishedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `ExptCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ExptCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/ExptView","description":"The resource that was created."}}},"ExptFailureCode":{"title":"ExptFailureCode","description":"Why it failed, as a code, when it has.","type":"string","enum":["Refused","TooLarge","TooSlow","WaitedTooLong","Stopped","Interrupted","NotWritten","QueueGaveUp","Unknown"]},"ExptId":{"title":"ExptId","description":"Identifier of an export.","examples":["expt_9f2Kd8QpLzXw"],"type":"string"},"ExptMode":{"title":"ExptMode","description":"`Auto` when absent.","type":"string","enum":["Auto","Job","Unknown"]},"ExptPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/ExptPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"ExptPageAttributes":"#/components/schemas/ExptPageAttributes"}}},"ExptPageAttributes":{"title":"ExptPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"ExptPageAttributes","data":[{"type":"ExptViewAttributes","exportId":"expt_9f2Kd8QpLzXw","source":"example","sourceKind":"List","summary":"example","state":"Queued","rowsWritten":1250,"bytesWritten":1250,"failureCode":"Refused","failure":"example","downloadUrl":"https://example.com/callback","downloadUrlExpiresAt":"2026-08-19T04:21:07Z","createdAt":"2026-08-19T04:21:07Z","startedAt":"2026-08-19T04:21:07Z","finishedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `ExptPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ExptPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExptView","description":"A CSV export too large to answer at once, written in the background. Read it until it is `Done`, then follow `downloadUrl`. It is yours alone: anyone else asking for it is told it does not exist."}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"ExptParameter":{"description":"A value the source reads, by name.","oneOf":[{"$ref":"#/components/schemas/ExptParameterAttributes"}],"discriminator":{"propertyName":"type","mapping":{"ExptParameterAttributes":"#/components/schemas/ExptParameterAttributes"}}},"ExptParameterAttributes":{"title":"ExptParameterAttributes","description":"A value the source reads, by name.","examples":[{"type":"ExptParameterAttributes","name":"Ada Lovelace","value":"example"}],"type":"object","required":["type","name","value"],"properties":{"type":{"description":"Always `ExptParameterAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ExptParameterAttributes"]},"name":{"type":"string"},"value":{"type":"string"}}},"ExptSourceKind":{"title":"ExptSourceKind","description":"What its source reads.","type":"string","enum":["List","Question","Dashboard","Unknown"]},"ExptState":{"title":"ExptState","type":"string","enum":["Queued","Running","Done","Failed","Expired","Cancelled","Deleted","Unknown"]},"ExptUpdate":{"oneOf":[{"$ref":"#/components/schemas/ExptUpdateCancel"},{"$ref":"#/components/schemas/ExptUpdateRetry"}],"discriminator":{"propertyName":"type","mapping":{"ExptUpdateCancel":"#/components/schemas/ExptUpdateCancel","ExptUpdateRetry":"#/components/schemas/ExptUpdateRetry"}}},"ExptUpdateCancel":{"title":"ExptUpdateCancel","description":"Stop it while it is queued or being written. A run in progress stops at its next page, and no file is offered.","examples":[{"type":"ExptUpdateCancel"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `ExptUpdateCancel`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ExptUpdateCancel"]}}},"ExptUpdateRetry":{"title":"ExptUpdateRetry","description":"Ask again for an export that failed, or whose file has expired: a new export of the same rows, asked as you asked it, which reads only what you may read when it runs. Answers the new export.","examples":[{"type":"ExptUpdateRetry"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `ExptUpdateRetry`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ExptUpdateRetry"]}}},"ExptView":{"oneOf":[{"$ref":"#/components/schemas/ExptViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"ExptViewAttributes":"#/components/schemas/ExptViewAttributes"}}},"ExptViewAttributes":{"title":"ExptViewAttributes","description":"A CSV export too large to answer at once, written in the background. Read it until it is `Done`, then follow `downloadUrl`. It is yours alone: anyone else asking for it is told it does not exist.","examples":[{"type":"ExptViewAttributes","exportId":"expt_9f2Kd8QpLzXw","source":"example","sourceKind":"List","summary":"example","state":"Queued","rowsWritten":1250,"bytesWritten":1250,"failureCode":"Refused","failure":"example","downloadUrl":"https://example.com/callback","downloadUrlExpiresAt":"2026-08-19T04:21:07Z","createdAt":"2026-08-19T04:21:07Z","startedAt":"2026-08-19T04:21:07Z","finishedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","exportId","source","sourceKind","summary","state","rowsWritten","bytesWritten","createdAt"],"properties":{"type":{"description":"Always `ExptViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ExptViewAttributes"]},"exportId":{"$ref":"#/components/schemas/ExptId"},"source":{"description":"What it exports.","type":"string"},"sourceKind":{"$ref":"#/components/schemas/ExptSourceKind"},"summary":{"description":"What was asked of the source: the names of the parameters given, never their values.","type":"string"},"state":{"$ref":"#/components/schemas/ExptState"},"rowsWritten":{"description":"Rows written so far, the header aside.","type":"integer","format":"int64"},"bytesWritten":{"description":"Bytes of the compressed file written so far.","type":"integer","format":"int64"},"failureCode":{"$ref":"#/components/schemas/ExptFailureCode"},"failure":{"description":"Why it failed, in words, when it has.","type":"string"},"downloadUrl":{"description":"When it is done: a link to the file, signed for you as you asked and valid for a few minutes. Read the export again for a fresh one.","type":"string"},"downloadUrlExpiresAt":{"description":"When `downloadUrl` stops working.","type":"string","format":"date-time"},"createdAt":{"type":"string","format":"date-time"},"startedAt":{"description":"When it was first taken up to be written.","type":"string","format":"date-time"},"finishedAt":{"description":"When it was done, failed or cancelled.","type":"string","format":"date-time"}}},"ExptjobActed":{"description":"What an action on many exports did: the exports it changed, as they now are, and those it left as they were.","oneOf":[{"$ref":"#/components/schemas/ExptjobActedAttributes"}],"discriminator":{"propertyName":"type","mapping":{"ExptjobActedAttributes":"#/components/schemas/ExptjobActedAttributes"}}},"ExptjobActedAttributes":{"title":"ExptjobActedAttributes","description":"What an action on many exports did: the exports it changed, as they now are, and those it left as they were.","examples":[{"type":"ExptjobActedAttributes","acted":[{"type":"ExptjobViewAttributes","exportJobId":"expt_9f2Kd8QpLzXw","tenant":"example","owner":"example","source":"example","sourceKind":"List","summary":"example","state":"Queued","rowsWritten":1250,"failureCode":"Refused","failure":"example","createdAt":"2026-08-19T04:21:07Z","startedAt":"2026-08-19T04:21:07Z","finishedAt":"2026-08-19T04:21:07Z"}],"skipped":["expt_9f2Kd8QpLzXw"]}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `ExptjobActedAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ExptjobActedAttributes"]},"acted":{"description":"The exports it changed.","type":"array","items":{"$ref":"#/components/schemas/ExptjobView"}},"skipped":{"description":"The exports it left, because their tenant already ran as many as it may.","type":"array","items":{"$ref":"#/components/schemas/ExptjobId"}}}},"ExptjobId":{"title":"ExptjobId","description":"Identifier of an export, as its owner names it.","examples":["expt_9f2Kd8QpLzXw"],"type":"string"},"ExptjobUpdate":{"oneOf":[{"$ref":"#/components/schemas/ExptjobUpdateCancel"},{"$ref":"#/components/schemas/ExptjobUpdateRequeue"}],"discriminator":{"propertyName":"type","mapping":{"ExptjobUpdateCancel":"#/components/schemas/ExptjobUpdateCancel","ExptjobUpdateRequeue":"#/components/schemas/ExptjobUpdateRequeue"}}},"ExptjobUpdateCancel":{"title":"ExptjobUpdateCancel","description":"Stop it while it is queued or being written. A run in progress stops at its next page, and no file is offered.","examples":[{"type":"ExptjobUpdateCancel"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `ExptjobUpdateCancel`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ExptjobUpdateCancel"]}}},"ExptjobUpdateRequeue":{"title":"ExptjobUpdateRequeue","description":"Put it back in the queue, when it failed on the platform's side (`WaitedTooLong`, `Stopped`, `Interrupted`, `NotWritten`, `QueueGaveUp`) a few days ago at most. It runs as its owner, with only what they may read when it runs.","examples":[{"type":"ExptjobUpdateRequeue"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `ExptjobUpdateRequeue`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ExptjobUpdateRequeue"]}}},"ExptjobView":{"description":"An export job as an operator sees it: whose it is, what it reads, and how far it got. Never its file, its rows or a link to them.","oneOf":[{"$ref":"#/components/schemas/ExptjobViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"ExptjobViewAttributes":"#/components/schemas/ExptjobViewAttributes"}}},"ExptjobViewAttributes":{"title":"ExptjobViewAttributes","description":"An export job as an operator sees it: whose it is, what it reads, and how far it got. Never its file, its rows or a link to them.","examples":[{"type":"ExptjobViewAttributes","exportJobId":"expt_9f2Kd8QpLzXw","tenant":"example","owner":"example","source":"example","sourceKind":"List","summary":"example","state":"Queued","rowsWritten":1250,"failureCode":"Refused","failure":"example","createdAt":"2026-08-19T04:21:07Z","startedAt":"2026-08-19T04:21:07Z","finishedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","exportJobId","tenant","owner","source","sourceKind","summary","state","rowsWritten","createdAt"],"properties":{"type":{"description":"Always `ExptjobViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ExptjobViewAttributes"]},"exportJobId":{"$ref":"#/components/schemas/ExptjobId"},"tenant":{"description":"The tenant it was asked in, by contextual id, or `platform`.","type":"string"},"owner":{"description":"Who asked, keyed as reporting keys an owner: `user_`, `key_`, or `staff_` and the SHA-256 of an email address.","type":"string"},"source":{"description":"What it exports.","type":"string"},"sourceKind":{"$ref":"#/components/schemas/ExptSourceKind"},"summary":{"description":"What was asked of the source: the names of the parameters given, never their values.","type":"string"},"state":{"$ref":"#/components/schemas/ExptState"},"rowsWritten":{"description":"Rows written so far, the header aside.","type":"integer","format":"int64"},"failureCode":{"$ref":"#/components/schemas/ExptFailureCode"},"failure":{"description":"Why it failed, in words, when it has.","type":"string"},"createdAt":{"type":"string","format":"date-time"},"startedAt":{"description":"When it was first taken up to be written.","type":"string","format":"date-time"},"finishedAt":{"description":"When it was done, failed or cancelled.","type":"string","format":"date-time"}}},"ExptjobsUpdate":{"oneOf":[{"$ref":"#/components/schemas/ExptjobsUpdateCancelTenant"},{"$ref":"#/components/schemas/ExptjobsUpdateRequeueFailed"}],"discriminator":{"propertyName":"type","mapping":{"ExptjobsUpdateCancelTenant":"#/components/schemas/ExptjobsUpdateCancelTenant","ExptjobsUpdateRequeueFailed":"#/components/schemas/ExptjobsUpdateRequeueFailed"}}},"ExptjobsUpdateCancelTenant":{"title":"ExptjobsUpdateCancelTenant","description":"Cancel every queued or running export of one tenant, that tenant's own and not those beneath it.","examples":[{"type":"ExptjobsUpdateCancelTenant","tenant":"example"}],"type":"object","required":["type","tenant"],"properties":{"type":{"description":"Always `ExptjobsUpdateCancelTenant`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ExptjobsUpdateCancelTenant"]},"tenant":{"description":"The tenant, by contextual id (`ent_`, `mktp_`, `mcht_`), or `platform`.","type":"string"}}},"ExptjobsUpdateRequeueFailed":{"title":"ExptjobsUpdateRequeueFailed","description":"Put back in the queue every export that failed on the platform's side since a time, oldest first and at most 500, each only while its tenant runs fewer than it may. Each runs as its owner, with only what they may read when it runs.","examples":[{"type":"ExptjobsUpdateRequeueFailed","since":"2026-08-19T04:21:07Z","tenant":"example"}],"type":"object","required":["type","since"],"properties":{"type":{"description":"Always `ExptjobsUpdateRequeueFailed`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ExptjobsUpdateRequeueFailed"]},"since":{"description":"The earliest failure to put back.","type":"string","format":"date-time"},"tenant":{"description":"Only this tenant's and those beneath it, by contextual id; absent for every tenant's.","type":"string"}}},"Fcat":{"description":"The filters one list offers this caller, with the operators each takes and how its values are found.","oneOf":[{"$ref":"#/components/schemas/FcatAttributes"}],"discriminator":{"propertyName":"type","mapping":{"FcatAttributes":"#/components/schemas/FcatAttributes"}}},"FcatAttributes":{"title":"FcatAttributes","description":"The filters one list offers this caller, with the operators each takes and how its values are found.","examples":[{"type":"FcatAttributes","filterCatalogueId":"abc123","label":"example","search":{"type":"FcatSearchNotOffered"},"filters":[{"type":"FcatFilterAttributes","name":"Ada Lovelace","label":"example","summary":"example","description":"A short description.","kind":"Enum","group":"example","operators":[{"type":"FcatOperatorAttributes","operator":"In","parameter":"example","inclusive":true}],"values":{"type":"FcatValuesEntered","reason":"Requested by the customer."},"identifies":"example","default":{"type":"FcatDefaultLast","days":1250}}]}],"type":"object","required":["type","filterCatalogueId","label","search"],"properties":{"type":{"description":"Always `FcatAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["FcatAttributes"]},"filterCatalogueId":{"description":"The collection whose list this catalogue describes, which is also its id, such as `transactions`.","type":"string"},"label":{"type":"string"},"search":{"$ref":"#/components/schemas/FcatSearch"},"filters":{"description":"Only the filters this caller can use: one it could give a single value, such as a merchant's own merchant, is left out, as is one over data it may not see. Filters combine with AND; the values of one filter with OR.","type":"array","items":{"$ref":"#/components/schemas/FcatFilter"}}}},"FcatColumn":{"title":"FcatColumn","type":"string","enum":["FilterCatalogueId","Label"]},"FcatDefault":{"description":"What the list applies when the filter is not sent, or `null` when it applies nothing.","oneOf":[{"$ref":"#/components/schemas/FcatDefaultLast"}],"discriminator":{"propertyName":"type","mapping":{"FcatDefaultLast":"#/components/schemas/FcatDefaultLast"}}},"FcatDefaultLast":{"title":"FcatDefaultLast","description":"The list reads the last `days` days.","examples":[{"type":"FcatDefaultLast","days":1250}],"type":"object","required":["type","days"],"properties":{"type":{"description":"Always `FcatDefaultLast`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["FcatDefaultLast"]},"days":{"type":"integer","format":"int32"}}},"FcatFilter":{"description":"One filter of a list.","oneOf":[{"$ref":"#/components/schemas/FcatFilterAttributes"}],"discriminator":{"propertyName":"type","mapping":{"FcatFilterAttributes":"#/components/schemas/FcatFilterAttributes"}}},"FcatFilterAttributes":{"title":"FcatFilterAttributes","description":"One filter of a list.","examples":[{"type":"FcatFilterAttributes","name":"Ada Lovelace","label":"example","summary":"example","description":"A short description.","kind":"Enum","group":"example","operators":[{"type":"FcatOperatorAttributes","operator":"In","parameter":"example","inclusive":true}],"values":{"type":"FcatValuesEntered","reason":"Requested by the customer."},"identifies":"example","default":{"type":"FcatDefaultLast","days":1250}}],"type":"object","required":["type","name","label","summary","description","kind","group","values"],"properties":{"type":{"description":"Always `FcatFilterAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["FcatFilterAttributes"]},"name":{"description":"The filter's name, the parameter its equals is sent as.","type":"string"},"label":{"description":"What a person reads on a chip and in an Add Filter menu.","type":"string"},"summary":{"description":"One line for a menu, at most 50 characters.","type":"string"},"description":{"type":"string"},"kind":{"$ref":"#/components/schemas/FcatKind"},"group":{"description":"The heading a client files it under beside the list's other filters, such as `Tenancy` or `Time`.","type":"string"},"operators":{"description":"Each operator it takes, with the exact query parameter that operator is sent as.","type":"array","items":{"$ref":"#/components/schemas/FcatOperator"}},"values":{"$ref":"#/components/schemas/FcatValues"},"identifies":{"description":"For an `Id`, the collection its values are the ids of, so a client links a chosen value to its record.","type":"string"},"default":{"$ref":"#/components/schemas/FcatDefault"}}},"FcatKind":{"title":"FcatKind","type":"string","enum":["Enum","Text","Id","Amount","Decimal","Instant","Date","Boolean","Currency","Unknown"]},"FcatOperator":{"oneOf":[{"$ref":"#/components/schemas/FcatOperatorAttributes"}],"discriminator":{"propertyName":"type","mapping":{"FcatOperatorAttributes":"#/components/schemas/FcatOperatorAttributes"}}},"FcatOperatorAttributes":{"title":"FcatOperatorAttributes","examples":[{"type":"FcatOperatorAttributes","operator":"In","parameter":"example","inclusive":true}],"type":"object","required":["type","operator","parameter"],"properties":{"type":{"description":"Always `FcatOperatorAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["FcatOperatorAttributes"]},"operator":{"$ref":"#/components/schemas/FcatOperatorName"},"parameter":{"description":"The query parameter this operator is sent as, such as `merchantIdNot`.","type":"string"},"inclusive":{"description":"For `Before`, whether a row at the bound itself matches: `true` reads at or before, `false` strictly before. `null` for any other operator.","type":"boolean"}}},"FcatOperatorName":{"title":"FcatOperatorName","type":"string","enum":["In","Equals","NotIn","NotEquals","Absent","Contains","Prefix","Above","AtLeast","Below","AtMost","After","Before","Between","Unknown"]},"FcatOption":{"oneOf":[{"$ref":"#/components/schemas/FcatOptionAttributes"}],"discriminator":{"propertyName":"type","mapping":{"FcatOptionAttributes":"#/components/schemas/FcatOptionAttributes"}}},"FcatOptionAttributes":{"title":"FcatOptionAttributes","examples":[{"type":"FcatOptionAttributes","value":"example","label":"example"}],"type":"object","required":["type","value","label"],"properties":{"type":{"description":"Always `FcatOptionAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["FcatOptionAttributes"]},"value":{"description":"The value to send.","type":"string"},"label":{"type":"string"}}},"FcatPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/FcatPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"FcatPageAttributes":"#/components/schemas/FcatPageAttributes"}}},"FcatPageAttributes":{"title":"FcatPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"FcatPageAttributes","data":[{"type":"FcatAttributes","filterCatalogueId":"abc123","label":"example","search":{"type":"FcatSearchNotOffered"},"filters":[{"type":"FcatFilterAttributes","name":"Ada Lovelace","label":"example","summary":"example","description":"A short description.","kind":"Enum","group":"example","operators":[{"type":"FcatOperatorAttributes","operator":"In","parameter":"example","inclusive":true}],"values":{"type":"FcatValuesEntered","reason":"Requested by the customer."},"identifies":"example","default":{"type":"FcatDefaultLast","days":1250}}]}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `FcatPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["FcatPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/Fcat"}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"FcatSearch":{"description":"Whether the list takes `q`, and what it matches.","oneOf":[{"$ref":"#/components/schemas/FcatSearchNotOffered"},{"$ref":"#/components/schemas/FcatSearchOffered"}],"discriminator":{"propertyName":"type","mapping":{"FcatSearchNotOffered":"#/components/schemas/FcatSearchNotOffered","FcatSearchOffered":"#/components/schemas/FcatSearchOffered"}}},"FcatSearchNotOffered":{"title":"FcatSearchNotOffered","description":"The list takes no `q`.","examples":[{"type":"FcatSearchNotOffered"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `FcatSearchNotOffered`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["FcatSearchNotOffered"]}}},"FcatSearchOffered":{"title":"FcatSearchOffered","description":"The list takes `q`.","examples":[{"type":"FcatSearchOffered","matches":"example"}],"type":"object","required":["type","matches"],"properties":{"type":{"description":"Always `FcatSearchOffered`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["FcatSearchOffered"]},"matches":{"description":"What `q` matches, as the list's own description of `q` says.","type":"string"}}},"FcatValue":{"description":"One value a filter can take, with what a person reads for it.","oneOf":[{"$ref":"#/components/schemas/FcatValueAttributes"}],"discriminator":{"propertyName":"type","mapping":{"FcatValueAttributes":"#/components/schemas/FcatValueAttributes"}}},"FcatValueAttributes":{"title":"FcatValueAttributes","description":"One value a filter can take, with what a person reads for it.","examples":[{"type":"FcatValueAttributes","value":"example","label":"example"}],"type":"object","required":["type","value","label"],"properties":{"type":{"description":"Always `FcatValueAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["FcatValueAttributes"]},"value":{"description":"The value to send in the filter's parameter.","type":"string"},"label":{"type":"string"}}},"FcatValuePage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/FcatValuePageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"FcatValuePageAttributes":"#/components/schemas/FcatValuePageAttributes"}}},"FcatValuePageAttributes":{"title":"FcatValuePageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"FcatValuePageAttributes","data":[{"type":"FcatValueAttributes","value":"example","label":"example"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `FcatValuePageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["FcatValuePageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/FcatValue"}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"FcatValues":{"description":"How a person finds a value to give it.","oneOf":[{"$ref":"#/components/schemas/FcatValuesEntered"},{"$ref":"#/components/schemas/FcatValuesListed"},{"$ref":"#/components/schemas/FcatValuesReferenced"},{"$ref":"#/components/schemas/FcatValuesSearched"}],"discriminator":{"propertyName":"type","mapping":{"FcatValuesEntered":"#/components/schemas/FcatValuesEntered","FcatValuesListed":"#/components/schemas/FcatValuesListed","FcatValuesReferenced":"#/components/schemas/FcatValuesReferenced","FcatValuesSearched":"#/components/schemas/FcatValuesSearched"}}},"FcatValuesEntered":{"title":"FcatValuesEntered","description":"Typed by the person: a number, a time, a yes or no, or text with nothing to pick from. Nothing is read for it.","examples":[{"type":"FcatValuesEntered","reason":"Requested by the customer."}],"type":"object","required":["type","reason"],"properties":{"type":{"description":"Always `FcatValuesEntered`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["FcatValuesEntered"]},"reason":{"description":"Why this filter's values are typed rather than picked.","type":"string"}}},"FcatValuesListed":{"title":"FcatValuesListed","description":"A fixed set: pick from `options`, with no read.","examples":[{"type":"FcatValuesListed","options":[{"type":"FcatOptionAttributes","value":"example","label":"example"}]}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `FcatValuesListed`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["FcatValuesListed"]},"options":{"type":"array","items":{"$ref":"#/components/schemas/FcatOption"}}}},"FcatValuesReferenced":{"title":"FcatValuesReferenced","description":"Ids of another collection: read them from `/filter-catalogues/{filterCatalogueId}/filter-values`, which runs that collection's search under the list's own authority and answers each id with its label only.","examples":[{"type":"FcatValuesReferenced","collection":"example","minimumSearch":1250}],"type":"object","required":["type","collection","minimumSearch"],"properties":{"type":{"description":"Always `FcatValuesReferenced`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["FcatValuesReferenced"]},"collection":{"type":"string"},"minimumSearch":{"description":"How many characters of `q` the read needs.","type":"integer","format":"int32"}}},"FcatValuesSearched":{"title":"FcatValuesSearched","description":"The filter's own stored values: read them from `/filter-catalogues/{filterCatalogueId}/filter-values`.","examples":[{"type":"FcatValuesSearched","minimumSearch":1250}],"type":"object","required":["type","minimumSearch"],"properties":{"type":{"description":"Always `FcatValuesSearched`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["FcatValuesSearched"]},"minimumSearch":{"description":"How many characters of `q` the read needs.","type":"integer","format":"int32"}}},"Fee":{"oneOf":[{"$ref":"#/components/schemas/FeeAttributes"}],"discriminator":{"propertyName":"type","mapping":{"FeeAttributes":"#/components/schemas/FeeAttributes"}}},"FeeAttributes":{"title":"FeeAttributes","description":"A fee: a rate on the amount plus a fixed charge, with per-card overrides where they differ.","examples":[{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]}],"type":"object","required":["type","rate","fixed"],"properties":{"type":{"description":"Always `FeeAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["FeeAttributes"]},"rate":{"description":"A ratio of the amount, **not a percentage** `0.0175` is 1.75%. Zero to one.","type":"number"},"fixed":{"description":"Fixed charge in the smallest currency unit, cents for AUD. Added to the rate's product.","type":"integer","format":"int64"},"cards":{"description":"Overrides for particular cards. The most specific match wins; anything unmatched takes `rate` and `fixed`.","type":"array","items":{"$ref":"#/components/schemas/CardFee"}}}},"FeeStruct":{"description":"Fees by payment form. Superseded by `FeeStructEx`, which can price each pay-plan variant separately.","oneOf":[{"$ref":"#/components/schemas/FeeStructAttributes"}],"discriminator":{"propertyName":"type","mapping":{"FeeStructAttributes":"#/components/schemas/FeeStructAttributes"}}},"FeeStructAttributes":{"title":"FeeStructAttributes","description":"Fees by payment form. Superseded by `FeeStructEx`, which can price each pay-plan variant separately.","examples":[{"type":"FeeStructAttributes","split":{"type":"FeeTableAttributes","domestic":{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]},"international":{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]}},"full":{"type":"FeeTableAttributes","domestic":{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]},"international":{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]}}}],"type":"object","required":["type","split","full"],"properties":{"type":{"description":"Always `FeeStructAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["FeeStructAttributes"]},"split":{"$ref":"#/components/schemas/FeeTable","description":"Charged when the customer pays by plan."},"full":{"$ref":"#/components/schemas/FeeTable","description":"Charged when the customer pays in full."}}},"FeeStructEx":{"description":"Fees by payment form, with each pay-plan variant priced separately.","oneOf":[{"$ref":"#/components/schemas/FeeStructExAttributes"}],"discriminator":{"propertyName":"type","mapping":{"FeeStructExAttributes":"#/components/schemas/FeeStructExAttributes"}}},"FeeStructExAttributes":{"title":"FeeStructExAttributes","description":"Fees by payment form, with each pay-plan variant priced separately.","examples":[{"type":"FeeStructExAttributes","payPlanFees":[{"type":"PayPlanFeeEntryAttributes","payPlanVariant":"FourFortnightlyQuarters","customerType":"Consumer","feeTable":{"type":"FeeTableAttributes","domestic":{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]},"international":{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]}}}],"payCardFees":{"type":"FeeTableAttributes","domestic":{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]},"international":{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]}},"directDebitFees":{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]}}],"type":"object","required":["type","payPlanFees","payCardFees"],"properties":{"type":{"description":"Always `FeeStructExAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["FeeStructExAttributes"]},"payPlanFees":{"description":"One entry per pay-plan variant and customer type offered. A variant with no entry cannot be paid by.","type":"array","minItems":1,"items":{"$ref":"#/components/schemas/PayPlanFeeEntry"}},"payCardFees":{"$ref":"#/components/schemas/FeeTable","description":"Charged when the customer pays in full by card."},"directDebitFees":{"$ref":"#/components/schemas/Fee","description":"Charged when the customer pays by direct debit. Absent where direct debit is not offered."}}},"FeeTable":{"oneOf":[{"$ref":"#/components/schemas/FeeTableAttributes"}],"discriminator":{"propertyName":"type","mapping":{"FeeTableAttributes":"#/components/schemas/FeeTableAttributes"}}},"FeeTableAttributes":{"title":"FeeTableAttributes","description":"Domestic and international fees. Which applies is decided by the card's issuing country, not the payer's address.","examples":[{"type":"FeeTableAttributes","domestic":{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]},"international":{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]}}],"type":"object","required":["type","domestic","international"],"properties":{"type":{"description":"Always `FeeTableAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["FeeTableAttributes"]},"domestic":{"$ref":"#/components/schemas/Fee","description":"A fee: a rate on the amount plus a fixed charge, with per-card overrides where they differ."},"international":{"$ref":"#/components/schemas/Fee","description":"A fee: a rate on the amount plus a fixed charge, with per-card overrides where they differ."}}},"FeeadjAmounts":{"description":"What the fees came to before and after. Absent where the platform cannot say which currency the totals are in, see the note on the run.","oneOf":[{"$ref":"#/components/schemas/FeeadjAmountsAttributes"}],"discriminator":{"propertyName":"type","mapping":{"FeeadjAmountsAttributes":"#/components/schemas/FeeadjAmountsAttributes"}}},"FeeadjAmountsAttributes":{"title":"FeeadjAmountsAttributes","description":"What the fees came to before and after the run. All in the single currency given here.","examples":[{"type":"FeeadjAmountsAttributes","currency":"AUD","feesBefore":1250,"feesAfter":1250,"difference":1250}],"type":"object","required":["type","currency","feesBefore","feesAfter","difference"],"properties":{"type":{"description":"Always `FeeadjAmountsAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["FeeadjAmountsAttributes"]},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"feesBefore":{"$ref":"#/components/schemas/MinorUnits","description":"Fees as they stood across the transactions considered."},"feesAfter":{"$ref":"#/components/schemas/MinorUnits","description":"Fees as the run computes them."},"difference":{"$ref":"#/components/schemas/MinorUnits","description":"`feesAfter` less `feesBefore`. Negative means the merchant is owed money back."}}},"FeeadjCmd":{"oneOf":[{"$ref":"#/components/schemas/FeeadjCmdRun"}],"discriminator":{"propertyName":"type","mapping":{"FeeadjCmdRun":"#/components/schemas/FeeadjCmdRun"}}},"FeeadjCmdRun":{"title":"FeeadjCmdRun","description":"Recalculate the platform fees on a merchant's pay-in-full card payments in a window.","examples":[{"type":"FeeadjCmdRun","merchantId":"mcht_9f2Kd8QpLzXw","createdAtAfter":"2026-08-19T04:21:07Z","createdAtBefore":"2026-08-19T04:21:07Z","dryRun":true}],"type":"object","required":["type","merchantId","createdAtAfter","createdAtBefore","dryRun"],"properties":{"type":{"description":"Always `FeeadjCmdRun`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["FeeadjCmdRun"]},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"Whose fees to recalculate."},"createdAtAfter":{"description":"Consider transactions created at or after this instant.","type":"string","format":"date-time"},"createdAtBefore":{"description":"Consider transactions created before this instant.","type":"string","format":"date-time"},"dryRun":{"description":"`true` calculates the change without applying it. Required, there is no safe default.","type":"boolean"}}},"FeeadjCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/FeeadjCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"FeeadjCreateRspAttributes":"#/components/schemas/FeeadjCreateRspAttributes"}}},"FeeadjCreateRspAttributes":{"title":"FeeadjCreateRspAttributes","examples":[{"type":"FeeadjCreateRspAttributes","created":{"type":"FeeadjViewAttributes","merchantId":"mcht_9f2Kd8QpLzXw","dryRun":true,"createdAtAfter":"2026-08-19T04:21:07Z","createdAtBefore":"2026-08-19T04:21:07Z","transactionsConsidered":1250,"transactionsChanged":1250,"amounts":{"type":"FeeadjAmountsAttributes","currency":"AUD","feesBefore":1250,"feesAfter":1250,"difference":1250}}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `FeeadjCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["FeeadjCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/FeeadjView"}}},"FeeadjView":{"description":"The resource that was created.","oneOf":[{"$ref":"#/components/schemas/FeeadjViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"FeeadjViewAttributes":"#/components/schemas/FeeadjViewAttributes"}}},"FeeadjViewAttributes":{"title":"FeeadjViewAttributes","description":"What a fee-adjustment run did, or would do.","examples":[{"type":"FeeadjViewAttributes","merchantId":"mcht_9f2Kd8QpLzXw","dryRun":true,"createdAtAfter":"2026-08-19T04:21:07Z","createdAtBefore":"2026-08-19T04:21:07Z","transactionsConsidered":1250,"transactionsChanged":1250,"amounts":{"type":"FeeadjAmountsAttributes","currency":"AUD","feesBefore":1250,"feesAfter":1250,"difference":1250}}],"type":"object","required":["type","merchantId","dryRun","createdAtAfter","createdAtBefore","transactionsConsidered","transactionsChanged"],"properties":{"type":{"description":"Always `FeeadjViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["FeeadjViewAttributes"]},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"Whose fees were recalculated."},"dryRun":{"description":"Whether the run only calculated the change. A dry run writes nothing.","type":"boolean"},"createdAtAfter":{"description":"Transactions created at or after this instant were considered.","type":"string","format":"date-time"},"createdAtBefore":{"description":"Transactions created before this instant were considered.","type":"string","format":"date-time"},"transactionsConsidered":{"description":"How many transactions the run looked at.","type":"integer","format":"int64"},"transactionsChanged":{"description":"How many of them changed, or would change. Zero means the fees were already right.","type":"integer","format":"int64"},"amounts":{"$ref":"#/components/schemas/FeeadjAmounts"}}},"Fees":{"oneOf":[{"$ref":"#/components/schemas/FeesByPaymentForm"},{"$ref":"#/components/schemas/FeesPerPayPlan"}],"discriminator":{"propertyName":"type","mapping":{"FeesByPaymentForm":"#/components/schemas/FeesByPaymentForm","FeesPerPayPlan":"#/components/schemas/FeesPerPayPlan"}}},"FeesByPaymentForm":{"title":"FeesByPaymentForm","description":"Rates in the older shape, one table for paying in full, one for paying by plan. Superseded.","examples":[{"type":"FeesByPaymentForm","fees":{"type":"FeeStructAttributes","split":{"type":"FeeTableAttributes","domestic":{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]},"international":{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]}},"full":{"type":"FeeTableAttributes","domestic":{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]},"international":{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]}}}}],"type":"object","required":["type","fees"],"properties":{"type":{"description":"Always `FeesByPaymentForm`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["FeesByPaymentForm"]},"fees":{"$ref":"#/components/schemas/FeeStruct"}}},"FeesPerPayPlan":{"title":"FeesPerPayPlan","description":"Rates in the current shape, with each pay-plan variant priced separately.","examples":[{"type":"FeesPerPayPlan","fees":{"type":"FeeStructExAttributes","payPlanFees":[{"type":"PayPlanFeeEntryAttributes","payPlanVariant":"FourFortnightlyQuarters","customerType":"Consumer","feeTable":{"type":"FeeTableAttributes","domestic":{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]},"international":{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]}}}],"payCardFees":{"type":"FeeTableAttributes","domestic":{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]},"international":{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]}},"directDebitFees":{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]}}}],"type":"object","required":["type","fees"],"properties":{"type":{"description":"Always `FeesPerPayPlan`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["FeesPerPayPlan"]},"fees":{"$ref":"#/components/schemas/FeeStructEx"}}},"FflagColumn":{"title":"FflagColumn","type":"string","enum":["FeatureFlagId","Description","Mode","Saved","HeldClosed","Version","UpdatedAt","UpdatedBy"]},"FflagMode":{"title":"FflagMode","type":"string","enum":["Off","Platform","Everyone","Unknown"]},"FflagPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/FflagPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"FflagPageAttributes":"#/components/schemas/FflagPageAttributes"}}},"FflagPageAttributes":{"title":"FflagPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"FflagPageAttributes","data":[{"type":"FflagViewAttributes","featureFlagId":"abc123","description":"A short description.","mode":"Off","tenants":["example"],"users":["example"],"saved":true,"heldClosed":true,"version":1250,"updatedAt":"2026-08-19T04:21:07Z","updatedBy":"example"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `FflagPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["FflagPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/FflagView","description":"A feature the platform turns on for some callers before it turns it on for every caller, and who it is on for now. A caller it is off for is answered as though the feature's endpoints did not exist."}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"FflagUpdate":{"oneOf":[{"$ref":"#/components/schemas/FflagUpdateAddTenants"},{"$ref":"#/components/schemas/FflagUpdateAddUsers"},{"$ref":"#/components/schemas/FflagUpdateMode"},{"$ref":"#/components/schemas/FflagUpdateRemoveTenants"},{"$ref":"#/components/schemas/FflagUpdateRemoveUsers"}],"discriminator":{"propertyName":"type","mapping":{"FflagUpdateAddTenants":"#/components/schemas/FflagUpdateAddTenants","FflagUpdateAddUsers":"#/components/schemas/FflagUpdateAddUsers","FflagUpdateMode":"#/components/schemas/FflagUpdateMode","FflagUpdateRemoveTenants":"#/components/schemas/FflagUpdateRemoveTenants","FflagUpdateRemoveUsers":"#/components/schemas/FflagUpdateRemoveUsers"}}},"FflagUpdateAddTenants":{"title":"FflagUpdateAddTenants","description":"Turn it on for these tenants, and everything beneath them, by contextual id (`ent_`, `mktp_`, `mcht_`, `cust_`).","examples":[{"type":"FflagUpdateAddTenants","tenants":["example"]}],"type":"object","required":["type","tenants"],"properties":{"type":{"description":"Always `FflagUpdateAddTenants`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["FflagUpdateAddTenants"]},"tenants":{"type":"array","minItems":1,"items":{"type":"string"}}}},"FflagUpdateAddUsers":{"title":"FflagUpdateAddUsers","description":"Turn it on for these people: an IAM user's id (`user_`), a legacy staff member's key (`staff_`), or a legacy staff member's email address, which is kept only as its key.","examples":[{"type":"FflagUpdateAddUsers","users":["example"]}],"type":"object","required":["type","users"],"properties":{"type":{"description":"Always `FflagUpdateAddUsers`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["FflagUpdateAddUsers"]},"users":{"type":"array","minItems":1,"items":{"type":"string"}}}},"FflagUpdateMode":{"title":"FflagUpdateMode","description":"Set who it is on for before its lists. The lists are kept.","examples":[{"type":"FflagUpdateMode","mode":"Off"}],"type":"object","required":["type","mode"],"properties":{"type":{"description":"Always `FflagUpdateMode`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["FflagUpdateMode"]},"mode":{"$ref":"#/components/schemas/FflagMode"}}},"FflagUpdateRemoveTenants":{"title":"FflagUpdateRemoveTenants","description":"Take these tenants off its list. A tenant beneath one still listed keeps it.","examples":[{"type":"FflagUpdateRemoveTenants","tenants":["example"]}],"type":"object","required":["type","tenants"],"properties":{"type":{"description":"Always `FflagUpdateRemoveTenants`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["FflagUpdateRemoveTenants"]},"tenants":{"type":"array","minItems":1,"items":{"type":"string"}}}},"FflagUpdateRemoveUsers":{"title":"FflagUpdateRemoveUsers","description":"Take these people off its list, named as they are added.","examples":[{"type":"FflagUpdateRemoveUsers","users":["example"]}],"type":"object","required":["type","users"],"properties":{"type":{"description":"Always `FflagUpdateRemoveUsers`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["FflagUpdateRemoveUsers"]},"users":{"type":"array","minItems":1,"items":{"type":"string"}}}},"FflagUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/FflagUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"FflagUpdateRspAttributes":"#/components/schemas/FflagUpdateRspAttributes"}}},"FflagUpdateRspAttributes":{"title":"FflagUpdateRspAttributes","examples":[{"type":"FflagUpdateRspAttributes","updated":{"type":"FflagViewAttributes","featureFlagId":"abc123","description":"A short description.","mode":"Off","tenants":["example"],"users":["example"],"saved":true,"heldClosed":true,"version":1250,"updatedAt":"2026-08-19T04:21:07Z","updatedBy":"example"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `FflagUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["FflagUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/FflagView","description":"The resource as it stands after the change."}}},"FflagView":{"oneOf":[{"$ref":"#/components/schemas/FflagViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"FflagViewAttributes":"#/components/schemas/FflagViewAttributes"}}},"FflagViewAttributes":{"title":"FflagViewAttributes","description":"A feature the platform turns on for some callers before it turns it on for every caller, and who it is on for now. A caller it is off for is answered as though the feature's endpoints did not exist.","examples":[{"type":"FflagViewAttributes","featureFlagId":"abc123","description":"A short description.","mode":"Off","tenants":["example"],"users":["example"],"saved":true,"heldClosed":true,"version":1250,"updatedAt":"2026-08-19T04:21:07Z","updatedBy":"example"}],"type":"object","required":["type","featureFlagId","description","mode","saved","heldClosed"],"properties":{"type":{"description":"Always `FflagViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["FflagViewAttributes"]},"featureFlagId":{"description":"The flag's name, which is also its id. Only the flags the platform declares exist.","type":"string"},"description":{"description":"What the flag turns on.","type":"string"},"mode":{"$ref":"#/components/schemas/FflagMode","description":"Who it is on for before its lists."},"tenants":{"description":"Enterprises, marketplaces, merchants and customers it is on for, by contextual id. A tenant takes every tenant beneath it with it.","type":"array","items":{"type":"string"}},"users":{"description":"People it is on for, whatever tenant they sign in to: an IAM user's id (`user_`), or a legacy staff member's key (`staff_` and the SHA-256 of their trimmed, lower-cased email address).","type":"array","items":{"type":"string"}},"saved":{"description":"Whether a platform admin has changed it. Until one does, it is on for whom this environment's default says.","type":"boolean"},"heldClosed":{"description":"True where what is saved cannot be read. The flag is then on for the platform alone, if its default is on for the platform, and for no tenant or person, until it is next changed.","type":"boolean"},"version":{"description":"How many times it has been changed. Absent until it first is.","type":"integer","format":"int32"},"updatedAt":{"description":"When it was last changed. Absent until it first is.","type":"string","format":"date-time"},"updatedBy":{"description":"Who last changed it, keyed as `users` keys a person. Absent until it first is.","type":"string"}}},"FxconvAmount":{"oneOf":[{"$ref":"#/components/schemas/FxconvAmountMajorUnits"},{"$ref":"#/components/schemas/FxconvAmountMinorUnits"}],"discriminator":{"propertyName":"type","mapping":{"FxconvAmountMajorUnits":"#/components/schemas/FxconvAmountMajorUnits","FxconvAmountMinorUnits":"#/components/schemas/FxconvAmountMinorUnits"}}},"FxconvAmountMajorUnits":{"title":"FxconvAmountMajorUnits","description":"Major units of the base currency, as a decimal string, `12.50`.","examples":[{"type":"FxconvAmountMajorUnits","majorUnits":"example"}],"type":"object","required":["type","majorUnits"],"properties":{"type":{"description":"Always `FxconvAmountMajorUnits`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["FxconvAmountMajorUnits"]},"majorUnits":{"type":"string"}}},"FxconvAmountMinorUnits":{"title":"FxconvAmountMinorUnits","description":"Whole minor units of the base currency, `1250` is $12.50.","examples":[{"type":"FxconvAmountMinorUnits","minorUnits":1250}],"type":"object","required":["type","minorUnits"],"properties":{"type":{"description":"Always `FxconvAmountMinorUnits`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["FxconvAmountMinorUnits"]},"minorUnits":{"type":"integer","format":"int64"}}},"FxconvAmounts":{"description":"What a conversion came to. Two currencies, because a conversion is two-sided.","oneOf":[{"$ref":"#/components/schemas/FxconvAmountsAttributes"}],"discriminator":{"propertyName":"type","mapping":{"FxconvAmountsAttributes":"#/components/schemas/FxconvAmountsAttributes"}}},"FxconvAmountsAttributes":{"title":"FxconvAmountsAttributes","description":"What a conversion came to. Two currencies, because a conversion is two-sided.","examples":[{"type":"FxconvAmountsAttributes","sourceCurrency":"AUD","termCurrency":"AUD","termAmountMinorUnits":1250,"termAmountMajorUnits":"example","termAmountUnrounded":"example"}],"type":"object","required":["type","sourceCurrency","termCurrency","termAmountMinorUnits","termAmountMajorUnits","termAmountUnrounded"],"properties":{"type":{"description":"Always `FxconvAmountsAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["FxconvAmountsAttributes"]},"sourceCurrency":{"$ref":"#/components/schemas/IsoCurrency","description":"The currency converted from."},"termCurrency":{"$ref":"#/components/schemas/IsoCurrency","description":"The currency converted to."},"termAmountMinorUnits":{"description":"What to charge, in whole minor units of the term currency.","type":"integer","format":"int64"},"termAmountMajorUnits":{"description":"The same figure in major units, as a decimal string.","type":"string"},"termAmountUnrounded":{"description":"What the arithmetic produced at the requested precision, before rounding to whole minor units.","type":"string"}}},"FxconvCmd":{"oneOf":[{"$ref":"#/components/schemas/FxconvCmdConvert"}],"discriminator":{"propertyName":"type","mapping":{"FxconvCmdConvert":"#/components/schemas/FxconvCmdConvert"}}},"FxconvCmdConvert":{"title":"FxconvCmdConvert","description":"Convert an amount at an enterprise's rates.","examples":[{"type":"FxconvCmdConvert","enterpriseId":"ent_9f2Kd8QpLzXw","rateSetCode":"0.9412","baseCurrency":"AUD","termCurrency":"AUD","amount":{"type":"FxconvAmountMajorUnits","majorUnits":"example"},"customerBuysBase":true,"roundingMode":"example","precision":1250,"ratesAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","enterpriseId","rateSetCode","baseCurrency","termCurrency","amount","customerBuysBase"],"properties":{"type":{"description":"Always `FxconvCmdConvert`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["FxconvCmdConvert"]},"enterpriseId":{"$ref":"#/components/schemas/EntId","description":"Identifier of an enterprise."},"rateSetCode":{"description":"Which rate set to price from.","type":"string"},"baseCurrency":{"$ref":"#/components/schemas/IsoCurrency","description":"The currency being converted from."},"termCurrency":{"$ref":"#/components/schemas/IsoCurrency","description":"The currency being converted to."},"amount":{"$ref":"#/components/schemas/FxconvAmount"},"customerBuysBase":{"description":"`true` where the customer is buying the base currency, so the ask rate applies; `false` where they are selling it, so the bid does. Required, half of all conversions would otherwise be priced on the wrong side of the spread.","type":"boolean"},"roundingMode":{"description":"How to round, `HALF_EVEN`, `HALF_UP`, `FLOOR`, `CEILING`, `DOWN`, `UP`. Defaults to `HALF_EVEN`.","type":"string"},"precision":{"description":"Decimal places for the unrounded figure. Defaults to 8.","type":"integer","format":"int32"},"ratesAt":{"description":"Price at the rates as they stood at this instant. Defaults to the current rates.","type":"string","format":"date-time"}}},"FxconvCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/FxconvCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"FxconvCreateRspAttributes":"#/components/schemas/FxconvCreateRspAttributes"}}},"FxconvCreateRspAttributes":{"title":"FxconvCreateRspAttributes","examples":[{"type":"FxconvCreateRspAttributes","created":{"type":"FxconvViewAttributes","enterpriseId":"ent_9f2Kd8QpLzXw","rateSetCode":"0.9412","sourceAmount":"example","amounts":{"type":"FxconvAmountsAttributes","sourceCurrency":"AUD","termCurrency":"AUD","termAmountMinorUnits":1250,"termAmountMajorUnits":"example","termAmountUnrounded":"example"},"rate":{"type":"FxconvRateAttributes","baseCurrency":"AUD","termCurrency":"AUD","exchangeRate":"0.9412"},"crossRates":[{"type":"FxconvRateAttributes","baseCurrency":"AUD","termCurrency":"AUD","exchangeRate":"0.9412"}],"ratesUpdatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `FxconvCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["FxconvCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/FxconvView"}}},"FxconvRate":{"oneOf":[{"$ref":"#/components/schemas/FxconvRateAttributes"}],"discriminator":{"propertyName":"type","mapping":{"FxconvRateAttributes":"#/components/schemas/FxconvRateAttributes"}}},"FxconvRateAttributes":{"title":"FxconvRateAttributes","description":"A rate that was applied. `1.20` means one base buys 1.20 term.","examples":[{"type":"FxconvRateAttributes","baseCurrency":"AUD","termCurrency":"AUD","exchangeRate":"0.9412"}],"type":"object","required":["type","baseCurrency","termCurrency","exchangeRate"],"properties":{"type":{"description":"Always `FxconvRateAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["FxconvRateAttributes"]},"baseCurrency":{"$ref":"#/components/schemas/IsoCurrency"},"termCurrency":{"$ref":"#/components/schemas/IsoCurrency"},"exchangeRate":{"description":"Units of term currency for one unit of base. A decimal string, because a double cannot hold it.","type":"string"}}},"FxconvView":{"description":"The resource that was created.","oneOf":[{"$ref":"#/components/schemas/FxconvViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"FxconvViewAttributes":"#/components/schemas/FxconvViewAttributes"}}},"FxconvViewAttributes":{"title":"FxconvViewAttributes","description":"An amount converted at an enterprise's rates, with the rate used and what rounding did.","examples":[{"type":"FxconvViewAttributes","enterpriseId":"ent_9f2Kd8QpLzXw","rateSetCode":"0.9412","sourceAmount":"example","amounts":{"type":"FxconvAmountsAttributes","sourceCurrency":"AUD","termCurrency":"AUD","termAmountMinorUnits":1250,"termAmountMajorUnits":"example","termAmountUnrounded":"example"},"rate":{"type":"FxconvRateAttributes","baseCurrency":"AUD","termCurrency":"AUD","exchangeRate":"0.9412"},"crossRates":[{"type":"FxconvRateAttributes","baseCurrency":"AUD","termCurrency":"AUD","exchangeRate":"0.9412"}],"ratesUpdatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","enterpriseId","rateSetCode","sourceAmount","amounts","rate","ratesUpdatedAt"],"properties":{"type":{"description":"Always `FxconvViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["FxconvViewAttributes"]},"enterpriseId":{"$ref":"#/components/schemas/EntId","description":"Identifier of an enterprise."},"rateSetCode":{"description":"The rate set the conversion was priced from.","type":"string"},"sourceAmount":{"description":"The amount converted, in major units of the base currency.","type":"string"},"amounts":{"$ref":"#/components/schemas/FxconvAmounts"},"rate":{"$ref":"#/components/schemas/FxconvRate","description":"The rate applied, and the direction it was applied in."},"crossRates":{"description":"The rates used to get there where the pair is not quoted directly. Empty when it is, a direct rate needs no cross.","type":"array","items":{"$ref":"#/components/schemas/FxconvRate","description":"A rate that was applied. `1.20` means one base buys 1.20 term."}},"ratesUpdatedAt":{"description":"When the rates used were struck. Not when the conversion was made.","type":"string","format":"date-time"}}},"FxrsCmd":{"oneOf":[{"$ref":"#/components/schemas/FxrsCmdCreate"}],"discriminator":{"propertyName":"type","mapping":{"FxrsCmdCreate":"#/components/schemas/FxrsCmdCreate"}}},"FxrsCmdCreate":{"title":"FxrsCmdCreate","description":"Create a rate set with an initial set of rates.","examples":[{"type":"FxrsCmdCreate","rateSetCode":"0.9412","enterpriseId":"ent_9f2Kd8QpLzXw","description":"A short description.","crossCurrency":"AUD","timeZone":"example","ratesUpdatedAt":"2026-08-19T04:21:07Z","rates":[{"type":"FxrsRateAttributes","baseCurrency":"AUD","termCurrency":"AUD","bidRate":"0.9412","askRate":"0.9412"}]}],"type":"object","required":["type","rateSetCode","enterpriseId","description","crossCurrency","timeZone"],"properties":{"type":{"description":"Always `FxrsCmdCreate`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["FxrsCmdCreate"]},"rateSetCode":{"description":"The code this set will be known by. Unchangeable, and the only way to address it afterwards.","type":"string"},"enterpriseId":{"$ref":"#/components/schemas/EntId","description":"Identifier of an enterprise."},"description":{"type":"string"},"crossCurrency":{"$ref":"#/components/schemas/IsoCurrency","description":"The currency every rate is quoted through."},"timeZone":{"description":"The time zone the set's business day is reckoned in, `Australia/Sydney`.","type":"string"},"ratesUpdatedAt":{"description":"When the rates were struck. Defaults to now; supply it when loading rates from earlier.","type":"string","format":"date-time"},"rates":{"type":"array","items":{"$ref":"#/components/schemas/FxrsRate","description":"One exchange rate, two-sided. Rates are decimal strings in the base/term convention."}}}},"FxrsCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/FxrsCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"FxrsCreateRspAttributes":"#/components/schemas/FxrsCreateRspAttributes"}}},"FxrsCreateRspAttributes":{"title":"FxrsCreateRspAttributes","examples":[{"type":"FxrsCreateRspAttributes","created":{"type":"FxrsViewAttributes","fxRateSetId":"fxrset_9f2Kd8QpLzXw","rateSetCode":"0.9412","enterpriseId":"ent_9f2Kd8QpLzXw","description":"A short description.","crossCurrency":"AUD","timeZone":"example","rates":{"type":"FxrsSnapshotAttributes","ratesUpdatedAt":"2026-08-19T04:21:07Z","recordedAt":"2026-08-19T04:21:07Z","rates":[{"type":"FxrsRateAttributes","baseCurrency":"AUD","termCurrency":"AUD","bidRate":"0.9412","askRate":"0.9412"}]},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `FxrsCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["FxrsCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/FxrsView","description":"The resource that was created."}}},"FxrsCrossRates":{"description":"The rate for one currency pair, and the legs it was derived through.","oneOf":[{"$ref":"#/components/schemas/FxrsCrossRatesAttributes"}],"discriminator":{"propertyName":"type","mapping":{"FxrsCrossRatesAttributes":"#/components/schemas/FxrsCrossRatesAttributes"}}},"FxrsCrossRatesAttributes":{"title":"FxrsCrossRatesAttributes","description":"The rate for one currency pair, and the legs it was derived through.","examples":[{"type":"FxrsCrossRatesAttributes","rate":{"type":"FxrsRateAttributes","baseCurrency":"AUD","termCurrency":"AUD","bidRate":"0.9412","askRate":"0.9412"},"crossRates":[{"type":"FxrsRateAttributes","baseCurrency":"AUD","termCurrency":"AUD","bidRate":"0.9412","askRate":"0.9412"}]}],"type":"object","required":["type","rate"],"properties":{"type":{"description":"Always `FxrsCrossRatesAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["FxrsCrossRatesAttributes"]},"rate":{"$ref":"#/components/schemas/FxrsRate","description":"The effective rate for the pair asked for, two-sided."},"crossRates":{"description":"The legs used to get there. Empty where the set quotes the pair directly.","type":"array","items":{"$ref":"#/components/schemas/FxrsRate","description":"One exchange rate, two-sided. Rates are decimal strings in the base/term convention."}}}},"FxrsId":{"title":"FxrsId","description":"Identifier of an FX rate set.","examples":["fxrset_9f2Kd8QpLzXw"],"type":"string"},"FxrsRate":{"oneOf":[{"$ref":"#/components/schemas/FxrsRateAttributes"}],"discriminator":{"propertyName":"type","mapping":{"FxrsRateAttributes":"#/components/schemas/FxrsRateAttributes"}}},"FxrsRateAttributes":{"title":"FxrsRateAttributes","description":"One exchange rate, two-sided. Rates are decimal strings in the base/term convention.","examples":[{"type":"FxrsRateAttributes","baseCurrency":"AUD","termCurrency":"AUD","bidRate":"0.9412","askRate":"0.9412"}],"type":"object","required":["type","baseCurrency","termCurrency","bidRate","askRate"],"properties":{"type":{"description":"Always `FxrsRateAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["FxrsRateAttributes"]},"baseCurrency":{"$ref":"#/components/schemas/IsoCurrency","description":"The currency bought one unit of, `AUD` in `AUD/USD`."},"termCurrency":{"$ref":"#/components/schemas/IsoCurrency","description":"The currency paid in, `USD` in `AUD/USD`. `1.20` means one base buys 1.20 term."},"bidRate":{"description":"Use when the customer **sells** the base currency.","type":"string"},"askRate":{"description":"Use when the customer **buys** it. The gap between the two is the spread.","type":"string"}}},"FxrsSnapshot":{"description":"The rates as they currently stand. Absent where none has been loaded.","oneOf":[{"$ref":"#/components/schemas/FxrsSnapshotAttributes"}],"discriminator":{"propertyName":"type","mapping":{"FxrsSnapshotAttributes":"#/components/schemas/FxrsSnapshotAttributes"}}},"FxrsSnapshotAttributes":{"title":"FxrsSnapshotAttributes","description":"The rates as they stood at one moment.","examples":[{"type":"FxrsSnapshotAttributes","ratesUpdatedAt":"2026-08-19T04:21:07Z","recordedAt":"2026-08-19T04:21:07Z","rates":[{"type":"FxrsRateAttributes","baseCurrency":"AUD","termCurrency":"AUD","bidRate":"0.9412","askRate":"0.9412"}]}],"type":"object","required":["type","ratesUpdatedAt","recordedAt"],"properties":{"type":{"description":"Always `FxrsSnapshotAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["FxrsSnapshotAttributes"]},"ratesUpdatedAt":{"description":"When the rates were struck. This is the one that decides which rate applied.","type":"string","format":"date-time"},"recordedAt":{"description":"When the platform recorded them.","type":"string","format":"date-time"},"rates":{"type":"array","items":{"$ref":"#/components/schemas/FxrsRate","description":"One exchange rate, two-sided. Rates are decimal strings in the base/term convention."}}}},"FxrsUpdate":{"oneOf":[{"$ref":"#/components/schemas/FxrsUpdateRates"}],"discriminator":{"propertyName":"type","mapping":{"FxrsUpdateRates":"#/components/schemas/FxrsUpdateRates"}}},"FxrsUpdateRates":{"title":"FxrsUpdateRates","description":"Load new rates into the set.","examples":[{"type":"FxrsUpdateRates","rates":[{"type":"FxrsRateAttributes","baseCurrency":"AUD","termCurrency":"AUD","bidRate":"0.9412","askRate":"0.9412"}],"ratesUpdatedAt":"2026-08-19T04:21:07Z","replaceOldRates":true}],"type":"object","required":["type","rates","replaceOldRates"],"properties":{"type":{"description":"Always `FxrsUpdateRates`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["FxrsUpdateRates"]},"rates":{"description":"The rates to load. At least one, the platform takes a non-empty set, and this now says so rather than refusing after the fact.","type":"array","minItems":1,"items":{"$ref":"#/components/schemas/FxrsRate","description":"One exchange rate, two-sided. Rates are decimal strings in the base/term convention."}},"ratesUpdatedAt":{"description":"When they were struck. Defaults to now.","type":"string","format":"date-time"},"replaceOldRates":{"description":"`true` replaces the set's rates with these. `false` merges them, leaving pairs you did not send as they were. Required, neither default is safe.","type":"boolean"}}},"FxrsUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/FxrsUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"FxrsUpdateRspAttributes":"#/components/schemas/FxrsUpdateRspAttributes"}}},"FxrsUpdateRspAttributes":{"title":"FxrsUpdateRspAttributes","examples":[{"type":"FxrsUpdateRspAttributes","updated":{"type":"FxrsViewAttributes","fxRateSetId":"fxrset_9f2Kd8QpLzXw","rateSetCode":"0.9412","enterpriseId":"ent_9f2Kd8QpLzXw","description":"A short description.","crossCurrency":"AUD","timeZone":"example","rates":{"type":"FxrsSnapshotAttributes","ratesUpdatedAt":"2026-08-19T04:21:07Z","recordedAt":"2026-08-19T04:21:07Z","rates":[{"type":"FxrsRateAttributes","baseCurrency":"AUD","termCurrency":"AUD","bidRate":"0.9412","askRate":"0.9412"}]},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `FxrsUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["FxrsUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/FxrsView","description":"The resource as it stands after the change."}}},"FxrsView":{"oneOf":[{"$ref":"#/components/schemas/FxrsViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"FxrsViewAttributes":"#/components/schemas/FxrsViewAttributes"}}},"FxrsViewAttributes":{"title":"FxrsViewAttributes","description":"A set of exchange rates an enterprise maintains.","examples":[{"type":"FxrsViewAttributes","fxRateSetId":"fxrset_9f2Kd8QpLzXw","rateSetCode":"0.9412","enterpriseId":"ent_9f2Kd8QpLzXw","description":"A short description.","crossCurrency":"AUD","timeZone":"example","rates":{"type":"FxrsSnapshotAttributes","ratesUpdatedAt":"2026-08-19T04:21:07Z","recordedAt":"2026-08-19T04:21:07Z","rates":[{"type":"FxrsRateAttributes","baseCurrency":"AUD","termCurrency":"AUD","bidRate":"0.9412","askRate":"0.9412"}]},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","fxRateSetId","rateSetCode","enterpriseId","description","crossCurrency","timeZone","createdAt","updatedAt"],"properties":{"type":{"description":"Always `FxrsViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["FxrsViewAttributes"]},"fxRateSetId":{"$ref":"#/components/schemas/FxrsId"},"rateSetCode":{"description":"The code this set is known by. Chosen at creation, unchangeable, and unique only within the enterprise.","type":"string"},"enterpriseId":{"$ref":"#/components/schemas/EntId","description":"Identifier of an enterprise."},"description":{"description":"What the set is for, in words.","type":"string"},"crossCurrency":{"$ref":"#/components/schemas/IsoCurrency","description":"The currency every rate is quoted through. A rate between two currencies neither of which is this one is computed as a cross rate."},"timeZone":{"description":"The time zone the set's business day is reckoned in, `Australia/Sydney`.","type":"string"},"rates":{"$ref":"#/components/schemas/FxrsSnapshot"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"IdspCmd":{"oneOf":[{"$ref":"#/components/schemas/IdspCmdCreate"}],"discriminator":{"propertyName":"type","mapping":{"IdspCmdCreate":"#/components/schemas/IdspCmdCreate"}}},"IdspCmdCreate":{"title":"IdspCmdCreate","description":"Raise a dispute against an issuer transaction, naming it by selector. The amount in dispute is required.","examples":[{"type":"IdspCmdCreate","selector":{"type":"ItxnSelectorCardReference","cardReference":"your-own-reference","referenceTransactionId":"your-own-reference","merchantId":"mcht_9f2Kd8QpLzXw"},"amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"reason":"Requested by the customer.","referenceDisputeId":"your-own-reference","metadata":{"yourKey":{}}}],"type":"object","required":["type","selector","amount"],"properties":{"type":{"description":"Always `IdspCmdCreate`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["IdspCmdCreate"]},"selector":{"$ref":"#/components/schemas/ItxnSelector"},"amount":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"An amount in minor current units of a given currency."},"reason":{"type":"string"},"referenceDisputeId":{"description":"Your own identifier for this dispute.","type":"string"},"metadata":{"$ref":"#/components/schemas/Metadata","description":"Free-form data the platform stores and returns untouched. Values may be nested objects and arrays."}}},"IdspOutcome":{"oneOf":[{"$ref":"#/components/schemas/IdspOutcomeCreated"}],"discriminator":{"propertyName":"type","mapping":{"IdspOutcomeCreated":"#/components/schemas/IdspOutcomeCreated"}}},"IdspOutcomeCreated":{"title":"IdspOutcomeCreated","description":"The dispute was raised. This is the dispute as it now stands.","examples":[{"type":"IdspOutcomeCreated","dispute":{"type":"ItxnDisputeAttributes","disputeId":"dispute_9f2Kd8QpLzXw","referenceDisputeId":"your-own-reference","outcome":"Pending","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"reason":"Requested by the customer.","metadata":{"yourKey":{}},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","dispute"],"properties":{"type":{"description":"Always `IdspOutcomeCreated`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["IdspOutcomeCreated"]},"dispute":{"$ref":"#/components/schemas/ItxnDispute"}}},"IrfndCmd":{"oneOf":[{"$ref":"#/components/schemas/IrfndCmdCreate"}],"discriminator":{"propertyName":"type","mapping":{"IrfndCmdCreate":"#/components/schemas/IrfndCmdCreate"}}},"IrfndCmdCreate":{"title":"IrfndCmdCreate","description":"Refund a captured issuer transaction, naming it by selector. The amount is required, a refund is always for a stated sum.","examples":[{"type":"IrfndCmdCreate","selector":{"type":"ItxnSelectorCardReference","cardReference":"your-own-reference","referenceTransactionId":"your-own-reference","merchantId":"mcht_9f2Kd8QpLzXw"},"amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"referenceRefundId":"your-own-reference","metadata":{"yourKey":{}}}],"type":"object","required":["type","selector","amount"],"properties":{"type":{"description":"Always `IrfndCmdCreate`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["IrfndCmdCreate"]},"selector":{"$ref":"#/components/schemas/ItxnSelector"},"amount":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"An amount in minor current units of a given currency."},"referenceRefundId":{"description":"Your own identifier for this refund, so a retry is not a second refund.","type":"string"},"metadata":{"$ref":"#/components/schemas/Metadata","description":"Free-form data the platform stores and returns untouched. Values may be nested objects and arrays."}}},"IrfndOutcome":{"oneOf":[{"$ref":"#/components/schemas/IrfndOutcomeCreated"},{"$ref":"#/components/schemas/IrfndOutcomeDiscrepancy"}],"discriminator":{"propertyName":"type","mapping":{"IrfndOutcomeCreated":"#/components/schemas/IrfndOutcomeCreated","IrfndOutcomeDiscrepancy":"#/components/schemas/IrfndOutcomeDiscrepancy"}}},"IrfndOutcomeCreated":{"title":"IrfndOutcomeCreated","description":"The refund was made. This is the refund as it now stands.","examples":[{"type":"IrfndOutcomeCreated","refund":{"type":"ItxnRefundAttributes","refundId":"rfnd_9f2Kd8QpLzXw","referenceRefundId":"your-own-reference","status":"Authorised","amounts":{"type":"ItxnRefundAmountsAttributes","currency":"AUD","amount":1250,"tax":1250,"taxType":"example"},"taxRate":0.9412,"originalAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"metadata":{"yourKey":{}},"publishedMetadata":{"yourKey":{}},"customerStatementIssueDate":"2026-08-19","processingDate":"2026-08-19","publishedAt":"2026-08-19T04:21:07Z","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","refund"],"properties":{"type":{"description":"Always `IrfndOutcomeCreated`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["IrfndOutcomeCreated"]},"refund":{"$ref":"#/components/schemas/ItxnRefund","description":"A refund issued against a card authorisation."}}},"IrfndOutcomeDiscrepancy":{"title":"IrfndOutcomeDiscrepancy","description":"The network disagreed and the platform recorded it instead. Nothing was refunded; read the exception.","examples":[{"type":"IrfndOutcomeDiscrepancy","exception":{"type":"ExceptViewMastercardRefundError","exceptionId":"except_9f2Kd8QpLzXw","status":"Outstanding","card":{"type":"ItxnCardAttributes","cardId":"dcard_9f2Kd8QpLzXw","cardReference":"your-own-reference","last4":"4242","bin":"424242","brand":"Visa","expiryMonth":6,"expiryYear":2029,"country":"AU","cardHolderName":"Ada Lovelace"},"customerId":"cust_9f2Kd8QpLzXw","referenceTransactionId":"your-own-reference","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"transactionId":"tran_9f2Kd8QpLzXw","schemeError":"example","reconciledTransactionIds":["tran_9f2Kd8QpLzXw"],"generatedRefundId":"rfnd_9f2Kd8QpLzXw","suggestion":{"type":"ExceptSuggestionAcceptCapture"},"notes":[{"type":"ExceptNoteAttributes","kind":"Comment","text":"example","author":"example","createdAt":"2026-08-19T04:21:07Z"}],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","exception"],"properties":{"type":{"description":"Always `IrfndOutcomeDiscrepancy`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["IrfndOutcomeDiscrepancy"]},"exception":{"$ref":"#/components/schemas/ExceptView"}}},"IrfndUpdate":{"oneOf":[{"$ref":"#/components/schemas/IrfndUpdateAppendMetadata"}],"discriminator":{"propertyName":"type","mapping":{"IrfndUpdateAppendMetadata":"#/components/schemas/IrfndUpdateAppendMetadata"}}},"IrfndUpdateAppendMetadata":{"title":"IrfndUpdateAppendMetadata","description":"Append free-form data to this refund. Merged with what is already there, send only what changes.","examples":[{"type":"IrfndUpdateAppendMetadata","merchantId":"mcht_9f2Kd8QpLzXw","metadata":{"yourKey":{}}}],"type":"object","required":["type","metadata"],"properties":{"type":{"description":"Always `IrfndUpdateAppendMetadata`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["IrfndUpdateAppendMetadata"]},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"Whose metadata this is. Must match the identifier used on the transaction's own metadata, or the two sets will not read back together."},"metadata":{"$ref":"#/components/schemas/Metadata","description":"Free-form data the platform stores and returns untouched. Values may be nested objects and arrays."}}},"IrfndUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/IrfndUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"IrfndUpdateRspAttributes":"#/components/schemas/IrfndUpdateRspAttributes"}}},"IrfndUpdateRspAttributes":{"title":"IrfndUpdateRspAttributes","examples":[{"type":"IrfndUpdateRspAttributes","updated":{"type":"ItxnRefundAttributes","refundId":"rfnd_9f2Kd8QpLzXw","referenceRefundId":"your-own-reference","status":"Authorised","amounts":{"type":"ItxnRefundAmountsAttributes","currency":"AUD","amount":1250,"tax":1250,"taxType":"example"},"taxRate":0.9412,"originalAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"metadata":{"yourKey":{}},"publishedMetadata":{"yourKey":{}},"customerStatementIssueDate":"2026-08-19","processingDate":"2026-08-19","publishedAt":"2026-08-19T04:21:07Z","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `IrfndUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["IrfndUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/ItxnRefund","description":"The resource as it stands after the change."}}},"IsoCountry":{"title":"IsoCountry","type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","VG","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","KP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","KR","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","CD","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","VI","UZ","VU","VA","VE","VN","WF","EH","YE","ZM","ZW"]},"IsoCurrency":{"title":"IsoCurrency","type":"string","enum":["AFN","DZD","ARS","AMD","AWG","AUD","AZN","BSD","BHD","THB","PAB","BBD","BYR","BZD","BMD","VEF","BOB","BRL","BND","BGN","BIF","CAD","CVE","KYD","XOF","XAF","XPF","CLP","COP","KMF","CDF","BAM","NIO","CRC","HRK","CUP","CZK","GMD","DKK","MKD","DJF","STD","DOP","VND","XCD","EGP","SVC","ETB","EUR","FKP","FJD","HUF","GHS","GIP","HTG","PYG","GNF","GYD","HKD","UAH","ISK","INR","IRR","IQD","JMD","JOD","KES","PGK","LAK","KWD","MWK","AOA","MMK","GEL","LBP","ALL","HNL","SLL","LRD","LYD","SZL","LSL","MGA","MYR","MUR","MXN","MXV","MDL","MAD","MZN","BOV","NGN","ERN","NAD","NPR","ANG","ILS","TWD","NZD","BTN","KPW","NOK","PEN","MRU","PKR","MOP","TOP","CUC","UYU","PHP","GBP","BWP","QAR","GTQ","ZAR","OMR","KHR","RON","MVR","IDR","RUB","RWF","SHP","SAR","RSD","SCR","SGD","SBD","KGS","SOS","TJS","SSP","LKR","SDG","SRD","SEK","CHF","SYP","BDT","WST","TZS","KZT","TTD","MNT","TND","TRY","TMT","AED","UGX","COU","CLF","UYI","USD","USN","USS","UZS","VUV","CHE","CHW","KRW","YER","JPY","CNY","ZMW","ZWL","PLN"]},"IsoCurrencyAmount":{"title":"IsoCurrencyAmount","examples":[{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"}],"type":"object","required":["type","minorCurrencyUnits","currency"],"properties":{"type":{"description":"Always `IsoCurrencyAmount`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["IsoCurrencyAmount"]},"minorCurrencyUnits":{"description":"The amount in minor currency units (e.g. cents for AUD).","type":"integer","format":"int64"},"currency":{"$ref":"#/components/schemas/IsoCurrency","description":"The currency of the given amount as a 3 letter ISO code."}}},"ItxnAcquiringMerchant":{"oneOf":[{"$ref":"#/components/schemas/ItxnAcquiringMerchantAttributes"}],"discriminator":{"propertyName":"type","mapping":{"ItxnAcquiringMerchantAttributes":"#/components/schemas/ItxnAcquiringMerchantAttributes"}}},"ItxnAcquiringMerchantAttributes":{"title":"ItxnAcquiringMerchantAttributes","description":"The merchant a card was presented to, as the scheme reported it.","examples":[{"type":"ItxnAcquiringMerchantAttributes","name":"Ada Lovelace","merchantCategoryCode":"example","iataNumber":"example","taxId":"abc123","country":"AU","city":"example","postCode":"3000","emailAddress":"ada@example.com","phoneNumber":"+61400000000"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `ItxnAcquiringMerchantAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ItxnAcquiringMerchantAttributes"]},"name":{"type":"string"},"merchantCategoryCode":{"description":"The scheme's four-digit merchant category code.","type":"string"},"iataNumber":{"description":"The supplier's IATA number, on a travel transaction.","type":"string"},"taxId":{"type":"string"},"country":{"$ref":"#/components/schemas/IsoCountry"},"city":{"type":"string"},"postCode":{"type":"string"},"emailAddress":{"type":"string"},"phoneNumber":{"type":"string"}}},"ItxnAdjustmentKind":{"title":"ItxnAdjustmentKind","type":"string","enum":["Charge","Refund","Dispute","DisputeFee","TransactionFee","BankFee","ManualAdjustment","Unknown"]},"ItxnAdjustmentLine":{"description":"The ledger line a manual adjustment writes.","oneOf":[{"$ref":"#/components/schemas/ItxnAdjustmentLineAttributes"}],"discriminator":{"propertyName":"type","mapping":{"ItxnAdjustmentLineAttributes":"#/components/schemas/ItxnAdjustmentLineAttributes"}}},"ItxnAdjustmentLineAttributes":{"title":"ItxnAdjustmentLineAttributes","description":"The ledger line a manual adjustment writes.","examples":[{"type":"ItxnAdjustmentLineAttributes","kind":"Charge","description":"A short description.","currency":"AUD","net":1250,"tax":1250,"total":1250}],"type":"object","required":["type","kind","description","currency","net","tax","total"],"properties":{"type":{"description":"Always `ItxnAdjustmentLineAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ItxnAdjustmentLineAttributes"]},"kind":{"$ref":"#/components/schemas/ItxnAdjustmentKind"},"description":{"type":"string"},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"net":{"$ref":"#/components/schemas/MinorUnits","description":"An amount in the minor units of the currency given by the enclosing object's `currency` field."},"tax":{"$ref":"#/components/schemas/MinorUnits","description":"An amount in the minor units of the currency given by the enclosing object's `currency` field."},"total":{"$ref":"#/components/schemas/MinorUnits","description":"An amount in the minor units of the currency given by the enclosing object's `currency` field."}}},"ItxnAmounts":{"description":"The amounts on an issuer transaction. All are in the single currency given here.","oneOf":[{"$ref":"#/components/schemas/ItxnAmountsAttributes"}],"discriminator":{"propertyName":"type","mapping":{"ItxnAmountsAttributes":"#/components/schemas/ItxnAmountsAttributes"}}},"ItxnAmountsAttributes":{"title":"ItxnAmountsAttributes","description":"The amounts on an issuer transaction. All are in the single currency given here.","examples":[{"type":"ItxnAmountsAttributes","currency":"AUD","authorised":1250,"captured":1250,"refunded":1250}],"type":"object","required":["type","currency","authorised","captured","refunded"],"properties":{"type":{"description":"Always `ItxnAmountsAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ItxnAmountsAttributes"]},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"authorised":{"$ref":"#/components/schemas/MinorUnits","description":"Total authorised against the card."},"captured":{"$ref":"#/components/schemas/MinorUnits","description":"Total captured, which may be less than the amount authorised."},"refunded":{"$ref":"#/components/schemas/MinorUnits","description":"Total refunded to date."}}},"ItxnCard":{"description":"The card an issuer transaction was made against.","oneOf":[{"$ref":"#/components/schemas/ItxnCardAttributes"}],"discriminator":{"propertyName":"type","mapping":{"ItxnCardAttributes":"#/components/schemas/ItxnCardAttributes"}}},"ItxnCardAttributes":{"title":"ItxnCardAttributes","description":"The card an issuer transaction was made against.","examples":[{"type":"ItxnCardAttributes","cardId":"dcard_9f2Kd8QpLzXw","cardReference":"your-own-reference","last4":"4242","bin":"424242","brand":"Visa","expiryMonth":6,"expiryYear":2029,"country":"AU","cardHolderName":"Ada Lovelace"}],"type":"object","required":["type","last4","bin","brand","expiryMonth","expiryYear","country"],"properties":{"type":{"description":"Always `ItxnCardAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ItxnCardAttributes"]},"cardId":{"$ref":"#/components/schemas/CardId","description":"The card this authorisation was made on, where the platform issued it."},"cardReference":{"description":"The value `ItxnSelectorCardReference` accepts as its `cardReference`, where the card carries one.","type":"string"},"last4":{"description":"Last four digits of the card number.","type":"string"},"bin":{"description":"First six to eight digits, identifying the issuer.","type":"string"},"brand":{"$ref":"#/components/schemas/CardBrand"},"expiryMonth":{"type":"integer","format":"int32"},"expiryYear":{"type":"integer","format":"int32"},"country":{"$ref":"#/components/schemas/IsoCountry","description":"The country the card was issued in."},"cardHolderName":{"type":"string"}}},"ItxnColumn":{"title":"ItxnColumn","type":"string","enum":["IssuerTransactionId","Status","Network","CardCardId","CardCardReference","CardLast4","CardBin","CardBrand","CardExpiryMonth","CardExpiryYear","CardCountry","CardCardHolderName","AmountsCurrency","AmountsAuthorised","AmountsCaptured","AmountsRefunded","RefundedBeforeConversionMinorCurrencyUnits","RefundedBeforeConversionCurrency","AcquiringMerchantName","AcquiringMerchantMerchantCategoryCode","AcquiringMerchantIataNumber","AcquiringMerchantTaxId","AcquiringMerchantCountry","AcquiringMerchantCity","AcquiringMerchantPostCode","AcquiringMerchantEmailAddress","AcquiringMerchantPhoneNumber","Description","LoanId","LoanTransactionId","SettlementMerchantId","ReferenceTransactionId","AuditNumber","ApprovalCode","AuthorisedAt","CapturedAt","TransactedAt","CreatedAt","UpdatedAt"]},"ItxnDispute":{"description":"A dispute raised against a card authorisation.","oneOf":[{"$ref":"#/components/schemas/ItxnDisputeAttributes"}],"discriminator":{"propertyName":"type","mapping":{"ItxnDisputeAttributes":"#/components/schemas/ItxnDisputeAttributes"}}},"ItxnDisputeAttributes":{"title":"ItxnDisputeAttributes","description":"A dispute raised against a card authorisation.","examples":[{"type":"ItxnDisputeAttributes","disputeId":"dispute_9f2Kd8QpLzXw","referenceDisputeId":"your-own-reference","outcome":"Pending","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"reason":"Requested by the customer.","metadata":{"yourKey":{}},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","disputeId","outcome","amount","createdAt","updatedAt"],"properties":{"type":{"description":"Always `ItxnDisputeAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ItxnDisputeAttributes"]},"disputeId":{"$ref":"#/components/schemas/DisputeId"},"referenceDisputeId":{"description":"Your own reference for the dispute.","type":"string"},"outcome":{"$ref":"#/components/schemas/ItxnDisputeOutcome"},"amount":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"The amount in dispute."},"reason":{"type":"string"},"metadata":{"$ref":"#/components/schemas/Metadata","description":"Free-form data on the dispute."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"ItxnDisputeOutcome":{"title":"ItxnDisputeOutcome","type":"string","enum":["Pending","CustomerWon","CustomerLost","Unknown"]},"ItxnDisputePage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/ItxnDisputePageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"ItxnDisputePageAttributes":"#/components/schemas/ItxnDisputePageAttributes"}}},"ItxnDisputePageAttributes":{"title":"ItxnDisputePageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"ItxnDisputePageAttributes","data":[{"type":"ItxnDisputeAttributes","disputeId":"dispute_9f2Kd8QpLzXw","referenceDisputeId":"your-own-reference","outcome":"Pending","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"reason":"Requested by the customer.","metadata":{"yourKey":{}},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `ItxnDisputePageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ItxnDisputePageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/ItxnDispute"}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"ItxnEventType":{"title":"ItxnEventType","description":"Which event on the timeline this adjusts. An adjustment is always against a specific event.","type":"string","enum":["Authorised","Succeeded","Cancelled","Failed","Refunded","Disputed","DisputeWon","DisputeLost","ManualAdjustment","Unknown"]},"ItxnId":{"title":"ItxnId","type":"string"},"ItxnNetwork":{"title":"ItxnNetwork","type":"string","enum":["Uatp","Eml","Unknown"]},"ItxnPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/ItxnPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"ItxnPageAttributes":"#/components/schemas/ItxnPageAttributes"}}},"ItxnPageAttributes":{"title":"ItxnPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"ItxnPageAttributes","data":[{"type":"ItxnViewAttributes","issuerTransactionId":"itxn_9f2Kd8QpLzXw","status":"Authorised","network":"Uatp","card":{"type":"ItxnCardAttributes","cardId":"dcard_9f2Kd8QpLzXw","cardReference":"your-own-reference","last4":"4242","bin":"424242","brand":"Visa","expiryMonth":6,"expiryYear":2029,"country":"AU","cardHolderName":"Ada Lovelace"},"amounts":{"type":"ItxnAmountsAttributes","currency":"AUD","authorised":1250,"captured":1250,"refunded":1250},"refundedBeforeConversion":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"refunds":[{"type":"ItxnRefundAttributes","refundId":"rfnd_9f2Kd8QpLzXw","referenceRefundId":"your-own-reference","status":"Authorised","amounts":{"type":"ItxnRefundAmountsAttributes","currency":"AUD","amount":1250,"tax":1250,"taxType":"example"},"taxRate":0.9412,"originalAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"metadata":{"yourKey":{}},"publishedMetadata":{"yourKey":{}},"customerStatementIssueDate":"2026-08-19","processingDate":"2026-08-19","publishedAt":"2026-08-19T04:21:07Z","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"disputes":[{"type":"ItxnDisputeAttributes","disputeId":"dispute_9f2Kd8QpLzXw","referenceDisputeId":"your-own-reference","outcome":"Pending","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"reason":"Requested by the customer.","metadata":{"yourKey":{}},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"acquiringMerchant":{"type":"ItxnAcquiringMerchantAttributes","name":"Ada Lovelace","merchantCategoryCode":"example","iataNumber":"example","taxId":"abc123","country":"AU","city":"example","postCode":"3000","emailAddress":"ada@example.com","phoneNumber":"+61400000000"},"description":"A short description.","loanId":"loan_9f2Kd8QpLzXw","loanTransactionId":"ltxn_9f2Kd8QpLzXw","settlementMerchantId":"mcht_9f2Kd8QpLzXw","referenceTransactionId":"your-own-reference","auditNumber":"example","approvalCode":"example","metadata":{"yourKey":{}},"authorisedAt":"2026-08-19T04:21:07Z","capturedAt":"2026-08-19T04:21:07Z","transactedAt":"2026-08-19T04:21:07Z","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `ItxnPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ItxnPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/ItxnView","description":"An issuer transaction, a card authorisation and its subsequent capture, refunds and disputes."}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"ItxnRefund":{"oneOf":[{"$ref":"#/components/schemas/ItxnRefundAttributes"}],"discriminator":{"propertyName":"type","mapping":{"ItxnRefundAttributes":"#/components/schemas/ItxnRefundAttributes"}}},"ItxnRefundAmounts":{"description":"What came back, and the tax within it. In the single currency given here.","oneOf":[{"$ref":"#/components/schemas/ItxnRefundAmountsAttributes"}],"discriminator":{"propertyName":"type","mapping":{"ItxnRefundAmountsAttributes":"#/components/schemas/ItxnRefundAmountsAttributes"}}},"ItxnRefundAmountsAttributes":{"title":"ItxnRefundAmountsAttributes","description":"A refunded amount and the tax within it. Both are in the single currency given here.","examples":[{"type":"ItxnRefundAmountsAttributes","currency":"AUD","amount":1250,"tax":1250,"taxType":"example"}],"type":"object","required":["type","currency","amount"],"properties":{"type":{"description":"Always `ItxnRefundAmountsAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ItxnRefundAmountsAttributes"]},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"amount":{"$ref":"#/components/schemas/MinorUnits","description":"An amount in the minor units of the currency given by the enclosing object's `currency` field."},"tax":{"$ref":"#/components/schemas/MinorUnits","description":"An amount in the minor units of the currency given by the enclosing object's `currency` field."},"taxType":{"description":"What the tax is called, `GST`.","type":"string"}}},"ItxnRefundAttributes":{"title":"ItxnRefundAttributes","description":"A refund issued against a card authorisation.","examples":[{"type":"ItxnRefundAttributes","refundId":"rfnd_9f2Kd8QpLzXw","referenceRefundId":"your-own-reference","status":"Authorised","amounts":{"type":"ItxnRefundAmountsAttributes","currency":"AUD","amount":1250,"tax":1250,"taxType":"example"},"taxRate":0.9412,"originalAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"metadata":{"yourKey":{}},"publishedMetadata":{"yourKey":{}},"customerStatementIssueDate":"2026-08-19","processingDate":"2026-08-19","publishedAt":"2026-08-19T04:21:07Z","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","refundId","status","amounts","createdAt","updatedAt"],"properties":{"type":{"description":"Always `ItxnRefundAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ItxnRefundAttributes"]},"refundId":{"$ref":"#/components/schemas/RfndId","description":"Identifier of a refund."},"referenceRefundId":{"description":"Your own reference for the refund.","type":"string"},"status":{"$ref":"#/components/schemas/ItxnRefundStatus"},"amounts":{"$ref":"#/components/schemas/ItxnRefundAmounts"},"taxRate":{"description":"The rate the tax was charged at, as a decimal, `0.1` is 10%.","type":"number"},"originalAmount":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"The amount before currency conversion, where the refund was converted. Genuinely in another currency, so it carries its own."},"metadata":{"$ref":"#/components/schemas/Metadata","description":"Free-form data on the refund."},"publishedMetadata":{"$ref":"#/components/schemas/Metadata","description":"The metadata as it was published to the borrower, where it has been changed since. The difference is what a dispute turns on."},"customerStatementIssueDate":{"description":"The issue date of the customer statement this refund is expected to appear on.","type":"string","format":"date"},"processingDate":{"description":"When the scheme will process the refund.","type":"string","format":"date"},"publishedAt":{"description":"When the refund reached the borrower's statement.","type":"string","format":"date-time"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"ItxnRefundPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/ItxnRefundPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"ItxnRefundPageAttributes":"#/components/schemas/ItxnRefundPageAttributes"}}},"ItxnRefundPageAttributes":{"title":"ItxnRefundPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"ItxnRefundPageAttributes","data":[{"type":"ItxnRefundAttributes","refundId":"rfnd_9f2Kd8QpLzXw","referenceRefundId":"your-own-reference","status":"Authorised","amounts":{"type":"ItxnRefundAmountsAttributes","currency":"AUD","amount":1250,"tax":1250,"taxType":"example"},"taxRate":0.9412,"originalAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"metadata":{"yourKey":{}},"publishedMetadata":{"yourKey":{}},"customerStatementIssueDate":"2026-08-19","processingDate":"2026-08-19","publishedAt":"2026-08-19T04:21:07Z","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `ItxnRefundPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ItxnRefundPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/ItxnRefund","description":"A refund issued against a card authorisation."}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"ItxnRefundStatus":{"title":"ItxnRefundStatus","type":"string","enum":["Authorised","Published","Unknown"]},"ItxnSelector":{"oneOf":[{"$ref":"#/components/schemas/ItxnSelectorCardReference"},{"$ref":"#/components/schemas/ItxnSelectorPan"}],"discriminator":{"propertyName":"type","mapping":{"ItxnSelectorCardReference":"#/components/schemas/ItxnSelectorCardReference","ItxnSelectorPan":"#/components/schemas/ItxnSelectorPan"}}},"ItxnSelectorCardReference":{"title":"ItxnSelectorCardReference","description":"Name it by the card and your own reference for the purchase.","examples":[{"type":"ItxnSelectorCardReference","cardReference":"your-own-reference","referenceTransactionId":"your-own-reference","merchantId":"mcht_9f2Kd8QpLzXw"}],"type":"object","required":["type","cardReference","referenceTransactionId","merchantId"],"properties":{"type":{"description":"Always `ItxnSelectorCardReference`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ItxnSelectorCardReference"]},"cardReference":{"description":"The card the authorisation was made on.","type":"string"},"referenceTransactionId":{"description":"Your own reference for the transaction, as sent when it was made.","type":"string"},"merchantId":{"type":"string"}}},"ItxnSelectorPan":{"title":"ItxnSelectorPan","description":"Name it by the card number and your own reference for the purchase.","examples":[{"type":"ItxnSelectorPan","pan":"example","referenceTransactionId":"your-own-reference","merchantId":"mcht_9f2Kd8QpLzXw"}],"type":"object","required":["type","pan","referenceTransactionId","merchantId"],"properties":{"type":{"description":"Always `ItxnSelectorPan`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ItxnSelectorPan"]},"pan":{"description":"The card PAN, digits only.","type":"string"},"referenceTransactionId":{"description":"Your own reference for the transaction, as sent when it was made.","type":"string"},"merchantId":{"type":"string"}}},"ItxnSelectorUpdate":{"oneOf":[{"$ref":"#/components/schemas/ItxnSelectorUpdateAdjust"},{"$ref":"#/components/schemas/ItxnSelectorUpdateAppendMetadata"},{"$ref":"#/components/schemas/ItxnSelectorUpdateCapture"},{"$ref":"#/components/schemas/ItxnSelectorUpdateCaptureUatp"},{"$ref":"#/components/schemas/ItxnSelectorUpdateVoid"}],"discriminator":{"propertyName":"type","mapping":{"ItxnSelectorUpdateAdjust":"#/components/schemas/ItxnSelectorUpdateAdjust","ItxnSelectorUpdateAppendMetadata":"#/components/schemas/ItxnSelectorUpdateAppendMetadata","ItxnSelectorUpdateCapture":"#/components/schemas/ItxnSelectorUpdateCapture","ItxnSelectorUpdateCaptureUatp":"#/components/schemas/ItxnSelectorUpdateCaptureUatp","ItxnSelectorUpdateVoid":"#/components/schemas/ItxnSelectorUpdateVoid"}}},"ItxnSelectorUpdateAdjust":{"title":"ItxnSelectorUpdateAdjust","description":"Record a manual adjustment against a point on this transaction's timeline.","examples":[{"type":"ItxnSelectorUpdateAdjust","selector":{"type":"ItxnSelectorCardReference","cardReference":"your-own-reference","referenceTransactionId":"your-own-reference","merchantId":"mcht_9f2Kd8QpLzXw"},"loanId":"loan_9f2Kd8QpLzXw","targetEvent":"Authorised","targetEventId":"abc123","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"description":"A short description.","line":{"type":"ItxnAdjustmentLineAttributes","kind":"Charge","description":"A short description.","currency":"AUD","net":1250,"tax":1250,"total":1250}}],"type":"object","required":["type","selector","loanId","targetEvent","targetEventId","amount","description","line"],"properties":{"type":{"description":"Always `ItxnSelectorUpdateAdjust`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ItxnSelectorUpdateAdjust"]},"selector":{"$ref":"#/components/schemas/ItxnSelector"},"loanId":{"$ref":"#/components/schemas/LoanId","description":"The loan the adjustment is written against."},"targetEvent":{"$ref":"#/components/schemas/ItxnEventType"},"targetEventId":{"description":"Which occurrence of that event, as the platform identifies it.","type":"string"},"amount":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"An amount in minor current units of a given currency."},"description":{"type":"string"},"line":{"$ref":"#/components/schemas/ItxnAdjustmentLine"}}},"ItxnSelectorUpdateAppendMetadata":{"title":"ItxnSelectorUpdateAppendMetadata","description":"Append free-form data to the transaction. Merged with what is already there.","examples":[{"type":"ItxnSelectorUpdateAppendMetadata","selector":{"type":"ItxnSelectorCardReference","cardReference":"your-own-reference","referenceTransactionId":"your-own-reference","merchantId":"mcht_9f2Kd8QpLzXw"},"metadata":{"yourKey":{}}}],"type":"object","required":["type","selector","metadata"],"properties":{"type":{"description":"Always `ItxnSelectorUpdateAppendMetadata`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ItxnSelectorUpdateAppendMetadata"]},"selector":{"$ref":"#/components/schemas/ItxnSelector"},"metadata":{"$ref":"#/components/schemas/Metadata","description":"Free-form data the platform stores and returns untouched. Values may be nested objects and arrays."}}},"ItxnSelectorUpdateCapture":{"title":"ItxnSelectorUpdateCapture","description":"Capture an authorisation. Omit `amount` to capture it in full; name a smaller one to capture less.","examples":[{"type":"ItxnSelectorUpdateCapture","selector":{"type":"ItxnSelectorCardReference","cardReference":"your-own-reference","referenceTransactionId":"your-own-reference","merchantId":"mcht_9f2Kd8QpLzXw"},"amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"orderMetadata":{"yourKey":{}}}],"type":"object","required":["type","selector"],"properties":{"type":{"description":"Always `ItxnSelectorUpdateCapture`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ItxnSelectorUpdateCapture"]},"selector":{"$ref":"#/components/schemas/ItxnSelector"},"amount":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"An amount in minor current units of a given currency."},"orderMetadata":{"$ref":"#/components/schemas/Metadata","description":"Free-form data recorded against the order this capture belongs to."}}},"ItxnSelectorUpdateCaptureUatp":{"title":"ItxnSelectorUpdateCaptureUatp","description":"Capture a UATP authorisation. The approval code and itinerary are what make this its own operation.","examples":[{"type":"ItxnSelectorUpdateCaptureUatp","selector":{"type":"ItxnSelectorCardReference","cardReference":"your-own-reference","referenceTransactionId":"your-own-reference","merchantId":"mcht_9f2Kd8QpLzXw"},"approvalCode":"example","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"itinerary":{"type":"ItxnUatpCaptureDetailAttributes","invoiceNumber":"example","iataNumber":"example","serviceLines":["example"],"vatRate":"0.9412"},"orderMetadata":{"yourKey":{}}}],"type":"object","required":["type","selector","approvalCode","amount","itinerary"],"properties":{"type":{"description":"Always `ItxnSelectorUpdateCaptureUatp`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ItxnSelectorUpdateCaptureUatp"]},"selector":{"$ref":"#/components/schemas/ItxnSelector"},"approvalCode":{"description":"The scheme's approval code for the authorisation being captured. Required, a UATP capture cannot be matched without it.","type":"string"},"amount":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"An amount in minor current units of a given currency."},"itinerary":{"$ref":"#/components/schemas/ItxnUatpCaptureDetail"},"orderMetadata":{"$ref":"#/components/schemas/Metadata","description":"Free-form data the platform stores and returns untouched. Values may be nested objects and arrays."}}},"ItxnSelectorUpdateVoid":{"title":"ItxnSelectorUpdateVoid","description":"Void an authorisation, releasing the hold. There is no amount, a void releases whatever was held.","examples":[{"type":"ItxnSelectorUpdateVoid","selector":{"type":"ItxnSelectorCardReference","cardReference":"your-own-reference","referenceTransactionId":"your-own-reference","merchantId":"mcht_9f2Kd8QpLzXw"}}],"type":"object","required":["type","selector"],"properties":{"type":{"description":"Always `ItxnSelectorUpdateVoid`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ItxnSelectorUpdateVoid"]},"selector":{"$ref":"#/components/schemas/ItxnSelector"}}},"ItxnSort":{"title":"ItxnSort","type":"string","enum":["createdAt","-createdAt","updatedAt","-updatedAt"]},"ItxnStatus":{"title":"ItxnStatus","type":"string","enum":["Authorised","Captured","Refunded","PartiallyRefunded","Cancelled","Disputed","Failed","Unknown"]},"ItxnUatpCaptureDetail":{"description":"The itinerary data the scheme requires alongside the amount.","oneOf":[{"$ref":"#/components/schemas/ItxnUatpCaptureDetailAttributes"}],"discriminator":{"propertyName":"type","mapping":{"ItxnUatpCaptureDetailAttributes":"#/components/schemas/ItxnUatpCaptureDetailAttributes"}}},"ItxnUatpCaptureDetailAttributes":{"title":"ItxnUatpCaptureDetailAttributes","description":"Itinerary data required when capturing a UATP transaction.","examples":[{"type":"ItxnUatpCaptureDetailAttributes","invoiceNumber":"example","iataNumber":"example","serviceLines":["example"],"vatRate":"0.9412"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `ItxnUatpCaptureDetailAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ItxnUatpCaptureDetailAttributes"]},"invoiceNumber":{"description":"The travel agency's invoice number for the booking.","type":"string"},"iataNumber":{"description":"The supplier's IATA number.","type":"string"},"serviceLines":{"description":"Service lines describing what was bought, as the scheme defines them.","type":"array","items":{"type":"string"}},"vatRate":{"description":"The tax rate applied, as a decimal string.","type":"string"}}},"ItxnUpdate":{"oneOf":[{"$ref":"#/components/schemas/ItxnUpdateAppendMetadata"},{"$ref":"#/components/schemas/ItxnUpdateAppendRefundMetadata"},{"$ref":"#/components/schemas/ItxnUpdateRevalidate"}],"discriminator":{"propertyName":"type","mapping":{"ItxnUpdateAppendMetadata":"#/components/schemas/ItxnUpdateAppendMetadata","ItxnUpdateAppendRefundMetadata":"#/components/schemas/ItxnUpdateAppendRefundMetadata","ItxnUpdateRevalidate":"#/components/schemas/ItxnUpdateRevalidate"}}},"ItxnUpdateAppendMetadata":{"title":"ItxnUpdateAppendMetadata","description":"Append free-form data to the transaction. Merged with what is already there.","examples":[{"type":"ItxnUpdateAppendMetadata","metadata":{"yourKey":{}}}],"type":"object","required":["type","metadata"],"properties":{"type":{"description":"Always `ItxnUpdateAppendMetadata`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ItxnUpdateAppendMetadata"]},"metadata":{"$ref":"#/components/schemas/Metadata","description":"Free-form data the platform stores and returns untouched. Values may be nested objects and arrays."}}},"ItxnUpdateAppendRefundMetadata":{"title":"ItxnUpdateAppendRefundMetadata","description":"Append free-form data to one of this transaction's refunds. Both fields are required, the platform names one refund, and there is no all-of-them.","examples":[{"type":"ItxnUpdateAppendRefundMetadata","refundId":"rfnd_9f2Kd8QpLzXw","metadata":{"yourKey":{}}}],"type":"object","required":["type","refundId","metadata"],"properties":{"type":{"description":"Always `ItxnUpdateAppendRefundMetadata`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ItxnUpdateAppendRefundMetadata"]},"refundId":{"$ref":"#/components/schemas/RfndId","description":"Identifier of a refund."},"metadata":{"$ref":"#/components/schemas/Metadata","description":"Free-form data the platform stores and returns untouched. Values may be nested objects and arrays."}}},"ItxnUpdateOutcome":{"oneOf":[{"$ref":"#/components/schemas/ItxnUpdateOutcomeChanged"},{"$ref":"#/components/schemas/ItxnUpdateOutcomeDiscrepancy"}],"discriminator":{"propertyName":"type","mapping":{"ItxnUpdateOutcomeChanged":"#/components/schemas/ItxnUpdateOutcomeChanged","ItxnUpdateOutcomeDiscrepancy":"#/components/schemas/ItxnUpdateOutcomeDiscrepancy"}}},"ItxnUpdateOutcomeChanged":{"title":"ItxnUpdateOutcomeChanged","description":"The change was made. This is the transaction as it now stands.","examples":[{"type":"ItxnUpdateOutcomeChanged","transaction":{"type":"ItxnViewAttributes","issuerTransactionId":"itxn_9f2Kd8QpLzXw","status":"Authorised","network":"Uatp","card":{"type":"ItxnCardAttributes","cardId":"dcard_9f2Kd8QpLzXw","cardReference":"your-own-reference","last4":"4242","bin":"424242","brand":"Visa","expiryMonth":6,"expiryYear":2029,"country":"AU","cardHolderName":"Ada Lovelace"},"amounts":{"type":"ItxnAmountsAttributes","currency":"AUD","authorised":1250,"captured":1250,"refunded":1250},"refundedBeforeConversion":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"refunds":[{"type":"ItxnRefundAttributes","refundId":"rfnd_9f2Kd8QpLzXw","referenceRefundId":"your-own-reference","status":"Authorised","amounts":{"type":"ItxnRefundAmountsAttributes","currency":"AUD","amount":1250,"tax":1250,"taxType":"example"},"taxRate":0.9412,"originalAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"metadata":{"yourKey":{}},"publishedMetadata":{"yourKey":{}},"customerStatementIssueDate":"2026-08-19","processingDate":"2026-08-19","publishedAt":"2026-08-19T04:21:07Z","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"disputes":[{"type":"ItxnDisputeAttributes","disputeId":"dispute_9f2Kd8QpLzXw","referenceDisputeId":"your-own-reference","outcome":"Pending","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"reason":"Requested by the customer.","metadata":{"yourKey":{}},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"acquiringMerchant":{"type":"ItxnAcquiringMerchantAttributes","name":"Ada Lovelace","merchantCategoryCode":"example","iataNumber":"example","taxId":"abc123","country":"AU","city":"example","postCode":"3000","emailAddress":"ada@example.com","phoneNumber":"+61400000000"},"description":"A short description.","loanId":"loan_9f2Kd8QpLzXw","loanTransactionId":"ltxn_9f2Kd8QpLzXw","settlementMerchantId":"mcht_9f2Kd8QpLzXw","referenceTransactionId":"your-own-reference","auditNumber":"example","approvalCode":"example","metadata":{"yourKey":{}},"authorisedAt":"2026-08-19T04:21:07Z","capturedAt":"2026-08-19T04:21:07Z","transactedAt":"2026-08-19T04:21:07Z","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","transaction"],"properties":{"type":{"description":"Always `ItxnUpdateOutcomeChanged`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ItxnUpdateOutcomeChanged"]},"transaction":{"$ref":"#/components/schemas/ItxnView","description":"An issuer transaction, a card authorisation and its subsequent capture, refunds and disputes."}}},"ItxnUpdateOutcomeDiscrepancy":{"title":"ItxnUpdateOutcomeDiscrepancy","description":"The network disagreed and the platform recorded it instead. Nothing changed; read the exception.","examples":[{"type":"ItxnUpdateOutcomeDiscrepancy","exception":{"type":"ExceptViewMastercardRefundError","exceptionId":"except_9f2Kd8QpLzXw","status":"Outstanding","card":{"type":"ItxnCardAttributes","cardId":"dcard_9f2Kd8QpLzXw","cardReference":"your-own-reference","last4":"4242","bin":"424242","brand":"Visa","expiryMonth":6,"expiryYear":2029,"country":"AU","cardHolderName":"Ada Lovelace"},"customerId":"cust_9f2Kd8QpLzXw","referenceTransactionId":"your-own-reference","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"transactionId":"tran_9f2Kd8QpLzXw","schemeError":"example","reconciledTransactionIds":["tran_9f2Kd8QpLzXw"],"generatedRefundId":"rfnd_9f2Kd8QpLzXw","suggestion":{"type":"ExceptSuggestionAcceptCapture"},"notes":[{"type":"ExceptNoteAttributes","kind":"Comment","text":"example","author":"example","createdAt":"2026-08-19T04:21:07Z"}],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","exception"],"properties":{"type":{"description":"Always `ItxnUpdateOutcomeDiscrepancy`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ItxnUpdateOutcomeDiscrepancy"]},"exception":{"$ref":"#/components/schemas/ExceptView"}}},"ItxnUpdateRevalidate":{"title":"ItxnUpdateRevalidate","description":"Re-run the reconciliation check against the network. Edge's `RevalidateIssuerTransactionId`.","examples":[{"type":"ItxnUpdateRevalidate"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `ItxnUpdateRevalidate`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ItxnUpdateRevalidate"]}}},"ItxnUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/ItxnUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"ItxnUpdateRspAttributes":"#/components/schemas/ItxnUpdateRspAttributes"}}},"ItxnUpdateRspAttributes":{"title":"ItxnUpdateRspAttributes","examples":[{"type":"ItxnUpdateRspAttributes","updated":{"type":"ItxnViewAttributes","issuerTransactionId":"itxn_9f2Kd8QpLzXw","status":"Authorised","network":"Uatp","card":{"type":"ItxnCardAttributes","cardId":"dcard_9f2Kd8QpLzXw","cardReference":"your-own-reference","last4":"4242","bin":"424242","brand":"Visa","expiryMonth":6,"expiryYear":2029,"country":"AU","cardHolderName":"Ada Lovelace"},"amounts":{"type":"ItxnAmountsAttributes","currency":"AUD","authorised":1250,"captured":1250,"refunded":1250},"refundedBeforeConversion":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"refunds":[{"type":"ItxnRefundAttributes","refundId":"rfnd_9f2Kd8QpLzXw","referenceRefundId":"your-own-reference","status":"Authorised","amounts":{"type":"ItxnRefundAmountsAttributes","currency":"AUD","amount":1250,"tax":1250,"taxType":"example"},"taxRate":0.9412,"originalAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"metadata":{"yourKey":{}},"publishedMetadata":{"yourKey":{}},"customerStatementIssueDate":"2026-08-19","processingDate":"2026-08-19","publishedAt":"2026-08-19T04:21:07Z","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"disputes":[{"type":"ItxnDisputeAttributes","disputeId":"dispute_9f2Kd8QpLzXw","referenceDisputeId":"your-own-reference","outcome":"Pending","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"reason":"Requested by the customer.","metadata":{"yourKey":{}},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"acquiringMerchant":{"type":"ItxnAcquiringMerchantAttributes","name":"Ada Lovelace","merchantCategoryCode":"example","iataNumber":"example","taxId":"abc123","country":"AU","city":"example","postCode":"3000","emailAddress":"ada@example.com","phoneNumber":"+61400000000"},"description":"A short description.","loanId":"loan_9f2Kd8QpLzXw","loanTransactionId":"ltxn_9f2Kd8QpLzXw","settlementMerchantId":"mcht_9f2Kd8QpLzXw","referenceTransactionId":"your-own-reference","auditNumber":"example","approvalCode":"example","metadata":{"yourKey":{}},"authorisedAt":"2026-08-19T04:21:07Z","capturedAt":"2026-08-19T04:21:07Z","transactedAt":"2026-08-19T04:21:07Z","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `ItxnUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ItxnUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/ItxnView","description":"The resource as it stands after the change."}}},"ItxnView":{"oneOf":[{"$ref":"#/components/schemas/ItxnViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"ItxnViewAttributes":"#/components/schemas/ItxnViewAttributes"}}},"ItxnViewAttributes":{"title":"ItxnViewAttributes","description":"An issuer transaction, a card authorisation and its subsequent capture, refunds and disputes.","examples":[{"type":"ItxnViewAttributes","issuerTransactionId":"itxn_9f2Kd8QpLzXw","status":"Authorised","network":"Uatp","card":{"type":"ItxnCardAttributes","cardId":"dcard_9f2Kd8QpLzXw","cardReference":"your-own-reference","last4":"4242","bin":"424242","brand":"Visa","expiryMonth":6,"expiryYear":2029,"country":"AU","cardHolderName":"Ada Lovelace"},"amounts":{"type":"ItxnAmountsAttributes","currency":"AUD","authorised":1250,"captured":1250,"refunded":1250},"refundedBeforeConversion":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"refunds":[{"type":"ItxnRefundAttributes","refundId":"rfnd_9f2Kd8QpLzXw","referenceRefundId":"your-own-reference","status":"Authorised","amounts":{"type":"ItxnRefundAmountsAttributes","currency":"AUD","amount":1250,"tax":1250,"taxType":"example"},"taxRate":0.9412,"originalAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"metadata":{"yourKey":{}},"publishedMetadata":{"yourKey":{}},"customerStatementIssueDate":"2026-08-19","processingDate":"2026-08-19","publishedAt":"2026-08-19T04:21:07Z","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"disputes":[{"type":"ItxnDisputeAttributes","disputeId":"dispute_9f2Kd8QpLzXw","referenceDisputeId":"your-own-reference","outcome":"Pending","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"reason":"Requested by the customer.","metadata":{"yourKey":{}},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"acquiringMerchant":{"type":"ItxnAcquiringMerchantAttributes","name":"Ada Lovelace","merchantCategoryCode":"example","iataNumber":"example","taxId":"abc123","country":"AU","city":"example","postCode":"3000","emailAddress":"ada@example.com","phoneNumber":"+61400000000"},"description":"A short description.","loanId":"loan_9f2Kd8QpLzXw","loanTransactionId":"ltxn_9f2Kd8QpLzXw","settlementMerchantId":"mcht_9f2Kd8QpLzXw","referenceTransactionId":"your-own-reference","auditNumber":"example","approvalCode":"example","metadata":{"yourKey":{}},"authorisedAt":"2026-08-19T04:21:07Z","capturedAt":"2026-08-19T04:21:07Z","transactedAt":"2026-08-19T04:21:07Z","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","issuerTransactionId","status","network","card","amounts","acquiringMerchant","description","settlementMerchantId","auditNumber","authorisedAt","createdAt","updatedAt"],"properties":{"type":{"description":"Always `ItxnViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["ItxnViewAttributes"]},"issuerTransactionId":{"$ref":"#/components/schemas/ItxnId","description":"Identifier of an issuer transaction."},"status":{"$ref":"#/components/schemas/ItxnStatus"},"network":{"$ref":"#/components/schemas/ItxnNetwork","description":"Which scheme carried the authorisation."},"card":{"$ref":"#/components/schemas/ItxnCard"},"amounts":{"$ref":"#/components/schemas/ItxnAmounts"},"refundedBeforeConversion":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"An amount in minor current units of a given currency."},"refunds":{"description":"The refunds issued against this transaction, in full. This is the only address an issuing refund has.","type":"array","items":{"$ref":"#/components/schemas/ItxnRefund","description":"A refund issued against a card authorisation."}},"disputes":{"description":"The disputes raised against this transaction, in full.","type":"array","items":{"$ref":"#/components/schemas/ItxnDispute"}},"acquiringMerchant":{"$ref":"#/components/schemas/ItxnAcquiringMerchant","description":"The merchant the card was presented to, as the scheme reported it."},"description":{"type":"string"},"loanId":{"$ref":"#/components/schemas/LoanId","description":"The loan the card draws against, where the card is backed by one."},"loanTransactionId":{"$ref":"#/components/schemas/LtxnId","description":"The loan movement this authorisation created, once it has one."},"settlementMerchantId":{"$ref":"#/components/schemas/MchtId","description":"The merchant the captured funds settle to."},"referenceTransactionId":{"description":"Your own reference for this purchase. The natural key `PATCH /issuer-transactions` matches on.","type":"string"},"auditNumber":{"description":"The scheme's own trace number, UATP's system trace audit number, EML's logical transaction id.","type":"string"},"approvalCode":{"description":"The approval code, once the authorisation is approved.","type":"string"},"metadata":{"$ref":"#/components/schemas/Metadata","description":"Free-form data the platform stores against the transaction and returns untouched."},"authorisedAt":{"type":"string","format":"date-time"},"capturedAt":{"type":"string","format":"date-time"},"transactedAt":{"description":"When the card was actually presented, where the scheme reported it separately from the authorisation.","type":"string","format":"date-time"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"JnalAmounts":{"description":"The double entry, and the tax within it. All in the journal's currency, stated once.","oneOf":[{"$ref":"#/components/schemas/JnalAmountsAttributes"}],"discriminator":{"propertyName":"type","mapping":{"JnalAmountsAttributes":"#/components/schemas/JnalAmountsAttributes"}}},"JnalAmountsAttributes":{"title":"JnalAmountsAttributes","description":"A double entry and the tax within it, as decimal strings in major units. All in the single currency given here.","examples":[{"type":"JnalAmountsAttributes","currency":"AUD","debit":"example","credit":"example","tax":"example","taxRate":"0.9412","taxType":"example","taxCountry":"AU"}],"type":"object","required":["type","currency","debit","credit","tax"],"properties":{"type":{"description":"Always `JnalAmountsAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["JnalAmountsAttributes"]},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"debit":{"description":"Money out, in major units, `1.23` is $1.23. Zero when this is a credit entry.","type":"string"},"credit":{"description":"Money in, in major units. Zero when this is a debit entry.","type":"string"},"tax":{"description":"Tax within the entry, in major units.","type":"string"},"taxRate":{"description":"The rate the tax was charged at, as a decimal, `0.10` is 10%.","type":"string"},"taxType":{"description":"What the tax is called, `GST`.","type":"string"},"taxCountry":{"$ref":"#/components/schemas/IsoCountry","description":"The country the tax was charged in."}}},"JnalCategory":{"title":"JnalCategory","type":"string","enum":["General","Income","Fees","Disputes","Reserved","IncomeRealtime","FeesRealtime","DisputesRealtime","Net","Limits","Max","GeneralLedger","NetLedger","IncomeLedger","FeesLedger","DisputesLedger","ReservedLedger","Unknown"]},"JnalCmd":{"oneOf":[{"$ref":"#/components/schemas/JnalCmdTopUp"}],"discriminator":{"propertyName":"type","mapping":{"JnalCmdTopUp":"#/components/schemas/JnalCmdTopUp"}}},"JnalCmdTopUp":{"title":"JnalCmdTopUp","description":"Top up a merchant's book, correcting a balance.","examples":[{"type":"JnalCmdTopUp","merchantId":"mcht_9f2Kd8QpLzXw","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"category":"General","description":"A short description."}],"type":"object","required":["type","merchantId","amount","category","description"],"properties":{"type":{"description":"Always `JnalCmdTopUp`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["JnalCmdTopUp"]},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"The merchant whose book to post to."},"amount":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"How much to add. Must be in the journal's currency."},"category":{"$ref":"#/components/schemas/JnalCategory","description":"Which of the merchant's journals to post to. The merchant and the category identify it between them."},"description":{"description":"Why the correction is being made. Recorded against both entries.","type":"string"}}},"JnalColumn":{"title":"JnalColumn","type":"string","enum":["JournalEntryId","CounterEntryId","JournalOwnerType","JournalOwnerIdentifier","JournalCategory","JournalClearanceSystem","JournalCurrency","EntryType","AmountsCurrency","AmountsDebit","AmountsCredit","AmountsTax","AmountsTaxRate","AmountsTaxType","AmountsTaxCountry","EventSystemEventId","EventSystemEventType","MerchantId","MarketplaceId","EnterpriseId","OriginalAmountMinorCurrencyUnits","OriginalAmountCurrency","Description","ClearanceDate","SettlementDate","ReferenceId","CreatedAt"]},"JnalCreateRsp":{"description":"The result of a manual top-up: when the funds clear.","oneOf":[{"$ref":"#/components/schemas/JnalCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"JnalCreateRspAttributes":"#/components/schemas/JnalCreateRspAttributes"}}},"JnalCreateRspAttributes":{"title":"JnalCreateRspAttributes","description":"The result of a manual top-up: when the funds clear.","examples":[{"type":"JnalCreateRspAttributes","clearanceDate":"2026-08-19"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `JnalCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["JnalCreateRspAttributes"]},"clearanceDate":{"description":"The date the funds become available to move. Absent where the platform could not determine one.","type":"string","format":"date"}}},"JnalEvent":{"description":"What triggered this movement, and the event it belongs to.","oneOf":[{"$ref":"#/components/schemas/JnalEventAttributes"}],"discriminator":{"propertyName":"type","mapping":{"JnalEventAttributes":"#/components/schemas/JnalEventAttributes"}}},"JnalEventAttributes":{"title":"JnalEventAttributes","description":"What triggered a movement, and the event it belongs to.","examples":[{"type":"JnalEventAttributes","systemEventId":"abc123","systemEventType":"example"}],"type":"object","required":["type","systemEventId","systemEventType"],"properties":{"type":{"description":"Always `JnalEventAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["JnalEventAttributes"]},"systemEventId":{"description":"The event that caused this batch of entries. Every entry the same event produced shares it.","type":"string"},"systemEventType":{"description":"What kind of event it was.","type":"string"}}},"JnalId":{"title":"JnalId","examples":["sjen_9f2Kd8QpLzXw"],"type":"string"},"JnalPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/JnalPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"JnalPageAttributes":"#/components/schemas/JnalPageAttributes"}}},"JnalPageAttributes":{"title":"JnalPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"JnalPageAttributes","data":[{"type":"JnalViewAttributes","journalEntryId":"sjen_9f2Kd8QpLzXw","counterEntryId":"sjen_9f2Kd8QpLzXw","journal":{"type":"SjnlBusinessKeyAttributes","ownerType":"Merchant","ownerIdentifier":"example","category":"General","clearanceSystem":"example","currency":"AUD"},"entryType":"example","amounts":{"type":"JnalAmountsAttributes","currency":"AUD","debit":"example","credit":"example","tax":"example","taxRate":"0.9412","taxType":"example","taxCountry":"AU"},"event":{"type":"JnalEventAttributes","systemEventId":"abc123","systemEventType":"example"},"merchantId":"mcht_9f2Kd8QpLzXw","marketplaceId":"mktp_9f2Kd8QpLzXw","enterpriseId":"ent_9f2Kd8QpLzXw","originalAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"description":"A short description.","clearanceDate":"2026-08-19","settlementDate":"2026-08-19","referenceId":"your-own-reference","metadata":{"yourKey":"example"},"createdAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `JnalPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["JnalPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/JnalView","description":"One movement in a book, half of a double-entry pair."}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"JnalSort":{"title":"JnalSort","type":"string","enum":["createdAt","-createdAt"]},"JnalView":{"oneOf":[{"$ref":"#/components/schemas/JnalViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"JnalViewAttributes":"#/components/schemas/JnalViewAttributes"}}},"JnalViewAttributes":{"title":"JnalViewAttributes","description":"One movement in a book, half of a double-entry pair.","examples":[{"type":"JnalViewAttributes","journalEntryId":"sjen_9f2Kd8QpLzXw","counterEntryId":"sjen_9f2Kd8QpLzXw","journal":{"type":"SjnlBusinessKeyAttributes","ownerType":"Merchant","ownerIdentifier":"example","category":"General","clearanceSystem":"example","currency":"AUD"},"entryType":"example","amounts":{"type":"JnalAmountsAttributes","currency":"AUD","debit":"example","credit":"example","tax":"example","taxRate":"0.9412","taxType":"example","taxCountry":"AU"},"event":{"type":"JnalEventAttributes","systemEventId":"abc123","systemEventType":"example"},"merchantId":"mcht_9f2Kd8QpLzXw","marketplaceId":"mktp_9f2Kd8QpLzXw","enterpriseId":"ent_9f2Kd8QpLzXw","originalAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"description":"A short description.","clearanceDate":"2026-08-19","settlementDate":"2026-08-19","referenceId":"your-own-reference","metadata":{"yourKey":"example"},"createdAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","journalEntryId","counterEntryId","journal","entryType","amounts","event","clearanceDate","referenceId","createdAt"],"properties":{"type":{"description":"Always `JnalViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["JnalViewAttributes"]},"journalEntryId":{"$ref":"#/components/schemas/JnalId","description":"Identifier of a journal entry."},"counterEntryId":{"$ref":"#/components/schemas/JnalId","description":"The entry that balances this one. Every entry has exactly one, and together they net to zero."},"journal":{"$ref":"#/components/schemas/SjnlBusinessKey","description":"Which journal this entry is in. The same five fields that identify a journal."},"entryType":{"description":"What kind of movement this is.","type":"string"},"amounts":{"$ref":"#/components/schemas/JnalAmounts"},"event":{"$ref":"#/components/schemas/JnalEvent"},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"The merchant in scope for the movement, where there is one."},"marketplaceId":{"$ref":"#/components/schemas/MktpId","description":"The marketplace that merchant trades under, where it does."},"enterpriseId":{"$ref":"#/components/schemas/EntId","description":"The enterprise in scope."},"originalAmount":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"The amount before currency conversion, where this entry was converted. Genuinely in another currency, so it carries its own."},"description":{"description":"Free text that may be shown to an end user.","type":"string"},"clearanceDate":{"description":"The date the funds are available to move.","type":"string","format":"date"},"settlementDate":{"description":"The date a payout or invoice including this entry is expected. Information only, for reporting.","type":"string","format":"date"},"referenceId":{"description":"Groups entries that moved together. Not unique.","type":"string"},"metadata":{"$ref":"#/components/schemas/MchtStringMap","description":"Free-form data the platform writes against the entry, this is what relates it to a transaction, a payout or a statement."},"createdAt":{"type":"string","format":"date-time"}}},"KycidAddress":{"description":"Where the person lives. Send the componentised form where you have it, the bureaus match better on it.","oneOf":[{"$ref":"#/components/schemas/KycidAddressAttributes"}],"discriminator":{"propertyName":"type","mapping":{"KycidAddressAttributes":"#/components/schemas/KycidAddressAttributes"}}},"KycidAddressAttributes":{"title":"KycidAddressAttributes","description":"Where the person lives. Send the componentised form where you have it, the bureaus match better on it.","examples":[{"type":"KycidAddressAttributes","address":"example","componentised":{"type":"MchtAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"},"addressIdentifier":"example"}],"type":"object","required":["type","address"],"properties":{"type":{"description":"Always `KycidAddressAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["KycidAddressAttributes"]},"address":{"description":"The whole address on one line.","type":"string"},"componentised":{"$ref":"#/components/schemas/MchtAddress","description":"The same address in parts."},"addressIdentifier":{"description":"An address identifier from a lookup service, where one was used.","type":"string"}}},"KycidCmd":{"oneOf":[{"$ref":"#/components/schemas/KycidCmdConsumer"},{"$ref":"#/components/schemas/KycidCmdDelegate"},{"$ref":"#/components/schemas/KycidCmdManual"},{"$ref":"#/components/schemas/KycidCmdSelf"}],"discriminator":{"propertyName":"type","mapping":{"KycidCmdConsumer":"#/components/schemas/KycidCmdConsumer","KycidCmdDelegate":"#/components/schemas/KycidCmdDelegate","KycidCmdManual":"#/components/schemas/KycidCmdManual","KycidCmdSelf":"#/components/schemas/KycidCmdSelf"}}},"KycidCmdConsumer":{"title":"KycidCmdConsumer","description":"Identify a consumer of yours, creating them if they are new. Merchant credential.","examples":[{"type":"KycidCmdConsumer","merchantId":"mcht_9f2Kd8QpLzXw","emailAddress":"ada@example.com","phoneNumber":"+61400000000","referenceCustomerId":"your-own-reference","customerVerified":true,"identification":{"type":"KycidIdentificationAttributes","name":{"type":"KycidNameAttributes","givenName":"Ada Lovelace","middleName":"Ada Lovelace","familyName":"Ada Lovelace"},"dateOfBirth":"2026-08-19","address":{"type":"KycidAddressAttributes","address":"example","componentised":{"type":"MchtAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"},"addressIdentifier":"example"},"documents":[{"type":"KycidDocAustralianLicence","number":"example","state":"example","documentNumber":"example"}]}}],"type":"object","required":["type","merchantId","emailAddress","phoneNumber","customerVerified","identification"],"properties":{"type":{"description":"Always `KycidCmdConsumer`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["KycidCmdConsumer"]},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"The merchant whose consumer this is. The check and the customer both belong to it."},"emailAddress":{"type":"string"},"phoneNumber":{"description":"E.164 format, e.g. +61400000000.","type":"string"},"referenceCustomerId":{"description":"Your own identifier for this customer, carried through to the customer record.","type":"string"},"customerVerified":{"description":"`true` where you have already verified the email address and phone number yourself, so the platform does not send codes.","type":"boolean"},"identification":{"$ref":"#/components/schemas/KycidIdentification"}}},"KycidCmdDelegate":{"title":"KycidCmdDelegate","description":"Identify yourself as a delegate of an organisation customer. Delegate credential.","examples":[{"type":"KycidCmdDelegate","referenceCustomerId":"your-own-reference","identification":{"type":"KycidIdentificationAttributes","name":{"type":"KycidNameAttributes","givenName":"Ada Lovelace","middleName":"Ada Lovelace","familyName":"Ada Lovelace"},"dateOfBirth":"2026-08-19","address":{"type":"KycidAddressAttributes","address":"example","componentised":{"type":"MchtAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"},"addressIdentifier":"example"},"documents":[{"type":"KycidDocAustralianLicence","number":"example","state":"example","documentNumber":"example"}]}}],"type":"object","required":["type","identification"],"properties":{"type":{"description":"Always `KycidCmdDelegate`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["KycidCmdDelegate"]},"referenceCustomerId":{"description":"Your own identifier for this delegate, carried through to the record.","type":"string"},"identification":{"$ref":"#/components/schemas/KycidIdentification"}}},"KycidCmdManual":{"title":"KycidCmdManual","description":"Record an identity check made by hand, against an email address and phone number. Platform administrators only.","examples":[{"type":"KycidCmdManual","emailAddress":"ada@example.com","phoneNumber":"+61400000000","name":{"type":"KycidNameAttributes","givenName":"Ada Lovelace","middleName":"Ada Lovelace","familyName":"Ada Lovelace"},"dateOfBirth":"2026-08-19","address":{"type":"KycidAddressAttributes","address":"example","componentised":{"type":"MchtAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"},"addressIdentifier":"example"},"documents":[{"type":"KycidDocAustralianLicence","number":"example","state":"example","documentNumber":"example"}]}],"type":"object","required":["type","emailAddress","phoneNumber","name","dateOfBirth","address"],"properties":{"type":{"description":"Always `KycidCmdManual`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["KycidCmdManual"]},"emailAddress":{"type":"string"},"phoneNumber":{"description":"E.164 format, e.g. +61400000000.","type":"string"},"name":{"$ref":"#/components/schemas/KycidName"},"dateOfBirth":{"type":"string","format":"date"},"address":{"$ref":"#/components/schemas/KycidAddress"},"documents":{"description":"The documents that were checked.","type":"array","items":{"$ref":"#/components/schemas/KycidDoc"}}}},"KycidCmdSelf":{"title":"KycidCmdSelf","description":"Identify yourself. Customer credential, the customer is the one holding the token.","examples":[{"type":"KycidCmdSelf","referenceCustomerId":"your-own-reference","identification":{"type":"KycidIdentificationAttributes","name":{"type":"KycidNameAttributes","givenName":"Ada Lovelace","middleName":"Ada Lovelace","familyName":"Ada Lovelace"},"dateOfBirth":"2026-08-19","address":{"type":"KycidAddressAttributes","address":"example","componentised":{"type":"MchtAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"},"addressIdentifier":"example"},"documents":[{"type":"KycidDocAustralianLicence","number":"example","state":"example","documentNumber":"example"}]}}],"type":"object","required":["type","identification"],"properties":{"type":{"description":"Always `KycidCmdSelf`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["KycidCmdSelf"]},"referenceCustomerId":{"description":"Your own identifier for this customer, carried through to the customer record.","type":"string"},"identification":{"$ref":"#/components/schemas/KycidIdentification"}}},"KycidDoc":{"oneOf":[{"$ref":"#/components/schemas/KycidDocAustralianLicence"},{"$ref":"#/components/schemas/KycidDocNewZealandLicence"},{"$ref":"#/components/schemas/KycidDocPassport"},{"$ref":"#/components/schemas/KycidDocPassportWithExpiry"}],"discriminator":{"propertyName":"type","mapping":{"KycidDocAustralianLicence":"#/components/schemas/KycidDocAustralianLicence","KycidDocNewZealandLicence":"#/components/schemas/KycidDocNewZealandLicence","KycidDocPassport":"#/components/schemas/KycidDocPassport","KycidDocPassportWithExpiry":"#/components/schemas/KycidDocPassportWithExpiry"}}},"KycidDocAustralianLicence":{"title":"KycidDocAustralianLicence","description":"An Australian driver's licence.","examples":[{"type":"KycidDocAustralianLicence","number":"example","state":"example","documentNumber":"example"}],"type":"object","required":["type","number","state","documentNumber"],"properties":{"type":{"description":"Always `KycidDocAustralianLicence`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["KycidDocAustralianLicence"]},"number":{"type":"string"},"state":{"description":"The state's own abbreviation, `VIC`, `NSW`, `QLD`.","type":"string"},"documentNumber":{"description":"The card number printed on licences issued from 2022. Mandatory in every state now.","type":"string"}}},"KycidDocKind":{"title":"KycidDocKind","type":"string","enum":["AustralianLicence","NewZealandLicence","Passport","PassportWithExpiry","Unknown"]},"KycidDocNewZealandLicence":{"title":"KycidDocNewZealandLicence","description":"A New Zealand driver's licence.","examples":[{"type":"KycidDocNewZealandLicence","number":"example","versionNumber":"example"}],"type":"object","required":["type","number","versionNumber"],"properties":{"type":{"description":"Always `KycidDocNewZealandLicence`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["KycidDocNewZealandLicence"]},"number":{"type":"string"},"versionNumber":{"description":"The version number printed on the card.","type":"string"}}},"KycidDocOption":{"description":"One combination of documents that would satisfy the check, and how many attempts remain at it.","oneOf":[{"$ref":"#/components/schemas/KycidDocOptionAttributes"}],"discriminator":{"propertyName":"type","mapping":{"KycidDocOptionAttributes":"#/components/schemas/KycidDocOptionAttributes"}}},"KycidDocOptionAttributes":{"title":"KycidDocOptionAttributes","description":"One combination of documents that would satisfy the check, and how many attempts remain at it.","examples":[{"type":"KycidDocOptionAttributes","documents":["AustralianLicence"],"remainingAttempts":1250}],"type":"object","required":["type","remainingAttempts"],"properties":{"type":{"description":"Always `KycidDocOptionAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["KycidDocOptionAttributes"]},"documents":{"description":"Every document in this combination must be supplied together.","type":"array","items":{"$ref":"#/components/schemas/KycidDocKind"}},"remainingAttempts":{"description":"Attempts left with this combination before the platform stops accepting it.","type":"integer","format":"int32"}}},"KycidDocPassport":{"title":"KycidDocPassport","description":"A passport, identified by its issuing country.","examples":[{"type":"KycidDocPassport","number":"example","country":"AU"}],"type":"object","required":["type","number","country"],"properties":{"type":{"description":"Always `KycidDocPassport`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["KycidDocPassport"]},"number":{"type":"string"},"country":{"description":"ISO 3166-1 alpha-3 of the issuing nation, `AUS`, `NZL`, `USA`.","type":"string"}}},"KycidDocPassportWithExpiry":{"title":"KycidDocPassportWithExpiry","description":"A passport identified by its expiry date, which is how New Zealand checks are made.","examples":[{"type":"KycidDocPassportWithExpiry","number":"example","expiryDate":"2026-08-19"}],"type":"object","required":["type","number","expiryDate"],"properties":{"type":{"description":"Always `KycidDocPassportWithExpiry`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["KycidDocPassportWithExpiry"]},"number":{"type":"string"},"expiryDate":{"description":"As printed on the passport.","type":"string"}}},"KycidIdentification":{"description":"Who a person says they are, and the documents that prove it.","oneOf":[{"$ref":"#/components/schemas/KycidIdentificationAttributes"}],"discriminator":{"propertyName":"type","mapping":{"KycidIdentificationAttributes":"#/components/schemas/KycidIdentificationAttributes"}}},"KycidIdentificationAttributes":{"title":"KycidIdentificationAttributes","description":"Who a person says they are, and the documents that prove it.","examples":[{"type":"KycidIdentificationAttributes","name":{"type":"KycidNameAttributes","givenName":"Ada Lovelace","middleName":"Ada Lovelace","familyName":"Ada Lovelace"},"dateOfBirth":"2026-08-19","address":{"type":"KycidAddressAttributes","address":"example","componentised":{"type":"MchtAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"},"addressIdentifier":"example"},"documents":[{"type":"KycidDocAustralianLicence","number":"example","state":"example","documentNumber":"example"}]}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `KycidIdentificationAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["KycidIdentificationAttributes"]},"name":{"$ref":"#/components/schemas/KycidName"},"dateOfBirth":{"type":"string","format":"date"},"address":{"$ref":"#/components/schemas/KycidAddress"},"documents":{"description":"The identity documents being presented. At most one of each kind; an empty list asks whether one is needed.","type":"array","items":{"$ref":"#/components/schemas/KycidDoc"}}}},"KycidName":{"description":"A person's name, as it appears on their identity documents.","oneOf":[{"$ref":"#/components/schemas/KycidNameAttributes"}],"discriminator":{"propertyName":"type","mapping":{"KycidNameAttributes":"#/components/schemas/KycidNameAttributes"}}},"KycidNameAttributes":{"title":"KycidNameAttributes","description":"A person's name, as it appears on their identity documents.","examples":[{"type":"KycidNameAttributes","givenName":"Ada Lovelace","middleName":"Ada Lovelace","familyName":"Ada Lovelace"}],"type":"object","required":["type","familyName"],"properties":{"type":{"description":"Always `KycidNameAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["KycidNameAttributes"]},"givenName":{"type":"string"},"middleName":{"type":"string"},"familyName":{"type":"string"}}},"KycidOutcome":{"oneOf":[{"$ref":"#/components/schemas/KycidOutcomeDetailsRequired"},{"$ref":"#/components/schemas/KycidOutcomeDocumentRequired"},{"$ref":"#/components/schemas/KycidOutcomeIdentified"},{"$ref":"#/components/schemas/KycidOutcomeRefused"}],"discriminator":{"propertyName":"type","mapping":{"KycidOutcomeDetailsRequired":"#/components/schemas/KycidOutcomeDetailsRequired","KycidOutcomeDocumentRequired":"#/components/schemas/KycidOutcomeDocumentRequired","KycidOutcomeIdentified":"#/components/schemas/KycidOutcomeIdentified","KycidOutcomeRefused":"#/components/schemas/KycidOutcomeRefused"}}},"KycidOutcomeDetailsRequired":{"title":"KycidOutcomeDetailsRequired","description":"Not yet identified, send more of the person's details and try again. No document is needed.","examples":[{"type":"KycidOutcomeDetailsRequired","message":"example"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `KycidOutcomeDetailsRequired`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["KycidOutcomeDetailsRequired"]},"message":{"description":"What is missing, where the platform can say.","type":"string"}}},"KycidOutcomeDocumentRequired":{"title":"KycidOutcomeDocumentRequired","description":"Not yet identified, a document is needed. Any one of the combinations below would do.","examples":[{"type":"KycidOutcomeDocumentRequired","options":[{"type":"KycidDocOptionAttributes","documents":["AustralianLicence"],"remainingAttempts":1250}],"message":"example"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `KycidOutcomeDocumentRequired`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["KycidOutcomeDocumentRequired"]},"options":{"description":"Each entry is one acceptable combination. Every document within an entry must be sent together.","type":"array","items":{"$ref":"#/components/schemas/KycidDocOption"}},"message":{"type":"string"}}},"KycidOutcomeIdentified":{"title":"KycidOutcomeIdentified","description":"Identified. Nothing further is needed.","examples":[{"type":"KycidOutcomeIdentified"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `KycidOutcomeIdentified`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["KycidOutcomeIdentified"]}}},"KycidOutcomeRefused":{"title":"KycidOutcomeRefused","description":"Refused. The person cannot be identified and further attempts will not change that.","examples":[{"type":"KycidOutcomeRefused","message":"example"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `KycidOutcomeRefused`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["KycidOutcomeRefused"]},"message":{"description":"Why, where the platform can say.","type":"string"}}},"KycidResult":{"description":"What the identity check decided.","oneOf":[{"$ref":"#/components/schemas/KycidResultAttributes"}],"discriminator":{"propertyName":"type","mapping":{"KycidResultAttributes":"#/components/schemas/KycidResultAttributes"}}},"KycidResultAttributes":{"title":"KycidResultAttributes","description":"What the identity check decided.","examples":[{"type":"KycidResultAttributes","outcome":{"type":"KycidOutcomeDetailsRequired","message":"example"},"knownDetails":{"type":"PersonAttributes","givenName":"Ada Lovelace","middleName":"Ada Lovelace","familyName":"Ada Lovelace","dateOfBirth":"2026-08-19","address":{"type":"MchtAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"}}}],"type":"object","required":["type","outcome"],"properties":{"type":{"description":"Always `KycidResultAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["KycidResultAttributes"]},"outcome":{"$ref":"#/components/schemas/KycidOutcome"},"knownDetails":{"$ref":"#/components/schemas/Person","description":"What the platform already holds about this person, present on the delegate arm, where the business check named them as a beneficial owner. Prefill from it rather than asking again."}}},"LfacBalances":{"description":"The balances on a loan facility. All are in the single currency given here.","oneOf":[{"$ref":"#/components/schemas/LfacBalancesAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LfacBalancesAttributes":"#/components/schemas/LfacBalancesAttributes"}}},"LfacBalancesAttributes":{"title":"LfacBalancesAttributes","description":"The balances on a loan facility. All are in the single currency given here.","examples":[{"type":"LfacBalancesAttributes","currency":"AUD","available":1250,"used":1250,"reserved":1250}],"type":"object","required":["type","currency","available","used","reserved"],"properties":{"type":{"description":"Always `LfacBalancesAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LfacBalancesAttributes"]},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"available":{"$ref":"#/components/schemas/MinorUnits","description":"Still available to lend against."},"used":{"$ref":"#/components/schemas/MinorUnits","description":"Currently lent out."},"reserved":{"$ref":"#/components/schemas/MinorUnits","description":"Authorised but not yet drawn."}}},"LfacBankAccount":{"description":"The account a matching statement asks to be paid into.","oneOf":[{"$ref":"#/components/schemas/LfacBankAccountAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LfacBankAccountAttributes":"#/components/schemas/LfacBankAccountAttributes"}}},"LfacBankAccountAttributes":{"title":"LfacBankAccountAttributes","description":"A bank account a statement can ask to be paid into.","examples":[{"type":"LfacBankAccountAttributes","bsbNumber":"example","accountNumber":"example","bankName":"Ada Lovelace","branch":"example","swiftCode":"example"}],"type":"object","required":["type","accountNumber","bankName","swiftCode"],"properties":{"type":{"description":"Always `LfacBankAccountAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LfacBankAccountAttributes"]},"bsbNumber":{"description":"Bank-state-branch number. Required in Australia, where the statement prints it; ignored elsewhere.","type":"string"},"accountNumber":{"type":"string"},"bankName":{"type":"string"},"branch":{"description":"The bank branch. Printed blank where absent, except in New Zealand, where the row is dropped.","type":"string"},"swiftCode":{"type":"string"}}},"LfacBranding":{"oneOf":[{"$ref":"#/components/schemas/LfacBrandingAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LfacBrandingAttributes":"#/components/schemas/LfacBrandingAttributes"}}},"LfacBrandingAttributes":{"title":"LfacBrandingAttributes","description":"The facility's own mark, the one a bill is issued under. A merchant's co-branded mark is a different field on the merchant.","examples":[{"type":"LfacBrandingAttributes","logoUri":"https://example.com/callback"}],"type":"object","required":["type","logoUri"],"properties":{"type":{"description":"Always `LfacBrandingAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LfacBrandingAttributes"]},"logoUri":{"description":"HTTPS URL of the mark, a PNG or JPEG of a few tens of KB. Fetched when a statement is rendered, so it must resolve to a public address; one that cannot be fetched costs the bill its logo, not its delivery.","type":"string"}}},"LfacBusinessProfile":{"oneOf":[{"$ref":"#/components/schemas/LfacBusinessProfileAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LfacBusinessProfileAttributes":"#/components/schemas/LfacBusinessProfileAttributes"}}},"LfacBusinessProfileAttributes":{"title":"LfacBusinessProfileAttributes","description":"The business a facility lends on behalf of.","examples":[{"type":"LfacBusinessProfileAttributes","legalName":"Ada Lovelace","businessNumber":"example","taxRegistrationNumber":"example","taxCountry":"AU","tradingCountry":"AU","contactEmail":"ada@example.com","contactPhone":"+61400000000","website":"example"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `LfacBusinessProfileAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LfacBusinessProfileAttributes"]},"legalName":{"description":"The registered name of the business.","type":"string"},"businessNumber":{"description":"Australian Business Number, or the local equivalent.","type":"string"},"taxRegistrationNumber":{"description":"Tax registration number, where the country requires one distinct from the business number.","type":"string"},"taxCountry":{"$ref":"#/components/schemas/IsoCountry","description":"The country the business is taxed in."},"tradingCountry":{"$ref":"#/components/schemas/IsoCountry","description":"The country the business trades from, where it differs from where it is taxed."},"contactEmail":{"type":"string"},"contactPhone":{"type":"string"},"website":{"description":"The business's own site.","type":"string"}}},"LfacCmd":{"oneOf":[{"$ref":"#/components/schemas/LfacCmdCreate"}],"discriminator":{"propertyName":"type","mapping":{"LfacCmdCreate":"#/components/schemas/LfacCmdCreate"}}},"LfacCmdCreate":{"title":"LfacCmdCreate","description":"Create a loan facility under an enterprise.","examples":[{"type":"LfacCmdCreate","enterpriseId":"ent_9f2Kd8QpLzXw","businessName":"Ada Lovelace","description":"A short description.","currency":"AUD","timeZone":"example","referenceLoanFacilityId":"your-own-reference","organisationId":"org_9f2Kd8QpLzXw"}],"type":"object","required":["type","enterpriseId","businessName","description","currency","timeZone"],"properties":{"type":{"description":"Always `LfacCmdCreate`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LfacCmdCreate"]},"enterpriseId":{"$ref":"#/components/schemas/EntId","description":"Identifier of an enterprise."},"businessName":{"description":"The name of the business lending through this facility.","type":"string"},"description":{"type":"string"},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"timeZone":{"description":"IANA time zone loans from this facility measure their statement periods in, `Australia/Sydney`.","type":"string"},"referenceLoanFacilityId":{"type":"string"},"organisationId":{"$ref":"#/components/schemas/OrgId","description":"An organisation already in the platform that this facility lends to, such as one of the enterprise's merchants. It must be one you can read on `/organisations`. The facility shares that organisation's record instead of one being made from `businessName`."}}},"LfacColumn":{"title":"LfacColumn","type":"string","enum":["LoanFacilityId","EnterpriseId","Description","Status","BalancesCurrency","BalancesAvailable","BalancesUsed","BalancesReserved","TimeZone","BusinessProfileLegalName","BusinessProfileBusinessNumber","BusinessProfileTaxRegistrationNumber","BusinessProfileTaxCountry","BusinessProfileTradingCountry","BusinessProfileContactEmail","BusinessProfileContactPhone","BusinessProfileWebsite","BrandingLogoUri","ReferenceLoanFacilityId","CreatedAt","UpdatedAt"]},"LfacCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/LfacCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LfacCreateRspAttributes":"#/components/schemas/LfacCreateRspAttributes"}}},"LfacCreateRspAttributes":{"title":"LfacCreateRspAttributes","examples":[{"type":"LfacCreateRspAttributes","created":{"type":"LfacViewAttributes","loanFacilityId":"lfac_9f2Kd8QpLzXw","enterpriseId":"ent_9f2Kd8QpLzXw","description":"A short description.","status":"Active","balances":{"type":"LfacBalancesAttributes","currency":"AUD","available":1250,"used":1250,"reserved":1250},"timeZone":"example","businessProfile":{"type":"LfacBusinessProfileAttributes","legalName":"Ada Lovelace","businessNumber":"example","taxRegistrationNumber":"example","taxCountry":"AU","tradingCountry":"AU","contactEmail":"ada@example.com","contactPhone":"+61400000000","website":"example"},"statementReceivingAccounts":[{"type":"LfacReceivingAccountRuleAttributes","productLines":["CentralPay"],"paymentMethods":["DirectDebit"],"account":{"type":"LfacBankAccountAttributes","bsbNumber":"example","accountNumber":"example","bankName":"Ada Lovelace","branch":"example","swiftCode":"example"}}],"branding":{"type":"LfacBrandingAttributes","logoUri":"https://example.com/callback"},"referenceLoanFacilityId":"your-own-reference","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `LfacCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LfacCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/LfacView","description":"The resource that was created."}}},"LfacId":{"title":"LfacId","description":"Identifier of a loan facility.","examples":["lfac_9f2Kd8QpLzXw"],"type":"string"},"LfacPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/LfacPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LfacPageAttributes":"#/components/schemas/LfacPageAttributes"}}},"LfacPageAttributes":{"title":"LfacPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"LfacPageAttributes","data":[{"type":"LfacViewAttributes","loanFacilityId":"lfac_9f2Kd8QpLzXw","enterpriseId":"ent_9f2Kd8QpLzXw","description":"A short description.","status":"Active","balances":{"type":"LfacBalancesAttributes","currency":"AUD","available":1250,"used":1250,"reserved":1250},"timeZone":"example","businessProfile":{"type":"LfacBusinessProfileAttributes","legalName":"Ada Lovelace","businessNumber":"example","taxRegistrationNumber":"example","taxCountry":"AU","tradingCountry":"AU","contactEmail":"ada@example.com","contactPhone":"+61400000000","website":"example"},"statementReceivingAccounts":[{"type":"LfacReceivingAccountRuleAttributes","productLines":["CentralPay"],"paymentMethods":["DirectDebit"],"account":{"type":"LfacBankAccountAttributes","bsbNumber":"example","accountNumber":"example","bankName":"Ada Lovelace","branch":"example","swiftCode":"example"}}],"branding":{"type":"LfacBrandingAttributes","logoUri":"https://example.com/callback"},"referenceLoanFacilityId":"your-own-reference","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `LfacPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LfacPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/LfacView","description":"A loan facility, the pool the platform lends to borrowers from."}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"LfacReceivingAccountRule":{"description":"One row of a facility's receiving-account table: which statements pay into which account. An empty list is a wildcard, so a rule with neither `productLines` nor `paymentMethods` matches every statement.","oneOf":[{"$ref":"#/components/schemas/LfacReceivingAccountRuleAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LfacReceivingAccountRuleAttributes":"#/components/schemas/LfacReceivingAccountRuleAttributes"}}},"LfacReceivingAccountRuleAttributes":{"title":"LfacReceivingAccountRuleAttributes","description":"One row of a facility's receiving-account table: which statements pay into which account. An empty list is a wildcard, so a rule with neither `productLines` nor `paymentMethods` matches every statement.","examples":[{"type":"LfacReceivingAccountRuleAttributes","productLines":["CentralPay"],"paymentMethods":["DirectDebit"],"account":{"type":"LfacBankAccountAttributes","bsbNumber":"example","accountNumber":"example","bankName":"Ada Lovelace","branch":"example","swiftCode":"example"}}],"type":"object","required":["type","account"],"properties":{"type":{"description":"Always `LfacReceivingAccountRuleAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LfacReceivingAccountRuleAttributes"]},"productLines":{"description":"The product lines this rule applies to. Empty or omitted for any.","type":"array","items":{"$ref":"#/components/schemas/LoanProductLine"}},"paymentMethods":{"description":"The ways of paying this rule applies to. Empty or omitted for any. A direct-debit statement draws no account box.","type":"array","items":{"$ref":"#/components/schemas/LfacStatementPaymentMethod"}},"account":{"$ref":"#/components/schemas/LfacBankAccount"}}},"LfacSort":{"title":"LfacSort","type":"string","enum":["createdAt","-createdAt","updatedAt","-updatedAt"]},"LfacStatementPaymentMethod":{"title":"LfacStatementPaymentMethod","type":"string","enum":["DirectDebit","BankTransfer","Unknown"]},"LfacStatus":{"title":"LfacStatus","type":"string","enum":["Active","Paused","Retired","Unknown"]},"LfacTopUp":{"description":"Funds added to a loan facility. All amounts are in the single currency given here, which must be the facility's own.","oneOf":[{"$ref":"#/components/schemas/LfacTopUpAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LfacTopUpAttributes":"#/components/schemas/LfacTopUpAttributes"}}},"LfacTopUpAttributes":{"title":"LfacTopUpAttributes","description":"Funds added to a loan facility. All amounts are in the single currency given here, which must be the facility's own.","examples":[{"type":"LfacTopUpAttributes","currency":"AUD","amount":1250,"limitAdjustment":500000,"description":"A short description."}],"type":"object","required":["type","currency","amount","description"],"properties":{"type":{"description":"Always `LfacTopUpAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LfacTopUpAttributes"]},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"amount":{"$ref":"#/components/schemas/MinorUnits","description":"Funds being added."},"limitAdjustment":{"$ref":"#/components/schemas/MinorUnits","description":"Move the lending limit by this much at the same time. Omit to leave the limit where it is."},"description":{"description":"Why the funds were added. Recorded on the ledger entry.","type":"string"}}},"LfacUpdate":{"oneOf":[{"$ref":"#/components/schemas/LfacUpdateBranding"},{"$ref":"#/components/schemas/LfacUpdateBusinessProfile"},{"$ref":"#/components/schemas/LfacUpdateClearBranding"},{"$ref":"#/components/schemas/LfacUpdateClearStatementReceivingAccounts"},{"$ref":"#/components/schemas/LfacUpdateStatementReceivingAccounts"},{"$ref":"#/components/schemas/LfacUpdateTopUp"}],"discriminator":{"propertyName":"type","mapping":{"LfacUpdateBranding":"#/components/schemas/LfacUpdateBranding","LfacUpdateBusinessProfile":"#/components/schemas/LfacUpdateBusinessProfile","LfacUpdateClearBranding":"#/components/schemas/LfacUpdateClearBranding","LfacUpdateClearStatementReceivingAccounts":"#/components/schemas/LfacUpdateClearStatementReceivingAccounts","LfacUpdateStatementReceivingAccounts":"#/components/schemas/LfacUpdateStatementReceivingAccounts","LfacUpdateTopUp":"#/components/schemas/LfacUpdateTopUp"}}},"LfacUpdateBranding":{"title":"LfacUpdateBranding","description":"Set the mark this facility's statements are drawn with, replacing any already set. Edge's `UpdateLoanFacilityBranding`.","examples":[{"type":"LfacUpdateBranding","branding":{"type":"LfacBrandingAttributes","logoUri":"https://example.com/callback"}}],"type":"object","required":["type","branding"],"properties":{"type":{"description":"Always `LfacUpdateBranding`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LfacUpdateBranding"]},"branding":{"$ref":"#/components/schemas/LfacBranding","description":"The facility's own mark, the one a bill is issued under. A merchant's co-branded mark is a different field on the merchant."}}},"LfacUpdateBusinessProfile":{"title":"LfacUpdateBusinessProfile","description":"Amend the business the facility lends on behalf of. Merged over what is stored.","examples":[{"type":"LfacUpdateBusinessProfile","businessProfile":{"type":"LfacBusinessProfileAttributes","legalName":"Ada Lovelace","businessNumber":"example","taxRegistrationNumber":"example","taxCountry":"AU","tradingCountry":"AU","contactEmail":"ada@example.com","contactPhone":"+61400000000","website":"example"}}],"type":"object","required":["type","businessProfile"],"properties":{"type":{"description":"Always `LfacUpdateBusinessProfile`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LfacUpdateBusinessProfile"]},"businessProfile":{"$ref":"#/components/schemas/LfacBusinessProfile","description":"The business a facility lends on behalf of."}}},"LfacUpdateClearBranding":{"title":"LfacUpdateClearBranding","description":"Remove the facility's mark, so its statements are drawn without one. Edge's `UpdateLoanFacilityBranding` with no `logoUri`.","examples":[{"type":"LfacUpdateClearBranding"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `LfacUpdateClearBranding`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LfacUpdateClearBranding"]}}},"LfacUpdateClearStatementReceivingAccounts":{"title":"LfacUpdateClearStatementReceivingAccounts","description":"Remove every receiving-account rule. A bank-transfer statement then fails rather than print an account, until rules are set again.","examples":[{"type":"LfacUpdateClearStatementReceivingAccounts"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `LfacUpdateClearStatementReceivingAccounts`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LfacUpdateClearStatementReceivingAccounts"]}}},"LfacUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/LfacUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LfacUpdateRspAttributes":"#/components/schemas/LfacUpdateRspAttributes"}}},"LfacUpdateRspAttributes":{"title":"LfacUpdateRspAttributes","examples":[{"type":"LfacUpdateRspAttributes","updated":{"type":"LfacViewAttributes","loanFacilityId":"lfac_9f2Kd8QpLzXw","enterpriseId":"ent_9f2Kd8QpLzXw","description":"A short description.","status":"Active","balances":{"type":"LfacBalancesAttributes","currency":"AUD","available":1250,"used":1250,"reserved":1250},"timeZone":"example","businessProfile":{"type":"LfacBusinessProfileAttributes","legalName":"Ada Lovelace","businessNumber":"example","taxRegistrationNumber":"example","taxCountry":"AU","tradingCountry":"AU","contactEmail":"ada@example.com","contactPhone":"+61400000000","website":"example"},"statementReceivingAccounts":[{"type":"LfacReceivingAccountRuleAttributes","productLines":["CentralPay"],"paymentMethods":["DirectDebit"],"account":{"type":"LfacBankAccountAttributes","bsbNumber":"example","accountNumber":"example","bankName":"Ada Lovelace","branch":"example","swiftCode":"example"}}],"branding":{"type":"LfacBrandingAttributes","logoUri":"https://example.com/callback"},"referenceLoanFacilityId":"your-own-reference","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `LfacUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LfacUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/LfacView","description":"The resource as it stands after the change."}}},"LfacUpdateStatementReceivingAccounts":{"title":"LfacUpdateStatementReceivingAccounts","description":"Replace where this facility's statements ask to be paid. Whole, not merged: rules match in order and the first match wins, so the catch-all belongs last. Read when a statement is rendered, so it changes the next bill. Edge's `ReplaceStatementReceivingAccounts`.","examples":[{"type":"LfacUpdateStatementReceivingAccounts","statementReceivingAccounts":[{"type":"LfacReceivingAccountRuleAttributes","productLines":["CentralPay"],"paymentMethods":["DirectDebit"],"account":{"type":"LfacBankAccountAttributes","bsbNumber":"example","accountNumber":"example","bankName":"Ada Lovelace","branch":"example","swiftCode":"example"}}]}],"type":"object","required":["type","statementReceivingAccounts"],"properties":{"type":{"description":"Always `LfacUpdateStatementReceivingAccounts`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LfacUpdateStatementReceivingAccounts"]},"statementReceivingAccounts":{"description":"The rules, in precedence order. At least one; to remove them all, use `LfacUpdateClearStatementReceivingAccounts`.","type":"array","minItems":1,"items":{"$ref":"#/components/schemas/LfacReceivingAccountRule"}}}},"LfacUpdateTopUp":{"title":"LfacUpdateTopUp","description":"Add funds to the facility, and optionally move what it may lend at the same time.","examples":[{"type":"LfacUpdateTopUp","topUp":{"type":"LfacTopUpAttributes","currency":"AUD","amount":1250,"limitAdjustment":500000,"description":"A short description."}}],"type":"object","required":["type","topUp"],"properties":{"type":{"description":"Always `LfacUpdateTopUp`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LfacUpdateTopUp"]},"topUp":{"$ref":"#/components/schemas/LfacTopUp"}}},"LfacView":{"oneOf":[{"$ref":"#/components/schemas/LfacViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LfacViewAttributes":"#/components/schemas/LfacViewAttributes"}}},"LfacViewAttributes":{"title":"LfacViewAttributes","description":"A loan facility, the pool the platform lends to borrowers from.","examples":[{"type":"LfacViewAttributes","loanFacilityId":"lfac_9f2Kd8QpLzXw","enterpriseId":"ent_9f2Kd8QpLzXw","description":"A short description.","status":"Active","balances":{"type":"LfacBalancesAttributes","currency":"AUD","available":1250,"used":1250,"reserved":1250},"timeZone":"example","businessProfile":{"type":"LfacBusinessProfileAttributes","legalName":"Ada Lovelace","businessNumber":"example","taxRegistrationNumber":"example","taxCountry":"AU","tradingCountry":"AU","contactEmail":"ada@example.com","contactPhone":"+61400000000","website":"example"},"statementReceivingAccounts":[{"type":"LfacReceivingAccountRuleAttributes","productLines":["CentralPay"],"paymentMethods":["DirectDebit"],"account":{"type":"LfacBankAccountAttributes","bsbNumber":"example","accountNumber":"example","bankName":"Ada Lovelace","branch":"example","swiftCode":"example"}}],"branding":{"type":"LfacBrandingAttributes","logoUri":"https://example.com/callback"},"referenceLoanFacilityId":"your-own-reference","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","loanFacilityId","enterpriseId","description","status","balances","timeZone","businessProfile","createdAt","updatedAt"],"properties":{"type":{"description":"Always `LfacViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LfacViewAttributes"]},"loanFacilityId":{"$ref":"#/components/schemas/LfacId"},"enterpriseId":{"$ref":"#/components/schemas/EntId","description":"The enterprise that owns the facility."},"description":{"type":"string"},"status":{"$ref":"#/components/schemas/LfacStatus"},"balances":{"$ref":"#/components/schemas/LfacBalances"},"timeZone":{"description":"IANA time zone loans from this facility measure their statement periods in.","type":"string"},"businessProfile":{"$ref":"#/components/schemas/LfacBusinessProfile","description":"The business the facility lends on behalf of."},"statementReceivingAccounts":{"description":"Where this facility's statements ask to be paid, in precedence order. Absent on a page of facilities, which does not read each one's table; empty where the facility has none yet.","type":"array","items":{"$ref":"#/components/schemas/LfacReceivingAccountRule"}},"branding":{"$ref":"#/components/schemas/LfacBranding","description":"The mark this facility's statements are drawn with, where it has one."},"referenceLoanFacilityId":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"LfileCategory":{"title":"LfileCategory","type":"string","enum":["MerchantOnboarding","Unknown"]},"LfileColumn":{"title":"LfileColumn","type":"string","enum":["FileId","MerchantId","Category","DocumentType","FileName","FileType","SizeKb","CreatedAt"]},"LfileDocumentType":{"title":"LfileDocumentType","type":"string","enum":["CompanyVerificationDocumentFront","CompanyVerificationDocumentBack","CompanyTaxIdVerificationDocument","PersonVerificationDocumentFront","PersonVerificationDocumentBack","PersonVerificationAdditionalDocumentFront","PersonVerificationAdditionalDocumentBack","PartnershipAgreement","TrustDeed","TrustDeedAmendment","Unknown"]},"LfileId":{"title":"LfileId","description":"Identifier of a stored file.","examples":["lfile_9f2Kd8QpLzXw"],"type":"string"},"LfilePage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/LfilePageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LfilePageAttributes":"#/components/schemas/LfilePageAttributes"}}},"LfilePageAttributes":{"title":"LfilePageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"LfilePageAttributes","data":[{"type":"LfileViewAttributes","fileId":"lfile_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","category":"MerchantOnboarding","documentType":"CompanyVerificationDocumentFront","fileName":"Ada Lovelace","fileType":"Pdf","sizeKb":1250,"createdAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `LfilePageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LfilePageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/LfileView"}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"LfileType":{"title":"LfileType","description":"The file's type, derived from its extension and validated against the document type.","type":"string","enum":["Pdf","Png","Jpg","Jpeg","Unknown"]},"LfileUpload":{"title":"LfileUpload","examples":[{"type":"LfileUpload","merchantId":"mcht_9f2Kd8QpLzXw","documentType":"CompanyVerificationDocumentFront","file":"<binary>"}],"type":"object","required":["type","merchantId","documentType","file"],"properties":{"type":{"description":"Always `LfileUpload`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LfileUpload"]},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"Identifier of a merchant."},"documentType":{"$ref":"#/components/schemas/LfileDocumentType"},"file":{"type":"string","format":"binary"}}},"LfileUploaded":{"title":"LfileUploaded","description":"The file the platform stored.","examples":[{"type":"LfileUploaded","fileId":"lfile_9f2Kd8QpLzXw"}],"type":"object","required":["type","fileId"],"properties":{"type":{"description":"Always `LfileUploaded`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LfileUploaded"]},"fileId":{"$ref":"#/components/schemas/LfileId"}}},"LfileView":{"description":"A file the platform holds for a merchant. A KYB document, in practice, that is the only category the platform has.","oneOf":[{"$ref":"#/components/schemas/LfileViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LfileViewAttributes":"#/components/schemas/LfileViewAttributes"}}},"LfileViewAttributes":{"title":"LfileViewAttributes","description":"A file the platform holds for a merchant. A KYB document, in practice, that is the only category the platform has.","examples":[{"type":"LfileViewAttributes","fileId":"lfile_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","category":"MerchantOnboarding","documentType":"CompanyVerificationDocumentFront","fileName":"Ada Lovelace","fileType":"Pdf","sizeKb":1250,"createdAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","fileId","merchantId","category","documentType","fileName","fileType","sizeKb","createdAt"],"properties":{"type":{"description":"Always `LfileViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LfileViewAttributes"]},"fileId":{"$ref":"#/components/schemas/LfileId"},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"The merchant the file belongs to. Every file has one."},"category":{"$ref":"#/components/schemas/LfileCategory","description":"Why the platform holds it. One value today, and it is the reason this collection is KYB-authorised."},"documentType":{"$ref":"#/components/schemas/LfileDocumentType","description":"What the document is. This decides which file types the platform will accept."},"fileName":{"type":"string"},"fileType":{"$ref":"#/components/schemas/LfileType"},"sizeKb":{"description":"Size in kilobytes. The platform reports kilobytes and megabytes; the finer figure is published.","type":"integer","format":"int64"},"createdAt":{"type":"string","format":"date-time"}}},"LmaBalances":{"description":"What the agreement has available and what is currently drawn.","oneOf":[{"$ref":"#/components/schemas/LmaBalancesAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LmaBalancesAttributes":"#/components/schemas/LmaBalancesAttributes"}}},"LmaBalancesAttributes":{"title":"LmaBalancesAttributes","description":"What the agreement has available and what is currently drawn.","examples":[{"type":"LmaBalancesAttributes","currency":"AUD","available":1250,"used":1250,"maxLimit":500000}],"type":"object","required":["type","currency","available","used","maxLimit"],"properties":{"type":{"description":"Always `LmaBalancesAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LmaBalancesAttributes"]},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"available":{"$ref":"#/components/schemas/MinorUnits","description":"Available to draw down."},"used":{"$ref":"#/components/schemas/MinorUnits","description":"Reserved or already loaned out."},"maxLimit":{"$ref":"#/components/schemas/MinorUnits","description":"The most that may be outstanding at once. `available` + `used`."}}},"LmaCmd":{"oneOf":[{"$ref":"#/components/schemas/LmaCmdCreate"}],"discriminator":{"propertyName":"type","mapping":{"LmaCmdCreate":"#/components/schemas/LmaCmdCreate"}}},"LmaCmdCreate":{"title":"LmaCmdCreate","description":"Create a master agreement against a facility.","examples":[{"type":"LmaCmdCreate","loanFacilityId":"lfac_9f2Kd8QpLzXw","referenceAgreementId":"your-own-reference","description":"A short description.","currency":"AUD"}],"type":"object","required":["type","loanFacilityId","referenceAgreementId","description","currency"],"properties":{"type":{"description":"Always `LmaCmdCreate`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LmaCmdCreate"]},"loanFacilityId":{"$ref":"#/components/schemas/LfacId"},"referenceAgreementId":{"type":"string"},"description":{"type":"string"},"currency":{"$ref":"#/components/schemas/IsoCurrency"}}},"LmaColumn":{"title":"LmaColumn","type":"string","enum":["LoanAgreementId","LoanFacilityId","EnterpriseId","ReferenceAgreementId","Description","BalancesCurrency","BalancesAvailable","BalancesUsed","BalancesMaxLimit","CreatedAt","UpdatedAt"]},"LmaCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/LmaCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LmaCreateRspAttributes":"#/components/schemas/LmaCreateRspAttributes"}}},"LmaCreateRspAttributes":{"title":"LmaCreateRspAttributes","examples":[{"type":"LmaCreateRspAttributes","created":{"type":"LmaViewAttributes","loanAgreementId":"lma_9f2Kd8QpLzXw","loanFacilityId":"lfac_9f2Kd8QpLzXw","enterpriseId":"ent_9f2Kd8QpLzXw","referenceAgreementId":"your-own-reference","description":"A short description.","balances":{"type":"LmaBalancesAttributes","currency":"AUD","available":1250,"used":1250,"maxLimit":500000},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `LmaCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LmaCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/LmaView","description":"The resource that was created."}}},"LmaId":{"title":"LmaId","examples":["lma_9f2Kd8QpLzXw"],"type":"string"},"LmaPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/LmaPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LmaPageAttributes":"#/components/schemas/LmaPageAttributes"}}},"LmaPageAttributes":{"title":"LmaPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"LmaPageAttributes","data":[{"type":"LmaViewAttributes","loanAgreementId":"lma_9f2Kd8QpLzXw","loanFacilityId":"lfac_9f2Kd8QpLzXw","enterpriseId":"ent_9f2Kd8QpLzXw","referenceAgreementId":"your-own-reference","description":"A short description.","balances":{"type":"LmaBalancesAttributes","currency":"AUD","available":1250,"used":1250,"maxLimit":500000},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `LmaPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LmaPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/LmaView","description":"The master agreement a set of loans is drawn under, and what is left of its limit."}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"LmaSort":{"title":"LmaSort","type":"string","enum":["createdAt","-createdAt","updatedAt","-updatedAt"]},"LmaUpdate":{"description":"Change what may be outstanding on a master agreement. Omitted fields are left as they are.","oneOf":[{"$ref":"#/components/schemas/LmaUpdateAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LmaUpdateAttributes":"#/components/schemas/LmaUpdateAttributes"}}},"LmaUpdateAttributes":{"title":"LmaUpdateAttributes","description":"Change what may be outstanding on a master agreement. Omitted fields are left as they are.","examples":[{"type":"LmaUpdateAttributes","maxLimit":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"}}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `LmaUpdateAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LmaUpdateAttributes"]},"maxLimit":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"The most that may be outstanding on the agreement at once. Must be in the agreement's own currency."}}},"LmaUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/LmaUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LmaUpdateRspAttributes":"#/components/schemas/LmaUpdateRspAttributes"}}},"LmaUpdateRspAttributes":{"title":"LmaUpdateRspAttributes","examples":[{"type":"LmaUpdateRspAttributes","updated":{"type":"LmaViewAttributes","loanAgreementId":"lma_9f2Kd8QpLzXw","loanFacilityId":"lfac_9f2Kd8QpLzXw","enterpriseId":"ent_9f2Kd8QpLzXw","referenceAgreementId":"your-own-reference","description":"A short description.","balances":{"type":"LmaBalancesAttributes","currency":"AUD","available":1250,"used":1250,"maxLimit":500000},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `LmaUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LmaUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/LmaView","description":"The resource as it stands after the change."}}},"LmaView":{"oneOf":[{"$ref":"#/components/schemas/LmaViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LmaViewAttributes":"#/components/schemas/LmaViewAttributes"}}},"LmaViewAttributes":{"title":"LmaViewAttributes","description":"The master agreement a set of loans is drawn under, and what is left of its limit.","examples":[{"type":"LmaViewAttributes","loanAgreementId":"lma_9f2Kd8QpLzXw","loanFacilityId":"lfac_9f2Kd8QpLzXw","enterpriseId":"ent_9f2Kd8QpLzXw","referenceAgreementId":"your-own-reference","description":"A short description.","balances":{"type":"LmaBalancesAttributes","currency":"AUD","available":1250,"used":1250,"maxLimit":500000},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","loanAgreementId","loanFacilityId","enterpriseId","referenceAgreementId","description","balances","createdAt","updatedAt"],"properties":{"type":{"description":"Always `LmaViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LmaViewAttributes"]},"loanAgreementId":{"$ref":"#/components/schemas/LmaId","description":"Identifier of a loan master agreement."},"loanFacilityId":{"$ref":"#/components/schemas/LfacId"},"enterpriseId":{"$ref":"#/components/schemas/EntId","description":"The enterprise that owns the agreement, the facility's own."},"referenceAgreementId":{"description":"The applicant's own reference for this agreement. Unique within the facility.","type":"string"},"description":{"type":"string"},"balances":{"$ref":"#/components/schemas/LmaBalances"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"LoanApplySpec":{"description":"What is being applied for. The two kinds of loan ask for different things.","oneOf":[{"$ref":"#/components/schemas/LoanApplySpecRealtimeSettlement"},{"$ref":"#/components/schemas/LoanApplySpecTradingAccount"}],"discriminator":{"propertyName":"type","mapping":{"LoanApplySpecRealtimeSettlement":"#/components/schemas/LoanApplySpecRealtimeSettlement","LoanApplySpecTradingAccount":"#/components/schemas/LoanApplySpecTradingAccount"}}},"LoanApplySpecRealtimeSettlement":{"title":"LoanApplySpecRealtimeSettlement","description":"Apply for a real-time-settlement facility for a merchant.","examples":[{"type":"LoanApplySpecRealtimeSettlement","merchantId":"mcht_9f2Kd8QpLzXw","requestedLimit":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"}}],"type":"object","required":["type","merchantId","requestedLimit"],"properties":{"type":{"description":"Always `LoanApplySpecRealtimeSettlement`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LoanApplySpecRealtimeSettlement"]},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"The merchant to enable real-time settlement for."},"requestedLimit":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"The limit asked for on the real-time-settlement account."}}},"LoanApplySpecTradingAccount":{"title":"LoanApplySpecTradingAccount","description":"Apply for a trading account for an organisational customer.","examples":[{"type":"LoanApplySpecTradingAccount","accountName":"Ada Lovelace","customerId":"cust_9f2Kd8QpLzXw","requestedLimit":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"customerFees":{"type":"LprodCustomerFeesAttributes","currency":"AUD","annualFixedFee":1250,"implementationFixedFee":1250,"extendedPaymentTermsVariableFee":12.5,"latePaymentFee":{"type":"LprodLatePaymentFeeAttributes","monthlyRate":0.9412,"minimumFee":1250,"graceDays":1250},"customerTransactionVariableFee":12.5},"supportedCardBrands":["Visa"],"statementFrequency":{"type":"LprodFrequencyDaily"},"graceDays":1250,"industryGroup":"Travel","productLine":"CentralPay","metadataTemplate":{"type":"LoanMetadataTemplateAttributes","validations":[{"type":"LoanMetadataFieldAttributes","path":"additionalMetaData.dbiInfo.dbiAu","validator":{"type":"LoanMetadataValidatorAttributes","name":"Ada Lovelace","statementConstraint":{"type":"LoanMetadataDaysRequiredWithin","days":1250},"transactionConstraint":{"type":"LoanMetadataDaysRequiredWithin","days":1250},"minLength":1250,"maxLength":1250,"format":"Alphanumeric"}}]}}],"type":"object","required":["type","accountName","customerId","requestedLimit"],"properties":{"type":{"description":"Always `LoanApplySpecTradingAccount`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LoanApplySpecTradingAccount"]},"accountName":{"description":"What the trading account is called on statements.","type":"string"},"customerId":{"$ref":"#/components/schemas/CustId","description":"The organisational customer the trading account is for."},"requestedLimit":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"The limit asked for on the trading account."},"customerFees":{"$ref":"#/components/schemas/LprodCustomerFees","description":"Overrides for the product's default fees. Omit to take the product's own."},"supportedCardBrands":{"description":"Brands of card that may be issued against this loan.","type":"array","items":{"$ref":"#/components/schemas/CardBrand"}},"statementFrequency":{"$ref":"#/components/schemas/LprodFrequency","description":"How often to issue a statement. Omit to take the product's default."},"graceDays":{"description":"Days between statement issue and due dates, 2-60. Omit to take the product's default.","type":"integer","format":"int32"},"industryGroup":{"$ref":"#/components/schemas/LoanIndustryGroup","description":"Restrict this loan to one industry group."},"productLine":{"$ref":"#/components/schemas/LoanProductLine","description":"APG's product line, which picks the account a bank-transfer statement asks to be paid into. Omit to set it later with `LoanUpdateProductLine`."},"metadataTemplate":{"$ref":"#/components/schemas/LoanMetadataTemplate","description":"Rules the metadata of this account's card transactions must meet. Omit, or send no `validations`, to check nothing."}}},"LoanBalances":{"oneOf":[{"$ref":"#/components/schemas/LoanBalancesAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LoanBalancesAttributes":"#/components/schemas/LoanBalancesAttributes"}}},"LoanBalancesAttributes":{"title":"LoanBalancesAttributes","description":"The balances on a loan. All are in the single currency given here.","examples":[{"type":"LoanBalancesAttributes","currency":"AUD","limit":500000,"used":1250,"available":1250,"reserved":1250,"pending":1250}],"type":"object","required":["type","currency","limit","used","available","reserved","pending"],"properties":{"type":{"description":"Always `LoanBalancesAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LoanBalancesAttributes"]},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"limit":{"$ref":"#/components/schemas/MinorUnits","description":"The most that can be owed on this loan at any point."},"used":{"$ref":"#/components/schemas/MinorUnits","description":"Currently outstanding in customer statements."},"available":{"$ref":"#/components/schemas/MinorUnits","description":"Available for new drawdowns."},"reserved":{"$ref":"#/components/schemas/MinorUnits","description":"Authorised drawdowns that have not yet reached a customer statement."},"pending":{"$ref":"#/components/schemas/MinorUnits","description":"Repayments that have not yet settled."}}},"LoanCmd":{"oneOf":[{"$ref":"#/components/schemas/LoanCmdAcceptOffer"},{"$ref":"#/components/schemas/LoanCmdApply"}],"discriminator":{"propertyName":"type","mapping":{"LoanCmdAcceptOffer":"#/components/schemas/LoanCmdAcceptOffer","LoanCmdApply":"#/components/schemas/LoanCmdApply"}}},"LoanCmdAcceptOffer":{"title":"LoanCmdAcceptOffer","description":"Accept an offer made in response to an application, which opens the loan.","examples":[{"type":"LoanCmdAcceptOffer","offer":{"type":"LoanOfferAttributes","loanProductId":"lprod_9f2Kd8QpLzXw","loanAgreementId":"lma_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","timeZone":"example","termsAndConditions":"example","expiresAt":"2026-08-19T04:21:07Z","offerToken":"tok_9f2Kd8QpLzXwR4mN","specification":{"type":"LoanOfferSpecRealtimeSettlement","maxLimit":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"variableFee":12.5},"metadata":{"yourKey":{}},"referenceLoanId":"your-own-reference"},"acceptTermsAndConditions":true}],"type":"object","required":["type","offer","acceptTermsAndConditions"],"properties":{"type":{"description":"Always `LoanCmdAcceptOffer`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LoanCmdAcceptOffer"]},"offer":{"$ref":"#/components/schemas/LoanOffer","description":"The offer being accepted, the one `LoanCmdApply` answered with, unchanged."},"acceptTermsAndConditions":{"description":"Confirmation that the borrower has agreed to the offer's terms and conditions. Must be `true`.","type":"boolean"}}},"LoanCmdApply":{"title":"LoanCmdApply","description":"Apply for a loan against a product. Answers with an offer, which you then accept.","examples":[{"type":"LoanCmdApply","loanProductId":"lprod_9f2Kd8QpLzXw","loanAgreementId":"lma_9f2Kd8QpLzXw","timeZone":"example","application":{"type":"LoanApplySpecRealtimeSettlement","merchantId":"mcht_9f2Kd8QpLzXw","requestedLimit":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"}},"metadata":{"yourKey":{}},"referenceLoanId":"your-own-reference"}],"type":"object","required":["type","loanProductId","timeZone","application"],"properties":{"type":{"description":"Always `LoanCmdApply`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LoanCmdApply"]},"loanProductId":{"$ref":"#/components/schemas/LprodId"},"loanAgreementId":{"$ref":"#/components/schemas/LmaId","description":"The master agreement to draw this loan under, where the product uses one."},"timeZone":{"description":"IANA time zone this loan's statement periods are cut in, `Australia/Sydney`.","type":"string"},"application":{"$ref":"#/components/schemas/LoanApplySpec"},"metadata":{"$ref":"#/components/schemas/Metadata","description":"Free-form data to store against the loan."},"referenceLoanId":{"description":"Your own reference for this loan. Unique within the facility, where you send one.","type":"string"}}},"LoanColumn":{"title":"LoanColumn","type":"string","enum":["LoanId","MerchantId","MarketplaceId","CustomerId","LoanFacilityId","LoanProductId","LoanAgreementId","AccountName","Status","BalancesCurrency","BalancesLimit","BalancesUsed","BalancesAvailable","BalancesReserved","BalancesPending","TimeZone","BillingPaymentSourceId","ProductLine","ReferenceLoanId","CreatedAt","UpdatedAt"]},"LoanCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/LoanCreateRspOffered"},{"$ref":"#/components/schemas/LoanCreateRspOpened"}],"discriminator":{"propertyName":"type","mapping":{"LoanCreateRspOffered":"#/components/schemas/LoanCreateRspOffered","LoanCreateRspOpened":"#/components/schemas/LoanCreateRspOpened"}}},"LoanCreateRspOffered":{"title":"LoanCreateRspOffered","description":"The application was assessed and these are the terms. Accept the offer to open the loan.","examples":[{"type":"LoanCreateRspOffered","offer":{"type":"LoanOfferAttributes","loanProductId":"lprod_9f2Kd8QpLzXw","loanAgreementId":"lma_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","timeZone":"example","termsAndConditions":"example","expiresAt":"2026-08-19T04:21:07Z","offerToken":"tok_9f2Kd8QpLzXwR4mN","specification":{"type":"LoanOfferSpecRealtimeSettlement","maxLimit":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"variableFee":12.5},"metadata":{"yourKey":{}},"referenceLoanId":"your-own-reference"}}],"type":"object","required":["type","offer"],"properties":{"type":{"description":"Always `LoanCreateRspOffered`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LoanCreateRspOffered"]},"offer":{"$ref":"#/components/schemas/LoanOffer","description":"An offer of a loan on stated terms. Hand it back to `LoanCmdAcceptOffer` to open the loan."}}},"LoanCreateRspOpened":{"title":"LoanCreateRspOpened","description":"The offer was accepted and the loan is open.","examples":[{"type":"LoanCreateRspOpened","created":{"type":"LoanViewAttributes","loanId":"loan_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","marketplaceId":"mktp_9f2Kd8QpLzXw","customerId":"cust_9f2Kd8QpLzXw","loanFacilityId":"lfac_9f2Kd8QpLzXw","loanProductId":"lprod_9f2Kd8QpLzXw","loanAgreementId":"lma_9f2Kd8QpLzXw","accountName":"Ada Lovelace","status":"Enabled","balances":{"type":"LoanBalancesAttributes","currency":"AUD","limit":500000,"used":1250,"available":1250,"reserved":1250,"pending":1250},"specification":{"type":"LoanSpecRealtimeSettlement","variableFee":12.5,"setting":"Manual"},"timeZone":"example","billingPaymentSourceId":"psrc_9f2Kd8QpLzXw","productLine":"CentralPay","metadata":{"yourKey":{}},"referenceLoanId":"your-own-reference","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `LoanCreateRspOpened`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LoanCreateRspOpened"]},"created":{"$ref":"#/components/schemas/LoanView","description":"A loan, a revolving facility a borrower draws against."}}},"LoanCustomerFees":{"description":"What this borrower is charged, which may override the product's defaults.","oneOf":[{"$ref":"#/components/schemas/LoanCustomerFeesAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LoanCustomerFeesAttributes":"#/components/schemas/LoanCustomerFeesAttributes"}}},"LoanCustomerFeesAttributes":{"title":"LoanCustomerFeesAttributes","description":"The fees charged to a borrower, with when the one-off and annual fees were charged. Those two dates are the platform's own record and are never sent in a request.","examples":[{"type":"LoanCustomerFeesAttributes","currency":"AUD","annualFixedFee":1250,"annualFeeRenewalDate":"2026-08-19","implementationFixedFee":1250,"implementationFeeAppliedAt":"2026-08-19T04:21:07Z","extendedPaymentTermsVariableFee":12.5,"latePaymentFee":{"type":"LprodLatePaymentFeeAttributes","monthlyRate":0.9412,"minimumFee":1250,"graceDays":1250},"customerTransactionVariableFee":12.5}],"type":"object","required":["type","currency","annualFixedFee"],"properties":{"type":{"description":"Always `LoanCustomerFeesAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LoanCustomerFeesAttributes"]},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"annualFixedFee":{"$ref":"#/components/schemas/MinorUnits","description":"Charged to the account annually."},"annualFeeRenewalDate":{"description":"When the annual fee next goes on a statement. Absent until the first one has been charged.","type":"string","format":"date"},"implementationFixedFee":{"$ref":"#/components/schemas/MinorUnits","description":"Charged once, when the loan is established."},"implementationFeeAppliedAt":{"description":"When the establishment fee was applied. Absent while it is still outstanding.","type":"string","format":"date-time"},"extendedPaymentTermsVariableFee":{"description":"Charged on each statement for extended payment terms, on the charges since the last one, as a decimal, `0.01` is 1%.","type":"number"},"latePaymentFee":{"$ref":"#/components/schemas/LprodLatePaymentFee","description":"Charged on each statement for every earlier statement left overdue."},"customerTransactionVariableFee":{"description":"Charged on each statement for its payment terms, on the charges since the last one, as a decimal, `0.01` is 1%.","type":"number"}}},"LoanId":{"title":"LoanId","examples":["loan_9f2Kd8QpLzXw"],"type":"string"},"LoanIndustryGroup":{"title":"LoanIndustryGroup","type":"string","enum":["Travel","Procurement","Unknown"]},"LoanMetadataConstraint":{"oneOf":[{"$ref":"#/components/schemas/LoanMetadataDaysRequiredWithin"},{"$ref":"#/components/schemas/LoanMetadataNotRequired"}],"discriminator":{"propertyName":"type","mapping":{"LoanMetadataDaysRequiredWithin":"#/components/schemas/LoanMetadataDaysRequiredWithin","LoanMetadataNotRequired":"#/components/schemas/LoanMetadataNotRequired"}}},"LoanMetadataDaysRequiredWithin":{"title":"LoanMetadataDaysRequiredWithin","description":"A missing or invalid value holds back what this constraint governs until the value is valid, or until `days` days after the transaction was created. 0 or more; 0 never holds anything.","examples":[{"type":"LoanMetadataDaysRequiredWithin","days":1250}],"type":"object","required":["type","days"],"properties":{"type":{"description":"Always `LoanMetadataDaysRequiredWithin`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LoanMetadataDaysRequiredWithin"]},"days":{"type":"integer","format":"int32"}}},"LoanMetadataField":{"description":"One field of the metadata, and the checks its value must pass.","oneOf":[{"$ref":"#/components/schemas/LoanMetadataFieldAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LoanMetadataFieldAttributes":"#/components/schemas/LoanMetadataFieldAttributes"}}},"LoanMetadataFieldAttributes":{"title":"LoanMetadataFieldAttributes","description":"One field of the metadata, and the checks its value must pass.","examples":[{"type":"LoanMetadataFieldAttributes","path":"additionalMetaData.dbiInfo.dbiAu","validator":{"type":"LoanMetadataValidatorAttributes","name":"Ada Lovelace","statementConstraint":{"type":"LoanMetadataDaysRequiredWithin","days":1250},"transactionConstraint":{"type":"LoanMetadataDaysRequiredWithin","days":1250},"minLength":1250,"maxLength":1250,"format":"Alphanumeric"}}],"type":"object","required":["type","path","validator"],"properties":{"type":{"description":"Always `LoanMetadataFieldAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LoanMetadataFieldAttributes"]},"path":{"description":"Where the field sits in the metadata JSON object. Names are separated by dots, as in `additionalMetaData.dbiInfo.dbiAu`. A dotted name may\nhold only letters, digits and `_`; any other name goes in brackets and quotes, as in `orders['PO number']` or `a['b.c']`, where a backslash\nescapes a quote. Arrays cannot be indexed. A path that is empty, starts with a dot, has an empty name (`a..b`), indexes an array (`a[0]`) or\nhas a space outside brackets is refused with 400. A field listed twice with the same validator is kept once; with a different\nvalidator it is refused with 400.\n","examples":["additionalMetaData.dbiInfo.dbiAu"],"type":"string"},"validator":{"$ref":"#/components/schemas/LoanMetadataValidator"}}},"LoanMetadataFieldFormat":{"title":"LoanMetadataFieldFormat","description":"The characters a present value may contain. `Alphanumeric`: letters, digits, whitespace and `@ . ; : ? + - * / $ & # < > _ , ( ) % '`,\nfor example `PENNY LIM` or `PO-1234/7`. `Alphabetic`: letters and whitespace, for example `PENNY LIM`. `Numeric`: digits and whitespace, for\nexample `045085`; a sign or decimal point is refused. `IsoDate`: eight digits read as `yyyyMMdd`, for example `20250501`; a month above 12\nor a day above 31 is refused. Letters and digits include those of any script.\n","type":"string","enum":["Alphanumeric","Alphabetic","Numeric","IsoDate","Unknown"]},"LoanMetadataNotRequired":{"title":"LoanMetadataNotRequired","description":"A missing or invalid value is reported on the transaction and holds nothing back.","examples":[{"type":"LoanMetadataNotRequired"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `LoanMetadataNotRequired`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LoanMetadataNotRequired"]}}},"LoanMetadataTemplate":{"oneOf":[{"$ref":"#/components/schemas/LoanMetadataTemplateAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LoanMetadataTemplateAttributes":"#/components/schemas/LoanMetadataTemplateAttributes"}}},"LoanMetadataTemplateAttributes":{"title":"LoanMetadataTemplateAttributes","description":"Rules the metadata of this trading account's card transactions must meet: each entry names a field in the metadata and the checks its value must pass.\n\nThe template is checked against a Mastercard digital card's metadata when the card is created, refusing the card with 400 while a field\nthe statement requires is missing or invalid. It is checked against a transaction's metadata when the transaction is created, captured,\nrefunded, has its metadata appended or is revalidated, and hourly while the transaction waits on a field. The outcome is reported on each\ncharge and refund as `metadataValidationOutcome`.\n\nReplacing the template with a different one checks again, at the next hourly run, each of the loan's transactions with a charge or refund\nnot yet on a statement.\n","examples":[{"type":"LoanMetadataTemplateAttributes","validations":[{"type":"LoanMetadataFieldAttributes","path":"additionalMetaData.dbiInfo.dbiAu","validator":{"type":"LoanMetadataValidatorAttributes","name":"Ada Lovelace","statementConstraint":{"type":"LoanMetadataDaysRequiredWithin","days":1250},"transactionConstraint":{"type":"LoanMetadataDaysRequiredWithin","days":1250},"minLength":1250,"maxLength":1250,"format":"Alphanumeric"}}]}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `LoanMetadataTemplateAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LoanMetadataTemplateAttributes"]},"validations":{"description":"The fields to check, one entry per field. An empty list checks nothing.","type":"array","items":{"$ref":"#/components/schemas/LoanMetadataField"}}}},"LoanMetadataValidator":{"description":"The checks a field's value must pass. A string value is checked as it is; a number is checked as its JSON text, so `45085` is checked as\n\"45085\". An absent field, null or a blank string is missing: it is never checked for length or format, and is a problem only while a\nconstraint requires it. A boolean, array or object is invalid, with the issue \"Value must be text, not <type>\" (a boolean, a JSON\narray or a JSON object), and `value` then carries that type, never the content.\n","oneOf":[{"$ref":"#/components/schemas/LoanMetadataValidatorAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LoanMetadataValidatorAttributes":"#/components/schemas/LoanMetadataValidatorAttributes"}}},"LoanMetadataValidatorAttributes":{"title":"LoanMetadataValidatorAttributes","description":"The checks a field's value must pass. A string value is checked as it is; a number is checked as its JSON text, so `45085` is checked as\n\"45085\". An absent field, null or a blank string is missing: it is never checked for length or format, and is a problem only while a\nconstraint requires it. A boolean, array or object is invalid, with the issue \"Value must be text, not <type>\" (a boolean, a JSON\narray or a JSON object), and `value` then carries that type, never the content.\n","examples":[{"type":"LoanMetadataValidatorAttributes","name":"Order Number","statementConstraint":{"type":"LoanMetadataNotRequired"},"transactionConstraint":{"type":"LoanMetadataDaysRequiredWithin","days":14},"minLength":1,"maxLength":17,"format":"Alphanumeric"}],"type":"object","required":["type","name","statementConstraint","transactionConstraint","minLength","maxLength","format"],"properties":{"type":{"description":"Always `LoanMetadataValidatorAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LoanMetadataValidatorAttributes"]},"name":{"description":"The field's display name, used in validation messages. For an `additionalMetaData.dbiInfo.<dbiXx>` path it is also the column label on\nstatements and reports. Must not be blank.\n","type":"string"},"statementConstraint":{"$ref":"#/components/schemas/LoanMetadataConstraint","description":"Whether a missing or invalid value holds a charge off the customer statement. `LoanMetadataNotRequired`: never.\n`LoanMetadataDaysRequiredWithin`: the charge is held until the value is valid or until `days` days after the transaction was created,\nwhichever comes first; after that the requirement lapses and the charge is published as it is. Whatever this says, a charge is published\nat the first statement close 14 days after authorisation, and a refund is never held. Creating a Mastercard digital card is refused while\na field with `days` of 1 or more is missing or invalid.\n"},"transactionConstraint":{"$ref":"#/components/schemas/LoanMetadataConstraint","description":"Whether a missing or invalid value holds back a captured transaction's `publicAt`, the time from which the `publicAtAfter` and\n`publicAtBefore` transaction filters find it. `LoanMetadataNotRequired`: never. `LoanMetadataDaysRequiredWithin`: `publicAt` is set once\nthe value is valid or once `days` days have passed since the transaction was created. Once set, `publicAt` is not withdrawn.\n"},"minLength":{"description":"The fewest characters a present value may have, inclusive, from 0 to 30. A missing or blank value is never measured, so 0 behaves as 1\nand is stored as 1: a field is made optional by its constraints, not by its length.\n","type":"integer","format":"int32"},"maxLength":{"description":"The most characters a present value may have, inclusive, from `minLength` to 30. Equal to `minLength` asks for exactly that length.","type":"integer","format":"int32"},"format":{"$ref":"#/components/schemas/LoanMetadataFieldFormat"}}},"LoanOffer":{"oneOf":[{"$ref":"#/components/schemas/LoanOfferAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LoanOfferAttributes":"#/components/schemas/LoanOfferAttributes"}}},"LoanOfferAttributes":{"title":"LoanOfferAttributes","description":"An offer of a loan on stated terms. Hand it back to `LoanCmdAcceptOffer` to open the loan.","examples":[{"type":"LoanOfferAttributes","loanProductId":"lprod_9f2Kd8QpLzXw","loanAgreementId":"lma_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","timeZone":"example","termsAndConditions":"example","expiresAt":"2026-08-19T04:21:07Z","offerToken":"tok_9f2Kd8QpLzXwR4mN","specification":{"type":"LoanOfferSpecRealtimeSettlement","maxLimit":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"variableFee":12.5},"metadata":{"yourKey":{}},"referenceLoanId":"your-own-reference"}],"type":"object","required":["type","loanProductId","merchantId","timeZone","expiresAt","offerToken","specification"],"properties":{"type":{"description":"Always `LoanOfferAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LoanOfferAttributes"]},"loanProductId":{"$ref":"#/components/schemas/LprodId"},"loanAgreementId":{"$ref":"#/components/schemas/LmaId","description":"The master agreement the loan will be drawn under, where the product uses one."},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"The merchant the loan belongs to."},"timeZone":{"description":"IANA time zone the loan's statement periods will be cut in.","type":"string"},"termsAndConditions":{"description":"The terms and conditions the borrower is agreeing to.","type":"string"},"expiresAt":{"description":"After this the offer can no longer be accepted, and a new application is needed.","type":"string","format":"date-time"},"offerToken":{"description":"Proves the offer is the platform's own. Send it back unchanged.","type":"string"},"specification":{"$ref":"#/components/schemas/LoanOfferSpec"},"metadata":{"$ref":"#/components/schemas/Metadata","description":"Free-form data that will be stored against the loan."},"referenceLoanId":{"description":"Your own reference for the loan.","type":"string"}}},"LoanOfferSpec":{"description":"The terms offered. Mirrors what was applied for, with every figure now settled.","oneOf":[{"$ref":"#/components/schemas/LoanOfferSpecRealtimeSettlement"},{"$ref":"#/components/schemas/LoanOfferSpecTradingAccount"}],"discriminator":{"propertyName":"type","mapping":{"LoanOfferSpecRealtimeSettlement":"#/components/schemas/LoanOfferSpecRealtimeSettlement","LoanOfferSpecTradingAccount":"#/components/schemas/LoanOfferSpecTradingAccount"}}},"LoanOfferSpecRealtimeSettlement":{"title":"LoanOfferSpecRealtimeSettlement","description":"Real-time settlement offered on these terms.","examples":[{"type":"LoanOfferSpecRealtimeSettlement","maxLimit":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"variableFee":12.5}],"type":"object","required":["type","maxLimit","variableFee"],"properties":{"type":{"description":"Always `LoanOfferSpecRealtimeSettlement`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LoanOfferSpecRealtimeSettlement"]},"maxLimit":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"The limit the account will carry."},"variableFee":{"description":"Charged on payments that use real-time settlement, as a decimal.","type":"number"}}},"LoanOfferSpecTradingAccount":{"title":"LoanOfferSpecTradingAccount","description":"A trading account offered on these terms.","examples":[{"type":"LoanOfferSpecTradingAccount","accountName":"Ada Lovelace","customerId":"cust_9f2Kd8QpLzXw","maxLimit":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"customerFees":{"type":"LprodCustomerFeesAttributes","currency":"AUD","annualFixedFee":1250,"implementationFixedFee":1250,"extendedPaymentTermsVariableFee":12.5,"latePaymentFee":{"type":"LprodLatePaymentFeeAttributes","monthlyRate":0.9412,"minimumFee":1250,"graceDays":1250},"customerTransactionVariableFee":12.5},"supportedCardBrands":["Visa"],"statementFrequency":{"type":"LprodFrequencyDaily"},"graceDays":1250,"industryGroup":"Travel","productLine":"CentralPay","metadataTemplate":{"type":"LoanMetadataTemplateAttributes","validations":[{"type":"LoanMetadataFieldAttributes","path":"additionalMetaData.dbiInfo.dbiAu","validator":{"type":"LoanMetadataValidatorAttributes","name":"Ada Lovelace","statementConstraint":{"type":"LoanMetadataDaysRequiredWithin","days":1250},"transactionConstraint":{"type":"LoanMetadataDaysRequiredWithin","days":1250},"minLength":1250,"maxLength":1250,"format":"Alphanumeric"}}]}}],"type":"object","required":["type","accountName","customerId","maxLimit","customerFees","statementFrequency","graceDays","metadataTemplate"],"properties":{"type":{"description":"Always `LoanOfferSpecTradingAccount`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LoanOfferSpecTradingAccount"]},"accountName":{"type":"string"},"customerId":{"$ref":"#/components/schemas/CustId","description":"Identifier of a customer."},"maxLimit":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"The limit the account will carry."},"customerFees":{"$ref":"#/components/schemas/LprodCustomerFees","description":"What the borrower will be charged."},"supportedCardBrands":{"description":"Brands of card that may be issued against the loan.","type":"array","items":{"$ref":"#/components/schemas/CardBrand"}},"statementFrequency":{"$ref":"#/components/schemas/LprodFrequency"},"graceDays":{"description":"Days between statement issue and due dates.","type":"integer","format":"int32"},"industryGroup":{"$ref":"#/components/schemas/LoanIndustryGroup"},"productLine":{"$ref":"#/components/schemas/LoanProductLine","description":"APG's product line, as applied for. Signed with the offer, so send it back unchanged."},"metadataTemplate":{"$ref":"#/components/schemas/LoanMetadataTemplate","description":"The metadata template, as applied for. Signed with the offer, so send it back unchanged."}}},"LoanPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/LoanPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LoanPageAttributes":"#/components/schemas/LoanPageAttributes"}}},"LoanPageAttributes":{"title":"LoanPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"LoanPageAttributes","data":[{"type":"LoanViewAttributes","loanId":"loan_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","marketplaceId":"mktp_9f2Kd8QpLzXw","customerId":"cust_9f2Kd8QpLzXw","loanFacilityId":"lfac_9f2Kd8QpLzXw","loanProductId":"lprod_9f2Kd8QpLzXw","loanAgreementId":"lma_9f2Kd8QpLzXw","accountName":"Ada Lovelace","status":"Enabled","balances":{"type":"LoanBalancesAttributes","currency":"AUD","limit":500000,"used":1250,"available":1250,"reserved":1250,"pending":1250},"specification":{"type":"LoanSpecRealtimeSettlement","variableFee":12.5,"setting":"Manual"},"timeZone":"example","billingPaymentSourceId":"psrc_9f2Kd8QpLzXw","productLine":"CentralPay","metadata":{"yourKey":{}},"referenceLoanId":"your-own-reference","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `LoanPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LoanPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/LoanView","description":"A loan, a revolving facility a borrower draws against."}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"LoanProductLine":{"title":"LoanProductLine","type":"string","enum":["CentralPay","VirtualPay","Taa","B2b","SupplyChain","Unknown"]},"LoanSettlementSetting":{"title":"LoanSettlementSetting","type":"string","enum":["Manual","AutomaticPreferred","AutomaticRequired","Unknown"]},"LoanSort":{"title":"LoanSort","type":"string","enum":["createdAt","-createdAt"]},"LoanSpec":{"description":"The terms this loan runs on, which kind of loan it is, and what the borrower is charged.","oneOf":[{"$ref":"#/components/schemas/LoanSpecRealtimeSettlement"},{"$ref":"#/components/schemas/LoanSpecTradingAccount"}],"discriminator":{"propertyName":"type","mapping":{"LoanSpecRealtimeSettlement":"#/components/schemas/LoanSpecRealtimeSettlement","LoanSpecTradingAccount":"#/components/schemas/LoanSpecTradingAccount"}}},"LoanSpecRealtimeSettlement":{"title":"LoanSpecRealtimeSettlement","description":"Funds a merchant's settlement in real time, charging a rate on the payments it settles.","examples":[{"type":"LoanSpecRealtimeSettlement","variableFee":12.5,"setting":"Manual"}],"type":"object","required":["type","variableFee","setting"],"properties":{"type":{"description":"Always `LoanSpecRealtimeSettlement`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LoanSpecRealtimeSettlement"]},"variableFee":{"description":"Charged on payments that use the real-time settlement service, as a decimal.","type":"number"},"setting":{"$ref":"#/components/schemas/LoanSettlementSetting","description":"Whether payments use real-time settlement automatically, and what happens when it is unavailable."}}},"LoanSpecTradingAccount":{"title":"LoanSpecTradingAccount","description":"A revolving trading account a customer draws against and repays on statement.","examples":[{"type":"LoanSpecTradingAccount","customerId":"cust_9f2Kd8QpLzXw","statementFrequency":{"type":"LprodFrequencyDaily"},"graceDays":1250,"customerFees":{"type":"LoanCustomerFeesAttributes","currency":"AUD","annualFixedFee":1250,"annualFeeRenewalDate":"2026-08-19","implementationFixedFee":1250,"implementationFeeAppliedAt":"2026-08-19T04:21:07Z","extendedPaymentTermsVariableFee":12.5,"latePaymentFee":{"type":"LprodLatePaymentFeeAttributes","monthlyRate":0.9412,"minimumFee":1250,"graceDays":1250},"customerTransactionVariableFee":12.5},"supportedCardBrands":["Visa"],"industryGroup":"Travel","metadataTemplate":{"type":"LoanMetadataTemplateAttributes","validations":[{"type":"LoanMetadataFieldAttributes","path":"additionalMetaData.dbiInfo.dbiAu","validator":{"type":"LoanMetadataValidatorAttributes","name":"Ada Lovelace","statementConstraint":{"type":"LoanMetadataDaysRequiredWithin","days":1250},"transactionConstraint":{"type":"LoanMetadataDaysRequiredWithin","days":1250},"minLength":1250,"maxLength":1250,"format":"Alphanumeric"}}]}}],"type":"object","required":["type","customerId","statementFrequency","graceDays","customerFees","metadataTemplate"],"properties":{"type":{"description":"Always `LoanSpecTradingAccount`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LoanSpecTradingAccount"]},"customerId":{"$ref":"#/components/schemas/CustId","description":"The organisational customer that owns the trading account."},"statementFrequency":{"$ref":"#/components/schemas/LprodFrequency","description":"How often this borrower is sent a statement, and on which day."},"graceDays":{"description":"Days between a statement being issued and falling due.","type":"integer","format":"int32"},"customerFees":{"$ref":"#/components/schemas/LoanCustomerFees"},"supportedCardBrands":{"description":"Brands of card that may be issued against this loan.","type":"array","items":{"$ref":"#/components/schemas/CardBrand"}},"industryGroup":{"$ref":"#/components/schemas/LoanIndustryGroup","description":"The industry group this loan is restricted to, where it is restricted at all."},"metadataTemplate":{"$ref":"#/components/schemas/LoanMetadataTemplate","description":"Rules the metadata of this account's card transactions must meet. Replace it with `LoanUpdateTradingAccount`."}}},"LoanStatementDeliveryChannel":{"title":"LoanStatementDeliveryChannel","type":"string","enum":["Email","PortalDownload","Unknown"]},"LoanStatementDocumentFormat":{"title":"LoanStatementDocumentFormat","type":"string","enum":["Csv","Pdf","Xml","Unknown"]},"LoanStatementDocumentSetting":{"description":"How one document format is to be produced and delivered.","oneOf":[{"$ref":"#/components/schemas/LoanStatementDocumentSettingAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LoanStatementDocumentSettingAttributes":"#/components/schemas/LoanStatementDocumentSettingAttributes"}}},"LoanStatementDocumentSettingAttributes":{"title":"LoanStatementDocumentSettingAttributes","description":"How one document format is to be produced and delivered.","examples":[{"type":"LoanStatementDocumentSettingAttributes","format":"Csv","enabled":true,"schemaVersion":"example","channels":["Email"]}],"type":"object","required":["type","format","enabled"],"properties":{"type":{"description":"Always `LoanStatementDocumentSettingAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LoanStatementDocumentSettingAttributes"]},"format":{"$ref":"#/components/schemas/LoanStatementDocumentFormat","description":"Each format at most once."},"enabled":{"description":"A disabled document is configured but not produced.","type":"boolean"},"schemaVersion":{"description":"APG's file schema version, `D.CDF3.V1.0.0`: letters, digits, `.`, `_` and `-`, at most 64. Blank is stored as absent.","type":"string"},"channels":{"description":"How the document reaches the customer. `Email` on an enabled document needs `statementEmails` and `transferEncryption`.","type":"array","items":{"$ref":"#/components/schemas/LoanStatementDeliveryChannel"}}}},"LoanStatementDocumentSettingView":{"description":"How one document format is produced and delivered.","oneOf":[{"$ref":"#/components/schemas/LoanStatementDocumentSettingViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LoanStatementDocumentSettingViewAttributes":"#/components/schemas/LoanStatementDocumentSettingViewAttributes"}}},"LoanStatementDocumentSettingViewAttributes":{"title":"LoanStatementDocumentSettingViewAttributes","description":"How one document format is produced and delivered.","examples":[{"type":"LoanStatementDocumentSettingViewAttributes","format":"Csv","enabled":true,"schemaVersion":"example","channels":["Email"]}],"type":"object","required":["type","format","enabled"],"properties":{"type":{"description":"Always `LoanStatementDocumentSettingViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LoanStatementDocumentSettingViewAttributes"]},"format":{"$ref":"#/components/schemas/LoanStatementDocumentFormat"},"enabled":{"description":"A disabled document is configured but not produced.","type":"boolean"},"schemaVersion":{"description":"APG's file schema version, `D.CDF3.V1.0.0`, where the format has one.","type":"string"},"channels":{"description":"How the document reaches the customer.","type":"array","items":{"$ref":"#/components/schemas/LoanStatementDeliveryChannel"}}}},"LoanStatementSettings":{"oneOf":[{"$ref":"#/components/schemas/LoanStatementSettingsConfigured"},{"$ref":"#/components/schemas/LoanStatementSettingsNotConfigured"}],"discriminator":{"propertyName":"type","mapping":{"LoanStatementSettingsConfigured":"#/components/schemas/LoanStatementSettingsConfigured","LoanStatementSettingsNotConfigured":"#/components/schemas/LoanStatementSettingsNotConfigured"}}},"LoanStatementSettingsConfigured":{"title":"LoanStatementSettingsConfigured","description":"The loan's own settings. A format not listed is not produced. Settings imported from APG read back as stored, so `,`-joined or malformed addresses can appear here; sending them back in `LoanUpdateStatementSettings` is refused until they are corrected.","examples":[{"type":"LoanStatementSettingsConfigured","documents":[{"type":"LoanStatementDocumentSettingViewAttributes","format":"Csv","enabled":true,"schemaVersion":"example","channels":["Email"]}],"statementEmails":["ada@example.com"],"readyNoticeEmails":["ada@example.com"],"transferEncryption":{"type":"LoanStatementTransferEncryptionViewAttributes","method":"Zip","secretSet":true},"systemIntegrations":[{"type":"LoanStatementSystemIntegrationAttributes","sysCode":"example","formats":["Csv"],"enabled":true,"referenceCustomerId":"your-own-reference","isTest":true}],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","createdAt","updatedAt"],"properties":{"type":{"description":"Always `LoanStatementSettingsConfigured`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LoanStatementSettingsConfigured"]},"documents":{"type":"array","items":{"$ref":"#/components/schemas/LoanStatementDocumentSettingView"}},"statementEmails":{"description":"Where the statement mail and its documents go, one address per entry.","type":"array","items":{"type":"string"}},"readyNoticeEmails":{"description":"Who is told a statement is ready to download, one address per entry. Empty sends no notice.","type":"array","items":{"type":"string"}},"transferEncryption":{"$ref":"#/components/schemas/LoanStatementTransferEncryptionView"},"systemIntegrations":{"description":"Read-only. A replacement keeps them and clearing the settings deletes them.","type":"array","items":{"$ref":"#/components/schemas/LoanStatementSystemIntegration"}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"LoanStatementSettingsNotConfigured":{"title":"LoanStatementSettingsNotConfigured","description":"Nobody has configured this loan, or its settings were cleared. Its statements get CSV and PDF and nothing is mailed.","examples":[{"type":"LoanStatementSettingsNotConfigured","documents":[{"type":"LoanStatementDocumentSettingViewAttributes","format":"Csv","enabled":true,"schemaVersion":"example","channels":["Email"]}],"statementEmails":["ada@example.com"],"readyNoticeEmails":["ada@example.com"]}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `LoanStatementSettingsNotConfigured`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LoanStatementSettingsNotConfigured"]},"documents":{"description":"What a loan with no settings gets: CSV and PDF, enabled, on no channel.","type":"array","items":{"$ref":"#/components/schemas/LoanStatementDocumentSettingView"}},"statementEmails":{"description":"Always empty.","type":"array","items":{"type":"string"}},"readyNoticeEmails":{"description":"Always empty.","type":"array","items":{"type":"string"}}}},"LoanStatementSettingsReplacement":{"description":"A loan's statement settings, whole. The system integrations are not written here and are kept.","oneOf":[{"$ref":"#/components/schemas/LoanStatementSettingsReplacementAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LoanStatementSettingsReplacementAttributes":"#/components/schemas/LoanStatementSettingsReplacementAttributes"}}},"LoanStatementSettingsReplacementAttributes":{"title":"LoanStatementSettingsReplacementAttributes","description":"A loan's statement settings, whole. The system integrations are not written here and are kept.","examples":[{"type":"LoanStatementSettingsReplacementAttributes","documents":[{"type":"LoanStatementDocumentSettingAttributes","format":"Csv","enabled":true,"schemaVersion":"example","channels":["Email"]}],"statementEmails":["ada@example.com"],"readyNoticeEmails":["ada@example.com"],"transferEncryption":{"type":"LoanStatementTransferEncryptionKeep","method":"Zip"}}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `LoanStatementSettingsReplacementAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LoanStatementSettingsReplacementAttributes"]},"documents":{"description":"The formats to produce. A format not listed is not produced.","type":"array","items":{"$ref":"#/components/schemas/LoanStatementDocumentSetting"}},"statementEmails":{"description":"Where the statement mail and its documents go. One address per entry, no repeats, at most 50.","type":"array","items":{"type":"string"}},"readyNoticeEmails":{"description":"Who is told a statement is ready to download. One address per entry, no repeats, at most 50; empty sends no notice.","type":"array","items":{"type":"string"}},"transferEncryption":{"$ref":"#/components/schemas/LoanStatementTransferEncryption"}}},"LoanStatementSystemIntegration":{"description":"A third-party expense system this loan's documents are pushed to, imported from APG. Nothing on the platform acts on it yet.","oneOf":[{"$ref":"#/components/schemas/LoanStatementSystemIntegrationAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LoanStatementSystemIntegrationAttributes":"#/components/schemas/LoanStatementSystemIntegrationAttributes"}}},"LoanStatementSystemIntegrationAttributes":{"title":"LoanStatementSystemIntegrationAttributes","description":"A third-party expense system this loan's documents are pushed to, imported from APG. Nothing on the platform acts on it yet.","examples":[{"type":"LoanStatementSystemIntegrationAttributes","sysCode":"example","formats":["Csv"],"enabled":true,"referenceCustomerId":"your-own-reference","isTest":true}],"type":"object","required":["type","sysCode","enabled","isTest"],"properties":{"type":{"description":"Always `LoanStatementSystemIntegrationAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LoanStatementSystemIntegrationAttributes"]},"sysCode":{"description":"APG's system code, `conferma`, `inlogik`, `Concur`.","type":"string"},"formats":{"type":"array","items":{"$ref":"#/components/schemas/LoanStatementDocumentFormat"}},"enabled":{"type":"boolean"},"referenceCustomerId":{"description":"The customer's identifier in that system.","type":"string"},"isTest":{"description":"Whether it points at the third party's test endpoint.","type":"boolean"}}},"LoanStatementTransferEncryption":{"description":"How mailed copies are encrypted. Omit it to stop encrypting, which is refused while an enabled document has `Email`.","oneOf":[{"$ref":"#/components/schemas/LoanStatementTransferEncryptionKeep"},{"$ref":"#/components/schemas/LoanStatementTransferEncryptionSet"}],"discriminator":{"propertyName":"type","mapping":{"LoanStatementTransferEncryptionKeep":"#/components/schemas/LoanStatementTransferEncryptionKeep","LoanStatementTransferEncryptionSet":"#/components/schemas/LoanStatementTransferEncryptionSet"}}},"LoanStatementTransferEncryptionKeep":{"title":"LoanStatementTransferEncryptionKeep","description":"Keep the stored secret. Refused when none is stored, or it was stored under another method.","examples":[{"type":"LoanStatementTransferEncryptionKeep","method":"Zip"}],"type":"object","required":["type","method"],"properties":{"type":{"description":"Always `LoanStatementTransferEncryptionKeep`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LoanStatementTransferEncryptionKeep"]},"method":{"$ref":"#/components/schemas/LoanStatementTransferEncryptionMethod"}}},"LoanStatementTransferEncryptionMethod":{"title":"LoanStatementTransferEncryptionMethod","type":"string","enum":["Zip","Pgp","Unknown"]},"LoanStatementTransferEncryptionSet":{"title":"LoanStatementTransferEncryptionSet","description":"Encrypt with this secret, replacing any stored. Needed when none is stored or the method changes.","examples":[{"type":"LoanStatementTransferEncryptionSet","method":"Zip","secret":"example"}],"type":"object","required":["type","method","secret"],"properties":{"type":{"description":"Always `LoanStatementTransferEncryptionSet`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LoanStatementTransferEncryptionSet"]},"method":{"$ref":"#/components/schemas/LoanStatementTransferEncryptionMethod"},"secret":{"description":"A zip password of at most 128 characters, or an ASCII-armoured PGP public key of at most 64 KiB. Sent in plain text, stored encrypted, never returned; APG's own ciphertext cannot be sent here.","type":"string","format":"password"}}},"LoanStatementTransferEncryptionView":{"description":"How mailed copies are encrypted. Absent: nothing is mailed, since a statement mail is never sent unencrypted.","oneOf":[{"$ref":"#/components/schemas/LoanStatementTransferEncryptionViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LoanStatementTransferEncryptionViewAttributes":"#/components/schemas/LoanStatementTransferEncryptionViewAttributes"}}},"LoanStatementTransferEncryptionViewAttributes":{"title":"LoanStatementTransferEncryptionViewAttributes","description":"How mailed copies are encrypted. The secret itself is never returned.","examples":[{"type":"LoanStatementTransferEncryptionViewAttributes","method":"Zip","secretSet":true}],"type":"object","required":["type","method","secretSet"],"properties":{"type":{"description":"Always `LoanStatementTransferEncryptionViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LoanStatementTransferEncryptionViewAttributes"]},"method":{"$ref":"#/components/schemas/LoanStatementTransferEncryptionMethod"},"secretSet":{"description":"Whether a secret is stored. `LoanStatementTransferEncryptionKeep` needs one, under the same method.","type":"boolean"}}},"LoanStatus":{"title":"LoanStatus","type":"string","enum":["Enabled","Disabled","Unknown"]},"LoanUpdate":{"oneOf":[{"$ref":"#/components/schemas/LoanUpdateAccountName"},{"$ref":"#/components/schemas/LoanUpdateBillingSource"},{"$ref":"#/components/schemas/LoanUpdateClearStatementSettings"},{"$ref":"#/components/schemas/LoanUpdateDisable"},{"$ref":"#/components/schemas/LoanUpdateEnable"},{"$ref":"#/components/schemas/LoanUpdateMetadata"},{"$ref":"#/components/schemas/LoanUpdateProductLine"},{"$ref":"#/components/schemas/LoanUpdateRealtimeSettlement"},{"$ref":"#/components/schemas/LoanUpdateReference"},{"$ref":"#/components/schemas/LoanUpdateStatementSettings"},{"$ref":"#/components/schemas/LoanUpdateTradingAccount"}],"discriminator":{"propertyName":"type","mapping":{"LoanUpdateAccountName":"#/components/schemas/LoanUpdateAccountName","LoanUpdateBillingSource":"#/components/schemas/LoanUpdateBillingSource","LoanUpdateClearStatementSettings":"#/components/schemas/LoanUpdateClearStatementSettings","LoanUpdateDisable":"#/components/schemas/LoanUpdateDisable","LoanUpdateEnable":"#/components/schemas/LoanUpdateEnable","LoanUpdateMetadata":"#/components/schemas/LoanUpdateMetadata","LoanUpdateProductLine":"#/components/schemas/LoanUpdateProductLine","LoanUpdateRealtimeSettlement":"#/components/schemas/LoanUpdateRealtimeSettlement","LoanUpdateReference":"#/components/schemas/LoanUpdateReference","LoanUpdateStatementSettings":"#/components/schemas/LoanUpdateStatementSettings","LoanUpdateTradingAccount":"#/components/schemas/LoanUpdateTradingAccount"}}},"LoanUpdateAccountName":{"title":"LoanUpdateAccountName","description":"Change the name this loan appears under on statements.","examples":[{"type":"LoanUpdateAccountName","accountName":"Ada Lovelace"}],"type":"object","required":["type","accountName"],"properties":{"type":{"description":"Always `LoanUpdateAccountName`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LoanUpdateAccountName"]},"accountName":{"type":"string"}}},"LoanUpdateBillingSource":{"title":"LoanUpdateBillingSource","description":"Change the payment source repayments are taken from. Omit it to stop automated billing.","examples":[{"type":"LoanUpdateBillingSource","billingPaymentSourceId":"psrc_9f2Kd8QpLzXw"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `LoanUpdateBillingSource`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LoanUpdateBillingSource"]},"billingPaymentSourceId":{"$ref":"#/components/schemas/PsrcId","description":"Identifier of a payment source."}}},"LoanUpdateClearStatementSettings":{"title":"LoanUpdateClearStatementSettings","description":"Delete the loan's statement settings, so its statements go back to CSV and PDF with nothing mailed. The system integrations imported with them go too, and only a re-import restores them. Answers the same whether or not there were any. Edge's `DeleteLoanStatementSettings`.","examples":[{"type":"LoanUpdateClearStatementSettings"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `LoanUpdateClearStatementSettings`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LoanUpdateClearStatementSettings"]}}},"LoanUpdateDisable":{"title":"LoanUpdateDisable","description":"Refuse further drawdowns while repayments continue.","examples":[{"type":"LoanUpdateDisable"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `LoanUpdateDisable`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LoanUpdateDisable"]}}},"LoanUpdateEnable":{"title":"LoanUpdateEnable","description":"Allow drawdowns again.","examples":[{"type":"LoanUpdateEnable"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `LoanUpdateEnable`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LoanUpdateEnable"]}}},"LoanUpdateMetadata":{"title":"LoanUpdateMetadata","description":"Replace the free-form data the platform stores and returns untouched.","examples":[{"type":"LoanUpdateMetadata","metadata":{"yourKey":{}}}],"type":"object","required":["type","metadata"],"properties":{"type":{"description":"Always `LoanUpdateMetadata`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LoanUpdateMetadata"]},"metadata":{"$ref":"#/components/schemas/Metadata","description":"Free-form data the platform stores and returns untouched. Values may be nested objects and arrays."}}},"LoanUpdateProductLine":{"title":"LoanUpdateProductLine","description":"Set APG's product line, which picks the account a bank-transfer statement asks to be paid into. Edge's `UpdateLoanProductLine`.","examples":[{"type":"LoanUpdateProductLine","productLine":"CentralPay"}],"type":"object","required":["type","productLine"],"properties":{"type":{"description":"Always `LoanUpdateProductLine`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LoanUpdateProductLine"]},"productLine":{"$ref":"#/components/schemas/LoanProductLine"}}},"LoanUpdateRealtimeSettlement":{"title":"LoanUpdateRealtimeSettlement","description":"Change the terms of a loan that settles in realtime against a merchant's takings. Only for that kind of loan.","examples":[{"type":"LoanUpdateRealtimeSettlement","currency":"AUD","maxLimit":500000,"settlementRate":0.9412,"setting":"Manual"}],"type":"object","required":["type","currency"],"properties":{"type":{"description":"Always `LoanUpdateRealtimeSettlement`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LoanUpdateRealtimeSettlement"]},"currency":{"$ref":"#/components/schemas/IsoCurrency","description":"The currency the limit is stated in, the loan's own."},"maxLimit":{"$ref":"#/components/schemas/MinorUnits","description":"An amount in the minor units of the currency given by the enclosing object's `currency` field."},"settlementRate":{"type":"number"},"setting":{"$ref":"#/components/schemas/LoanSettlementSetting"}}},"LoanUpdateReference":{"title":"LoanUpdateReference","description":"Change your own reference for this loan.","examples":[{"type":"LoanUpdateReference","referenceLoanId":"your-own-reference"}],"type":"object","required":["type","referenceLoanId"],"properties":{"type":{"description":"Always `LoanUpdateReference`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LoanUpdateReference"]},"referenceLoanId":{"type":"string"}}},"LoanUpdateRsp":{"description":"The loan after the patch, with its statement settings where the patch changed them.","oneOf":[{"$ref":"#/components/schemas/LoanUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LoanUpdateRspAttributes":"#/components/schemas/LoanUpdateRspAttributes"}}},"LoanUpdateRspAttributes":{"title":"LoanUpdateRspAttributes","description":"The loan after the patch, with its statement settings where the patch changed them.","examples":[{"type":"LoanUpdateRspAttributes","updated":{"type":"LoanViewAttributes","loanId":"loan_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","marketplaceId":"mktp_9f2Kd8QpLzXw","customerId":"cust_9f2Kd8QpLzXw","loanFacilityId":"lfac_9f2Kd8QpLzXw","loanProductId":"lprod_9f2Kd8QpLzXw","loanAgreementId":"lma_9f2Kd8QpLzXw","accountName":"Ada Lovelace","status":"Enabled","balances":{"type":"LoanBalancesAttributes","currency":"AUD","limit":500000,"used":1250,"available":1250,"reserved":1250,"pending":1250},"specification":{"type":"LoanSpecRealtimeSettlement","variableFee":12.5,"setting":"Manual"},"timeZone":"example","billingPaymentSourceId":"psrc_9f2Kd8QpLzXw","productLine":"CentralPay","metadata":{"yourKey":{}},"referenceLoanId":"your-own-reference","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"},"statementSettings":{"type":"LoanStatementSettingsConfigured","documents":[{"type":"LoanStatementDocumentSettingViewAttributes","format":"Csv","enabled":true,"schemaVersion":"example","channels":["Email"]}],"statementEmails":["ada@example.com"],"readyNoticeEmails":["ada@example.com"],"transferEncryption":{"type":"LoanStatementTransferEncryptionViewAttributes","method":"Zip","secretSet":true},"systemIntegrations":[{"type":"LoanStatementSystemIntegrationAttributes","sysCode":"example","formats":["Csv"],"enabled":true,"referenceCustomerId":"your-own-reference","isTest":true}],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `LoanUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LoanUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/LoanView","description":"The loan as it stands after the change."},"statementSettings":{"$ref":"#/components/schemas/LoanStatementSettings","description":"Present only where this patch replaced or cleared the statement settings: what they are now."}}},"LoanUpdateStatementSettings":{"title":"LoanUpdateStatementSettings","description":"Replace the loan's statement settings whole, keeping only the system integrations. Recipients and the secret apply to the next mail sent; which documents are produced, and whether each is mailed, applies to statements generated afterwards. A refusal names its field from this body, `statementSettings.documents[1].format`. Settings imported from APG with `,`-joined or malformed addresses read back as stored, and sending them back unchanged is refused until they are corrected. A new secret answers 503 while the platform's encryption key is not configured; two first writes at once answer 409 to the later. Edge's `ReplaceLoanStatementSettings`.","examples":[{"type":"LoanUpdateStatementSettings","statementSettings":{"type":"LoanStatementSettingsReplacementAttributes","documents":[{"type":"LoanStatementDocumentSettingAttributes","format":"Csv","enabled":true,"schemaVersion":"example","channels":["Email"]}],"statementEmails":["ada@example.com"],"readyNoticeEmails":["ada@example.com"],"transferEncryption":{"type":"LoanStatementTransferEncryptionKeep","method":"Zip"}}}],"type":"object","required":["type","statementSettings"],"properties":{"type":{"description":"Always `LoanUpdateStatementSettings`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LoanUpdateStatementSettings"]},"statementSettings":{"$ref":"#/components/schemas/LoanStatementSettingsReplacement"}}},"LoanUpdateTradingAccount":{"title":"LoanUpdateTradingAccount","description":"Change the terms of a trading account a customer draws against. Only for that kind of loan.","examples":[{"type":"LoanUpdateTradingAccount","currency":"AUD","maxLimit":500000,"customerFees":{"type":"LprodCustomerFeesAttributes","currency":"AUD","annualFixedFee":1250,"implementationFixedFee":1250,"extendedPaymentTermsVariableFee":12.5,"latePaymentFee":{"type":"LprodLatePaymentFeeAttributes","monthlyRate":0.9412,"minimumFee":1250,"graceDays":1250},"customerTransactionVariableFee":12.5},"statementFrequency":{"type":"LprodFrequencyDaily"},"graceDays":1250,"industryGroup":"Travel","metadataTemplate":{"type":"LoanMetadataTemplateAttributes","validations":[{"type":"LoanMetadataFieldAttributes","path":"additionalMetaData.dbiInfo.dbiAu","validator":{"type":"LoanMetadataValidatorAttributes","name":"Ada Lovelace","statementConstraint":{"type":"LoanMetadataDaysRequiredWithin","days":1250},"transactionConstraint":{"type":"LoanMetadataDaysRequiredWithin","days":1250},"minLength":1250,"maxLength":1250,"format":"Alphanumeric"}}]}}],"type":"object","required":["type","currency"],"properties":{"type":{"description":"Always `LoanUpdateTradingAccount`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LoanUpdateTradingAccount"]},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"maxLimit":{"$ref":"#/components/schemas/MinorUnits","description":"An amount in the minor units of the currency given by the enclosing object's `currency` field."},"customerFees":{"$ref":"#/components/schemas/LprodCustomerFees","description":"The fees charged to a customer on this product."},"statementFrequency":{"$ref":"#/components/schemas/LprodFrequency"},"graceDays":{"type":"integer","format":"int32"},"industryGroup":{"$ref":"#/components/schemas/LoanIndustryGroup"},"metadataTemplate":{"$ref":"#/components/schemas/LoanMetadataTemplate","description":"Replaces the loan's metadata template whole. Omit to leave it as it is. A different template checks again, at the next hourly run, each of the loan's transactions with a charge or refund not yet on a statement."}}},"LoanView":{"oneOf":[{"$ref":"#/components/schemas/LoanViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LoanViewAttributes":"#/components/schemas/LoanViewAttributes"}}},"LoanViewAttributes":{"title":"LoanViewAttributes","description":"A loan, a revolving facility a borrower draws against.","examples":[{"type":"LoanViewAttributes","loanId":"loan_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","marketplaceId":"mktp_9f2Kd8QpLzXw","customerId":"cust_9f2Kd8QpLzXw","loanFacilityId":"lfac_9f2Kd8QpLzXw","loanProductId":"lprod_9f2Kd8QpLzXw","loanAgreementId":"lma_9f2Kd8QpLzXw","accountName":"Ada Lovelace","status":"Enabled","balances":{"type":"LoanBalancesAttributes","currency":"AUD","limit":500000,"used":1250,"available":1250,"reserved":1250,"pending":1250},"specification":{"type":"LoanSpecRealtimeSettlement","variableFee":12.5,"setting":"Manual"},"timeZone":"example","billingPaymentSourceId":"psrc_9f2Kd8QpLzXw","productLine":"CentralPay","metadata":{"yourKey":{}},"referenceLoanId":"your-own-reference","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","loanId","merchantId","loanFacilityId","loanProductId","accountName","status","balances","specification","timeZone","createdAt","updatedAt"],"properties":{"type":{"description":"Always `LoanViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LoanViewAttributes"]},"loanId":{"$ref":"#/components/schemas/LoanId","description":"Identifier of a loan."},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"The merchant borrowing."},"marketplaceId":{"$ref":"#/components/schemas/MktpId","description":"The marketplace the borrowing merchant trades under, where it does."},"customerId":{"$ref":"#/components/schemas/CustId","description":"The customer borrowing, on a trading-account loan. A real-time-settlement loan has no customer."},"loanFacilityId":{"$ref":"#/components/schemas/LfacId"},"loanProductId":{"$ref":"#/components/schemas/LprodId"},"loanAgreementId":{"$ref":"#/components/schemas/LmaId","description":"The master agreement this loan draws under, where the product uses one."},"accountName":{"description":"What the loan account is called on statements.","type":"string"},"status":{"$ref":"#/components/schemas/LoanStatus"},"balances":{"$ref":"#/components/schemas/LoanBalances","description":"The balances on a loan. All are in the single currency given here."},"specification":{"$ref":"#/components/schemas/LoanSpec"},"timeZone":{"description":"IANA time zone the loan's statement periods are measured in.","type":"string"},"billingPaymentSourceId":{"$ref":"#/components/schemas/PsrcId","description":"The payment source automated billing is charged to."},"productLine":{"$ref":"#/components/schemas/LoanProductLine","description":"APG's product line, which picks the account a bank-transfer statement asks to be paid into. Absent until set, on the application or with `LoanUpdateProductLine`."},"metadata":{"$ref":"#/components/schemas/Metadata","description":"Free-form data the platform stores and returns untouched."},"referenceLoanId":{"description":"The caller's own reference for this loan.","type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"LprodCmd":{"oneOf":[{"$ref":"#/components/schemas/LprodCmdCreate"}],"discriminator":{"propertyName":"type","mapping":{"LprodCmdCreate":"#/components/schemas/LprodCmdCreate"}}},"LprodCmdCreate":{"title":"LprodCmdCreate","description":"Create a loan product against a facility.","examples":[{"type":"LprodCmdCreate","loanFacilityId":"lfac_9f2Kd8QpLzXw","description":"A short description.","currency":"AUD","specification":{"type":"LprodSpecRealtimeSettlement","variableFee":12.5}}],"type":"object","required":["type","loanFacilityId","description","currency","specification"],"properties":{"type":{"description":"Always `LprodCmdCreate`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LprodCmdCreate"]},"loanFacilityId":{"$ref":"#/components/schemas/LfacId"},"description":{"type":"string"},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"specification":{"$ref":"#/components/schemas/LprodSpec"}}},"LprodColumn":{"title":"LprodColumn","type":"string","enum":["LoanProductId","LoanFacilityId","EnterpriseId","Description","Currency","Status","ProductType","CreatedAt","UpdatedAt"]},"LprodCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/LprodCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LprodCreateRspAttributes":"#/components/schemas/LprodCreateRspAttributes"}}},"LprodCreateRspAttributes":{"title":"LprodCreateRspAttributes","examples":[{"type":"LprodCreateRspAttributes","created":{"type":"LprodViewAttributes","loanProductId":"lprod_9f2Kd8QpLzXw","loanFacilityId":"lfac_9f2Kd8QpLzXw","enterpriseId":"ent_9f2Kd8QpLzXw","description":"A short description.","currency":"AUD","status":"Enabled","productType":"RealtimeSettlement","specification":{"type":"LprodSpecRealtimeSettlement","variableFee":12.5},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `LprodCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LprodCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/LprodView","description":"The resource that was created."}}},"LprodCustomerFees":{"oneOf":[{"$ref":"#/components/schemas/LprodCustomerFeesAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LprodCustomerFeesAttributes":"#/components/schemas/LprodCustomerFeesAttributes"}}},"LprodCustomerFeesAttributes":{"title":"LprodCustomerFeesAttributes","description":"The fees charged to a customer on this product.","examples":[{"type":"LprodCustomerFeesAttributes","currency":"AUD","annualFixedFee":1250,"implementationFixedFee":1250,"extendedPaymentTermsVariableFee":12.5,"latePaymentFee":{"type":"LprodLatePaymentFeeAttributes","monthlyRate":0.9412,"minimumFee":1250,"graceDays":1250},"customerTransactionVariableFee":12.5}],"type":"object","required":["type","currency","annualFixedFee"],"properties":{"type":{"description":"Always `LprodCustomerFeesAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LprodCustomerFeesAttributes"]},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"annualFixedFee":{"$ref":"#/components/schemas/MinorUnits","description":"Charged to the account annually."},"implementationFixedFee":{"$ref":"#/components/schemas/MinorUnits","description":"Charged once, when the loan is established."},"extendedPaymentTermsVariableFee":{"description":"Charged on each statement for extended payment terms, on the charges since the last one, as a decimal, `0.01` is 1%.","type":"number"},"latePaymentFee":{"$ref":"#/components/schemas/LprodLatePaymentFee","description":"Charged on each statement for every earlier statement left overdue. Absent, a loan update keeps the late fee the loan has and a new loan takes its product's; a `monthlyRate` and `minimumFee` of 0 charge no late fee."},"customerTransactionVariableFee":{"description":"Charged on each statement for its payment terms, on the charges since the last one, as a decimal up to `0.1`, `0.01` is 1%. Absent, a loan update keeps the fee the loan has and a new loan takes its product's; 0 charges no fee.","type":"number"}}},"LprodDayOfWeek":{"title":"LprodDayOfWeek","type":"string","enum":["Monday","Tuesday","Wednesday","Thursday","Friday","Unknown"]},"LprodFrequency":{"oneOf":[{"$ref":"#/components/schemas/LprodFrequencyDaily"},{"$ref":"#/components/schemas/LprodFrequencyFortnightly"},{"$ref":"#/components/schemas/LprodFrequencyMonthly"},{"$ref":"#/components/schemas/LprodFrequencyWeekly"}],"discriminator":{"propertyName":"type","mapping":{"LprodFrequencyDaily":"#/components/schemas/LprodFrequencyDaily","LprodFrequencyFortnightly":"#/components/schemas/LprodFrequencyFortnightly","LprodFrequencyMonthly":"#/components/schemas/LprodFrequencyMonthly","LprodFrequencyWeekly":"#/components/schemas/LprodFrequencyWeekly"}}},"LprodFrequencyDaily":{"title":"LprodFrequencyDaily","description":"A statement each day. Carries no issue day, because every day is one.","examples":[{"type":"LprodFrequencyDaily"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `LprodFrequencyDaily`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LprodFrequencyDaily"]}}},"LprodFrequencyFortnightly":{"title":"LprodFrequencyFortnightly","description":"A statement every second week, issued on this day of the week.","examples":[{"type":"LprodFrequencyFortnightly","issueDayOfWeek":"Monday"}],"type":"object","required":["type","issueDayOfWeek"],"properties":{"type":{"description":"Always `LprodFrequencyFortnightly`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LprodFrequencyFortnightly"]},"issueDayOfWeek":{"$ref":"#/components/schemas/LprodDayOfWeek"}}},"LprodFrequencyMonthly":{"title":"LprodFrequencyMonthly","description":"A statement each month, issued on this day of the month.","examples":[{"type":"LprodFrequencyMonthly","issueDayOfMonth":6}],"type":"object","required":["type","issueDayOfMonth"],"properties":{"type":{"description":"Always `LprodFrequencyMonthly`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LprodFrequencyMonthly"]},"issueDayOfMonth":{"type":"integer","format":"int32"}}},"LprodFrequencyWeekly":{"title":"LprodFrequencyWeekly","description":"A statement each week, issued on this day of the week.","examples":[{"type":"LprodFrequencyWeekly","issueDayOfWeek":"Monday"}],"type":"object","required":["type","issueDayOfWeek"],"properties":{"type":{"description":"Always `LprodFrequencyWeekly`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LprodFrequencyWeekly"]},"issueDayOfWeek":{"$ref":"#/components/schemas/LprodDayOfWeek"}}},"LprodId":{"title":"LprodId","description":"Identifier of a loan product.","examples":["lprod_9f2Kd8QpLzXw"],"type":"string"},"LprodLatePaymentFee":{"oneOf":[{"$ref":"#/components/schemas/LprodLatePaymentFeeAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LprodLatePaymentFeeAttributes":"#/components/schemas/LprodLatePaymentFeeAttributes"}}},"LprodLatePaymentFeeAttributes":{"title":"LprodLatePaymentFeeAttributes","description":"For each overdue statement on each statement run, the greater of `minimumFee` and the overdue amount × `monthlyRate` ÷ 30 × the days overdue. A statement paid within `graceDays` of its due date is charged nothing; one paid later is charged from its due date.","examples":[{"type":"LprodLatePaymentFeeAttributes","monthlyRate":0.9412,"minimumFee":1250,"graceDays":1250}],"type":"object","required":["type","monthlyRate","minimumFee","graceDays"],"properties":{"type":{"description":"Always `LprodLatePaymentFeeAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LprodLatePaymentFeeAttributes"]},"monthlyRate":{"description":"The monthly rate, as a decimal, `0.02` is 2% a month.","type":"number"},"minimumFee":{"$ref":"#/components/schemas/MinorUnits","description":"The least fee charged for an overdue statement on a statement run."},"graceDays":{"description":"Days after a statement falls due it may be paid without a late fee.","type":"integer","format":"int32"}}},"LprodLimits":{"description":"The limits loans on this product are written within.","oneOf":[{"$ref":"#/components/schemas/LprodLimitsAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LprodLimitsAttributes":"#/components/schemas/LprodLimitsAttributes"}}},"LprodLimitsAttributes":{"title":"LprodLimitsAttributes","description":"The limits loans on this product are written within.","examples":[{"type":"LprodLimitsAttributes","currency":"AUD","minLoanLimit":500000,"maxLoanLimit":500000}],"type":"object","required":["type","currency"],"properties":{"type":{"description":"Always `LprodLimitsAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LprodLimitsAttributes"]},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"minLoanLimit":{"$ref":"#/components/schemas/MinorUnits","description":"Smallest limit a loan on this product may carry."},"maxLoanLimit":{"$ref":"#/components/schemas/MinorUnits","description":"Largest limit a loan on this product may carry."}}},"LprodPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/LprodPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LprodPageAttributes":"#/components/schemas/LprodPageAttributes"}}},"LprodPageAttributes":{"title":"LprodPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"LprodPageAttributes","data":[{"type":"LprodViewAttributes","loanProductId":"lprod_9f2Kd8QpLzXw","loanFacilityId":"lfac_9f2Kd8QpLzXw","enterpriseId":"ent_9f2Kd8QpLzXw","description":"A short description.","currency":"AUD","status":"Enabled","productType":"RealtimeSettlement","specification":{"type":"LprodSpecRealtimeSettlement","variableFee":12.5},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `LprodPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LprodPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/LprodView","description":"The terms loans are written on, fees, statement frequency and limits, funded by one facility."}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"LprodSort":{"title":"LprodSort","type":"string","enum":["createdAt","-createdAt","updatedAt","-updatedAt"]},"LprodSpec":{"oneOf":[{"$ref":"#/components/schemas/LprodSpecRealtimeSettlement"},{"$ref":"#/components/schemas/LprodSpecTradingAccount"}],"discriminator":{"propertyName":"type","mapping":{"LprodSpecRealtimeSettlement":"#/components/schemas/LprodSpecRealtimeSettlement","LprodSpecTradingAccount":"#/components/schemas/LprodSpecTradingAccount"}}},"LprodSpecRealtimeSettlement":{"title":"LprodSpecRealtimeSettlement","description":"Funds a merchant's settlement in real time, charging a rate on the payments it settles.","examples":[{"type":"LprodSpecRealtimeSettlement","variableFee":12.5}],"type":"object","required":["type","variableFee"],"properties":{"type":{"description":"Always `LprodSpecRealtimeSettlement`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LprodSpecRealtimeSettlement"]},"variableFee":{"description":"Charged on payments that use the real-time settlement service, as a decimal.","type":"number"}}},"LprodSpecTradingAccount":{"title":"LprodSpecTradingAccount","description":"A revolving trading account a customer draws against and repays on statement.","examples":[{"type":"LprodSpecTradingAccount","allowCreditBasedRepayments":true,"defaultStatementFrequency":{"type":"LprodFrequencyDaily"},"defaultGraceDays":1250,"defaultCustomerFees":{"type":"LprodCustomerFeesAttributes","currency":"AUD","annualFixedFee":1250,"implementationFixedFee":1250,"extendedPaymentTermsVariableFee":12.5,"latePaymentFee":{"type":"LprodLatePaymentFeeAttributes","monthlyRate":0.9412,"minimumFee":1250,"graceDays":1250},"customerTransactionVariableFee":12.5},"originationVariableFee":12.5,"limits":{"type":"LprodLimitsAttributes","currency":"AUD","minLoanLimit":500000,"maxLoanLimit":500000}}],"type":"object","required":["type","allowCreditBasedRepayments","defaultStatementFrequency","defaultGraceDays","defaultCustomerFees","originationVariableFee","limits"],"properties":{"type":{"description":"Always `LprodSpecTradingAccount`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LprodSpecTradingAccount"]},"allowCreditBasedRepayments":{"description":"Whether credit may be used to pay this loan off.","type":"boolean"},"defaultStatementFrequency":{"$ref":"#/components/schemas/LprodFrequency"},"defaultGraceDays":{"description":"Days between a statement being issued and falling due.","type":"integer","format":"int32"},"defaultCustomerFees":{"$ref":"#/components/schemas/LprodCustomerFees","description":"The fees charged to a customer on this product."},"originationVariableFee":{"description":"Charged on origination, as a decimal.","type":"number"},"limits":{"$ref":"#/components/schemas/LprodLimits"}}},"LprodStatus":{"title":"LprodStatus","type":"string","enum":["Enabled","Disabled","Unknown"]},"LprodType":{"title":"LprodType","type":"string","enum":["RealtimeSettlement","TradingAccount","Unknown"]},"LprodUpdate":{"description":"Change a loan product's limits and the late fee new loans take. Omitted fields are left as they are.","oneOf":[{"$ref":"#/components/schemas/LprodUpdateAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LprodUpdateAttributes":"#/components/schemas/LprodUpdateAttributes"}}},"LprodUpdateAttributes":{"title":"LprodUpdateAttributes","description":"Change a loan product's limits and the late fee new loans take. Omitted fields are left as they are.","examples":[{"type":"LprodUpdateAttributes","limits":{"type":"LprodLimitsAttributes","currency":"AUD","minLoanLimit":500000,"maxLoanLimit":500000},"defaultLatePaymentFee":{"type":"LprodLatePaymentFeeAttributes","monthlyRate":0.9412,"minimumFee":1250,"graceDays":1250}}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `LprodUpdateAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LprodUpdateAttributes"]},"limits":{"$ref":"#/components/schemas/LprodLimits"},"defaultLatePaymentFee":{"$ref":"#/components/schemas/LprodLatePaymentFee","description":"The late fee new loans of this product take. A `monthlyRate` and `minimumFee` of 0 turn it off."}}},"LprodUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/LprodUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LprodUpdateRspAttributes":"#/components/schemas/LprodUpdateRspAttributes"}}},"LprodUpdateRspAttributes":{"title":"LprodUpdateRspAttributes","examples":[{"type":"LprodUpdateRspAttributes","updated":{"type":"LprodViewAttributes","loanProductId":"lprod_9f2Kd8QpLzXw","loanFacilityId":"lfac_9f2Kd8QpLzXw","enterpriseId":"ent_9f2Kd8QpLzXw","description":"A short description.","currency":"AUD","status":"Enabled","productType":"RealtimeSettlement","specification":{"type":"LprodSpecRealtimeSettlement","variableFee":12.5},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `LprodUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LprodUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/LprodView","description":"The resource as it stands after the change."}}},"LprodView":{"oneOf":[{"$ref":"#/components/schemas/LprodViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LprodViewAttributes":"#/components/schemas/LprodViewAttributes"}}},"LprodViewAttributes":{"title":"LprodViewAttributes","description":"The terms loans are written on, fees, statement frequency and limits, funded by one facility.","examples":[{"type":"LprodViewAttributes","loanProductId":"lprod_9f2Kd8QpLzXw","loanFacilityId":"lfac_9f2Kd8QpLzXw","enterpriseId":"ent_9f2Kd8QpLzXw","description":"A short description.","currency":"AUD","status":"Enabled","productType":"RealtimeSettlement","specification":{"type":"LprodSpecRealtimeSettlement","variableFee":12.5},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","loanProductId","loanFacilityId","enterpriseId","description","currency","status","productType","specification","createdAt","updatedAt"],"properties":{"type":{"description":"Always `LprodViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LprodViewAttributes"]},"loanProductId":{"$ref":"#/components/schemas/LprodId"},"loanFacilityId":{"$ref":"#/components/schemas/LfacId"},"enterpriseId":{"$ref":"#/components/schemas/EntId","description":"The enterprise that owns this product."},"description":{"type":"string"},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"status":{"$ref":"#/components/schemas/LprodStatus"},"productType":{"$ref":"#/components/schemas/LprodType","description":"Which kind of product this is. The same distinction `specification` carries, as a value you can filter on."},"specification":{"$ref":"#/components/schemas/LprodSpec"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"LstmtAmounts":{"description":"The amounts on a loan statement. All are in the single currency given here.","oneOf":[{"$ref":"#/components/schemas/LstmtAmountsAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LstmtAmountsAttributes":"#/components/schemas/LstmtAmountsAttributes"}}},"LstmtAmountsAttributes":{"title":"LstmtAmountsAttributes","description":"The amounts on a loan statement. All are in the single currency given here.","examples":[{"type":"LstmtAmountsAttributes","currency":"AUD","net":1250,"insurance":1250,"tax":1250,"billed":1250,"fees":1250,"paid":1250,"outstanding":1250,"credited":1250}],"type":"object","required":["type","currency","net","insurance","tax","billed","outstanding"],"properties":{"type":{"description":"Always `LstmtAmountsAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LstmtAmountsAttributes"]},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"net":{"$ref":"#/components/schemas/MinorUnits","description":"Everything but insurance, before tax."},"insurance":{"$ref":"#/components/schemas/MinorUnits","description":"Insurance entries, before tax."},"tax":{"$ref":"#/components/schemas/MinorUnits","description":"Tax over every entry."},"billed":{"$ref":"#/components/schemas/MinorUnits","description":"Total due on the statement, excluding late fees."},"fees":{"$ref":"#/components/schemas/MinorUnits","description":"Fees on the statement, including tax on them."},"paid":{"$ref":"#/components/schemas/MinorUnits","description":"Paid towards the statement so far."},"outstanding":{"$ref":"#/components/schemas/MinorUnits","description":"Still to be paid, including late fees. Negative means the statement is in credit."},"credited":{"$ref":"#/components/schemas/MinorUnits","description":"Where a statement ended in credit, how much of that credit has gone to other statements."}}},"LstmtCmd":{"oneOf":[{"$ref":"#/components/schemas/LstmtCmdCreate"},{"$ref":"#/components/schemas/LstmtCmdCreateHistoric"}],"discriminator":{"propertyName":"type","mapping":{"LstmtCmdCreate":"#/components/schemas/LstmtCmdCreate","LstmtCmdCreateHistoric":"#/components/schemas/LstmtCmdCreateHistoric"}}},"LstmtCmdCreate":{"title":"LstmtCmdCreate","description":"Cut a statement for a loan's current period.","examples":[{"type":"LstmtCmdCreate","loanId":"loan_9f2Kd8QpLzXw"}],"type":"object","required":["type","loanId"],"properties":{"type":{"description":"Always `LstmtCmdCreate`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LstmtCmdCreate"]},"loanId":{"$ref":"#/components/schemas/LoanId","description":"Identifier of a loan."}}},"LstmtCmdCreateHistoric":{"title":"LstmtCmdCreateHistoric","description":"Recreate statements for a period already past, over a range of ledger entries.","examples":[{"type":"LstmtCmdCreateHistoric","loanId":"loan_9f2Kd8QpLzXw","ledgerSequenceFrom":1250,"ledgerSequenceTo":1250}],"type":"object","required":["type","loanId","ledgerSequenceFrom","ledgerSequenceTo"],"properties":{"type":{"description":"Always `LstmtCmdCreateHistoric`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LstmtCmdCreateHistoric"]},"loanId":{"$ref":"#/components/schemas/LoanId","description":"Identifier of a loan."},"ledgerSequenceFrom":{"description":"First ledger entry to include.","type":"integer","format":"int64"},"ledgerSequenceTo":{"description":"Last ledger entry to include.","type":"integer","format":"int64"}}},"LstmtColumn":{"title":"LstmtColumn","type":"string","enum":["LoanStatementId","LoanId","ReferenceStatementId","MerchantId","CustomerId","Status","PeriodStart","PeriodEnd","BillingDate","DueDate","AmountsCurrency","AmountsNet","AmountsInsurance","AmountsTax","AmountsBilled","AmountsFees","AmountsPaid","AmountsOutstanding","AmountsCredited","LateFeeAmountsCurrency","LateFeeAmountsTotal","LateFeeAmountsTax","LateFeeAmountsNet","LateFeeCalculatedTo","LateFeeNarrative","LinkedStatementId","Narrative","CreatedAt","UpdatedAt"]},"LstmtCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/LstmtCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LstmtCreateRspAttributes":"#/components/schemas/LstmtCreateRspAttributes"}}},"LstmtCreateRspAttributes":{"title":"LstmtCreateRspAttributes","examples":[{"type":"LstmtCreateRspAttributes","created":{"type":"LstmtViewAttributes","loanStatementId":"lstmt_9f2Kd8QpLzXw","loanId":"loan_9f2Kd8QpLzXw","referenceStatementId":"your-own-reference","merchantId":"mcht_9f2Kd8QpLzXw","customerId":"cust_9f2Kd8QpLzXw","status":"Draft","periodStart":"2026-08-19","periodEnd":"2026-08-19","billingDate":"2026-08-19","dueDate":"2026-08-19","statementFrequency":{"type":"LprodFrequencyDaily"},"amounts":{"type":"LstmtAmountsAttributes","currency":"AUD","net":1250,"insurance":1250,"tax":1250,"billed":1250,"fees":1250,"paid":1250,"outstanding":1250,"credited":1250},"entries":[{"type":"LstmtEntryAttributes","entryType":"Charge","description":"A short description.","amounts":{"type":"LstmtEntryAmountsAttributes","currency":"AUD","total":1250,"tax":1250,"net":1250},"taxRate":0.9412,"taxType":"example","originalAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"loanTransactionId":"ltxn_9f2Kd8QpLzXw","entryAt":"2026-08-19T04:21:07Z"}],"lateFee":{"type":"LstmtLateFeeAttributes","amounts":{"type":"LstmtEntryAmountsAttributes","currency":"AUD","total":1250,"tax":1250,"net":1250},"calculatedTo":"2026-08-19","narrative":"example"},"linkedStatementId":"lstmt_9f2Kd8QpLzXw","narrative":"example","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `LstmtCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LstmtCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/LstmtView","description":"The resource that was created."}}},"LstmtDocumentPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/LstmtDocumentPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LstmtDocumentPageAttributes":"#/components/schemas/LstmtDocumentPageAttributes"}}},"LstmtDocumentPageAttributes":{"title":"LstmtDocumentPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"LstmtDocumentPageAttributes","data":[{"type":"SdocViewAttributes","statementDocumentId":"sdoc_9f2Kd8QpLzXw","format":"Csv","status":"Pending","fileName":"Ada Lovelace","sizeBytes":1250,"expiresAt":"2026-08-19T04:21:07Z","errorMessage":"example","attempts":1250,"email":{"type":"SdocDeliveryAttributes","status":"Pending","attempts":1250,"sentAt":"2026-08-19T04:21:07Z","error":"example"},"readyNotice":{"type":"SdocDeliveryAttributes","status":"Pending","attempts":1250,"sentAt":"2026-08-19T04:21:07Z","error":"example"},"origin":"Generated","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `LstmtDocumentPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LstmtDocumentPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/SdocView"}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"LstmtEntry":{"description":"A line on a loan statement.","oneOf":[{"$ref":"#/components/schemas/LstmtEntryAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LstmtEntryAttributes":"#/components/schemas/LstmtEntryAttributes"}}},"LstmtEntryAmounts":{"oneOf":[{"$ref":"#/components/schemas/LstmtEntryAmountsAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LstmtEntryAmountsAttributes":"#/components/schemas/LstmtEntryAmountsAttributes"}}},"LstmtEntryAmountsAttributes":{"title":"LstmtEntryAmountsAttributes","description":"A statement line's total and the tax within it. Both are in the single currency given here.","examples":[{"type":"LstmtEntryAmountsAttributes","currency":"AUD","total":1250,"tax":1250,"net":1250}],"type":"object","required":["type","currency","total","tax","net"],"properties":{"type":{"description":"Always `LstmtEntryAmountsAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LstmtEntryAmountsAttributes"]},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"total":{"$ref":"#/components/schemas/MinorUnits","description":"The line's total, tax included."},"tax":{"$ref":"#/components/schemas/MinorUnits","description":"The tax within the total."},"net":{"$ref":"#/components/schemas/MinorUnits","description":"The total before tax. `total` − `tax`."}}},"LstmtEntryAttributes":{"title":"LstmtEntryAttributes","description":"A line on a loan statement.","examples":[{"type":"LstmtEntryAttributes","entryType":"Charge","description":"A short description.","amounts":{"type":"LstmtEntryAmountsAttributes","currency":"AUD","total":1250,"tax":1250,"net":1250},"taxRate":0.9412,"taxType":"example","originalAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"loanTransactionId":"ltxn_9f2Kd8QpLzXw","entryAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","entryType","description","amounts","entryAt"],"properties":{"type":{"description":"Always `LstmtEntryAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LstmtEntryAttributes"]},"entryType":{"$ref":"#/components/schemas/LtxnEntryType","description":"What kind of line this is."},"description":{"type":"string"},"amounts":{"$ref":"#/components/schemas/LstmtEntryAmounts","description":"A statement line's total and the tax within it. Both are in the single currency given here."},"taxRate":{"description":"The rate the tax was charged at, as a decimal, `0.1` is 10%.","type":"number"},"taxType":{"description":"What the tax is called, `GST`.","type":"string"},"originalAmount":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"The amount before currency conversion, where the movement was converted. Genuinely in another currency, so it carries its own."},"loanTransactionId":{"$ref":"#/components/schemas/LtxnId","description":"The movement this line came from, where a line has one. Generated fees do not."},"entryAt":{"description":"When the movement this line records happened.","type":"string","format":"date-time"}}},"LstmtId":{"title":"LstmtId","examples":["lstmt_9f2Kd8QpLzXw"],"type":"string"},"LstmtLateFee":{"description":"The late-payment fee charged on this statement, where one has been.","oneOf":[{"$ref":"#/components/schemas/LstmtLateFeeAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LstmtLateFeeAttributes":"#/components/schemas/LstmtLateFeeAttributes"}}},"LstmtLateFeeAttributes":{"title":"LstmtLateFeeAttributes","description":"The late-payment fee charged on a statement.","examples":[{"type":"LstmtLateFeeAttributes","amounts":{"type":"LstmtEntryAmountsAttributes","currency":"AUD","total":1250,"tax":1250,"net":1250},"calculatedTo":"2026-08-19","narrative":"example"}],"type":"object","required":["type","amounts"],"properties":{"type":{"description":"Always `LstmtLateFeeAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LstmtLateFeeAttributes"]},"amounts":{"$ref":"#/components/schemas/LstmtEntryAmounts","description":"A statement line's total and the tax within it. Both are in the single currency given here."},"calculatedTo":{"description":"The date the fee has been calculated up to. It grows until the statement is paid.","type":"string","format":"date"},"narrative":{"description":"An internal note on how the fee was worked out.","type":"string"}}},"LstmtPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/LstmtPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LstmtPageAttributes":"#/components/schemas/LstmtPageAttributes"}}},"LstmtPageAttributes":{"title":"LstmtPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"LstmtPageAttributes","data":[{"type":"LstmtViewAttributes","loanStatementId":"lstmt_9f2Kd8QpLzXw","loanId":"loan_9f2Kd8QpLzXw","referenceStatementId":"your-own-reference","merchantId":"mcht_9f2Kd8QpLzXw","customerId":"cust_9f2Kd8QpLzXw","status":"Draft","periodStart":"2026-08-19","periodEnd":"2026-08-19","billingDate":"2026-08-19","dueDate":"2026-08-19","statementFrequency":{"type":"LprodFrequencyDaily"},"amounts":{"type":"LstmtAmountsAttributes","currency":"AUD","net":1250,"insurance":1250,"tax":1250,"billed":1250,"fees":1250,"paid":1250,"outstanding":1250,"credited":1250},"entries":[{"type":"LstmtEntryAttributes","entryType":"Charge","description":"A short description.","amounts":{"type":"LstmtEntryAmountsAttributes","currency":"AUD","total":1250,"tax":1250,"net":1250},"taxRate":0.9412,"taxType":"example","originalAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"loanTransactionId":"ltxn_9f2Kd8QpLzXw","entryAt":"2026-08-19T04:21:07Z"}],"lateFee":{"type":"LstmtLateFeeAttributes","amounts":{"type":"LstmtEntryAmountsAttributes","currency":"AUD","total":1250,"tax":1250,"net":1250},"calculatedTo":"2026-08-19","narrative":"example"},"linkedStatementId":"lstmt_9f2Kd8QpLzXw","narrative":"example","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `LstmtPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LstmtPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/LstmtView","description":"A loan statement for one period."}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"LstmtRecalculation":{"description":"How to recompute a statement's totals.","oneOf":[{"$ref":"#/components/schemas/LstmtRecalculationAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LstmtRecalculationAttributes":"#/components/schemas/LstmtRecalculationAttributes"}}},"LstmtRecalculationAttributes":{"title":"LstmtRecalculationAttributes","description":"How to recompute a statement's totals.","examples":[{"type":"LstmtRecalculationAttributes","useLineItems":true,"includeAdjustments":true,"isLateFeeStatement":true}],"type":"object","required":["type","useLineItems","includeAdjustments"],"properties":{"type":{"description":"Always `LstmtRecalculationAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LstmtRecalculationAttributes"]},"useLineItems":{"description":"Total the statement's line items rather than the amounts stored on each movement. The two differ once a movement has been adjusted.","type":"boolean"},"includeAdjustments":{"description":"Include adjustments made after the statement was issued. Excluding them keeps a post-issue correction off the borrower's copy.","type":"boolean"},"isLateFeeStatement":{"description":"Treat this statement as an invoice for late fees.","type":"boolean"}}},"LstmtSort":{"title":"LstmtSort","type":"string","enum":["createdAt","-createdAt","dueDate","-dueDate"]},"LstmtStatus":{"title":"LstmtStatus","type":"string","enum":["Draft","Outstanding","Due","Overdue","Paid","Defaulted","Cancelled","Unknown"]},"LstmtUpdate":{"oneOf":[{"$ref":"#/components/schemas/LstmtUpdateCancelLateFee"},{"$ref":"#/components/schemas/LstmtUpdateCancelLatest"},{"$ref":"#/components/schemas/LstmtUpdateCreditPayment"},{"$ref":"#/components/schemas/LstmtUpdateGenerateDocuments"},{"$ref":"#/components/schemas/LstmtUpdateIssue"},{"$ref":"#/components/schemas/LstmtUpdateRecalculate"},{"$ref":"#/components/schemas/LstmtUpdateRegenerateDocuments"},{"$ref":"#/components/schemas/LstmtUpdateRegenerateReference"},{"$ref":"#/components/schemas/LstmtUpdateResendEmails"},{"$ref":"#/components/schemas/LstmtUpdateSendEmails"},{"$ref":"#/components/schemas/LstmtUpdateSetBillingDate"}],"discriminator":{"propertyName":"type","mapping":{"LstmtUpdateCancelLateFee":"#/components/schemas/LstmtUpdateCancelLateFee","LstmtUpdateCancelLatest":"#/components/schemas/LstmtUpdateCancelLatest","LstmtUpdateCreditPayment":"#/components/schemas/LstmtUpdateCreditPayment","LstmtUpdateGenerateDocuments":"#/components/schemas/LstmtUpdateGenerateDocuments","LstmtUpdateIssue":"#/components/schemas/LstmtUpdateIssue","LstmtUpdateRecalculate":"#/components/schemas/LstmtUpdateRecalculate","LstmtUpdateRegenerateDocuments":"#/components/schemas/LstmtUpdateRegenerateDocuments","LstmtUpdateRegenerateReference":"#/components/schemas/LstmtUpdateRegenerateReference","LstmtUpdateResendEmails":"#/components/schemas/LstmtUpdateResendEmails","LstmtUpdateSendEmails":"#/components/schemas/LstmtUpdateSendEmails","LstmtUpdateSetBillingDate":"#/components/schemas/LstmtUpdateSetBillingDate"}}},"LstmtUpdateCancelLateFee":{"title":"LstmtUpdateCancelLateFee","description":"Remove a late-payment fee charged on this statement.","examples":[{"type":"LstmtUpdateCancelLateFee"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `LstmtUpdateCancelLateFee`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LstmtUpdateCancelLateFee"]}}},"LstmtUpdateCancelLatest":{"title":"LstmtUpdateCancelLatest","description":"Cancel the loan's latest statement. Its movements are billed again on the next statement and the balances do not change. Edge's `CancelLatestStatement`.","examples":[{"type":"LstmtUpdateCancelLatest"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `LstmtUpdateCancelLatest`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LstmtUpdateCancelLatest"]}}},"LstmtUpdateCreditPayment":{"title":"LstmtUpdateCreditPayment","description":"Credit a payment received outside the platform against this statement. Edge's `RecordLoanStatementManualPayment`.","examples":[{"type":"LstmtUpdateCreditPayment","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"paidOn":"2026-08-19"}],"type":"object","required":["type","amount"],"properties":{"type":{"description":"Always `LstmtUpdateCreditPayment`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LstmtUpdateCreditPayment"]},"amount":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"An amount in minor current units of a given currency."},"paidOn":{"description":"The day the payment was received, which late fees count overdue days to. Absent, today.","type":"string","format":"date"}}},"LstmtUpdateGenerateDocuments":{"title":"LstmtUpdateGenerateDocuments","description":"Render and store the documents this statement's download serves, where they are not generated yet; a failed one is retried until its attempt limit. Edge's `EnterpriseProcessStatementDocumentsRequest`, for one statement.","examples":[{"type":"LstmtUpdateGenerateDocuments"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `LstmtUpdateGenerateDocuments`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LstmtUpdateGenerateDocuments"]}}},"LstmtUpdateIssue":{"title":"LstmtUpdateIssue","description":"Issue a draft statement. The only transition available through the API, the rest follow from the billing run.","examples":[{"type":"LstmtUpdateIssue"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `LstmtUpdateIssue`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LstmtUpdateIssue"]}}},"LstmtUpdateRecalculate":{"title":"LstmtUpdateRecalculate","description":"Recompute the totals from the movements on the statement.","examples":[{"type":"LstmtUpdateRecalculate","recalculation":{"type":"LstmtRecalculationAttributes","useLineItems":true,"includeAdjustments":true,"isLateFeeStatement":true}}],"type":"object","required":["type","recalculation"],"properties":{"type":{"description":"Always `LstmtUpdateRecalculate`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LstmtUpdateRecalculate"]},"recalculation":{"$ref":"#/components/schemas/LstmtRecalculation"}}},"LstmtUpdateRegenerateDocuments":{"title":"LstmtUpdateRegenerateDocuments","description":"Have this statement's documents made again, by the sweep that makes them, as APG's back office does when it deletes a statement's files. Edge has no equivalent.","examples":[{"type":"LstmtUpdateRegenerateDocuments"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `LstmtUpdateRegenerateDocuments`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LstmtUpdateRegenerateDocuments"]}}},"LstmtUpdateRegenerateReference":{"title":"LstmtUpdateRegenerateReference","description":"Issue a fresh reference for this statement. Edge's `RegenerateReferenceStatementId`.","examples":[{"type":"LstmtUpdateRegenerateReference"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `LstmtUpdateRegenerateReference`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LstmtUpdateRegenerateReference"]}}},"LstmtUpdateResendEmails":{"title":"LstmtUpdateResendEmails","description":"E-mail this statement's generated documents to the given addresses, as APG's back-office Resend does. Sends even while delivery is switched off, spends no retry attempt, and fails unless every document was sent. Edge's `EnterpriseResendStatementEmailRequest`.","examples":[{"type":"LstmtUpdateResendEmails","recipients":["example"]}],"type":"object","required":["type","recipients"],"properties":{"type":{"description":"Always `LstmtUpdateResendEmails`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LstmtUpdateResendEmails"]},"recipients":{"description":"Where to send the documents. At least one address.","type":"array","minItems":1,"items":{"type":"string"}}}},"LstmtUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/LstmtUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LstmtUpdateRspAttributes":"#/components/schemas/LstmtUpdateRspAttributes"}}},"LstmtUpdateRspAttributes":{"title":"LstmtUpdateRspAttributes","examples":[{"type":"LstmtUpdateRspAttributes","updated":{"type":"LstmtViewAttributes","loanStatementId":"lstmt_9f2Kd8QpLzXw","loanId":"loan_9f2Kd8QpLzXw","referenceStatementId":"your-own-reference","merchantId":"mcht_9f2Kd8QpLzXw","customerId":"cust_9f2Kd8QpLzXw","status":"Draft","periodStart":"2026-08-19","periodEnd":"2026-08-19","billingDate":"2026-08-19","dueDate":"2026-08-19","statementFrequency":{"type":"LprodFrequencyDaily"},"amounts":{"type":"LstmtAmountsAttributes","currency":"AUD","net":1250,"insurance":1250,"tax":1250,"billed":1250,"fees":1250,"paid":1250,"outstanding":1250,"credited":1250},"entries":[{"type":"LstmtEntryAttributes","entryType":"Charge","description":"A short description.","amounts":{"type":"LstmtEntryAmountsAttributes","currency":"AUD","total":1250,"tax":1250,"net":1250},"taxRate":0.9412,"taxType":"example","originalAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"loanTransactionId":"ltxn_9f2Kd8QpLzXw","entryAt":"2026-08-19T04:21:07Z"}],"lateFee":{"type":"LstmtLateFeeAttributes","amounts":{"type":"LstmtEntryAmountsAttributes","currency":"AUD","total":1250,"tax":1250,"net":1250},"calculatedTo":"2026-08-19","narrative":"example"},"linkedStatementId":"lstmt_9f2Kd8QpLzXw","narrative":"example","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `LstmtUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LstmtUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/LstmtView","description":"The resource as it stands after the change."}}},"LstmtUpdateSendEmails":{"title":"LstmtUpdateSendEmails","description":"Send the statement e-mails this statement's generated documents still owe. Does nothing while statement e-mail delivery is switched off for the environment. Edge's `EnterpriseProcessStatementEmailsRequest`, for one statement.","examples":[{"type":"LstmtUpdateSendEmails"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `LstmtUpdateSendEmails`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LstmtUpdateSendEmails"]}}},"LstmtUpdateSetBillingDate":{"title":"LstmtUpdateSetBillingDate","description":"Move the date the statement is billed on. Edge's `ResetBillingDateOnStatement`.","examples":[{"type":"LstmtUpdateSetBillingDate","billingDate":"2026-08-19"}],"type":"object","required":["type","billingDate"],"properties":{"type":{"description":"Always `LstmtUpdateSetBillingDate`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LstmtUpdateSetBillingDate"]},"billingDate":{"type":"string","format":"date"}}},"LstmtView":{"oneOf":[{"$ref":"#/components/schemas/LstmtViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LstmtViewAttributes":"#/components/schemas/LstmtViewAttributes"}}},"LstmtViewAttributes":{"title":"LstmtViewAttributes","description":"A loan statement for one period.","examples":[{"type":"LstmtViewAttributes","loanStatementId":"lstmt_9f2Kd8QpLzXw","loanId":"loan_9f2Kd8QpLzXw","referenceStatementId":"your-own-reference","merchantId":"mcht_9f2Kd8QpLzXw","customerId":"cust_9f2Kd8QpLzXw","status":"Draft","periodStart":"2026-08-19","periodEnd":"2026-08-19","billingDate":"2026-08-19","dueDate":"2026-08-19","statementFrequency":{"type":"LprodFrequencyDaily"},"amounts":{"type":"LstmtAmountsAttributes","currency":"AUD","net":1250,"insurance":1250,"tax":1250,"billed":1250,"fees":1250,"paid":1250,"outstanding":1250,"credited":1250},"entries":[{"type":"LstmtEntryAttributes","entryType":"Charge","description":"A short description.","amounts":{"type":"LstmtEntryAmountsAttributes","currency":"AUD","total":1250,"tax":1250,"net":1250},"taxRate":0.9412,"taxType":"example","originalAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"loanTransactionId":"ltxn_9f2Kd8QpLzXw","entryAt":"2026-08-19T04:21:07Z"}],"lateFee":{"type":"LstmtLateFeeAttributes","amounts":{"type":"LstmtEntryAmountsAttributes","currency":"AUD","total":1250,"tax":1250,"net":1250},"calculatedTo":"2026-08-19","narrative":"example"},"linkedStatementId":"lstmt_9f2Kd8QpLzXw","narrative":"example","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","loanStatementId","loanId","referenceStatementId","merchantId","status","periodStart","periodEnd","billingDate","dueDate","statementFrequency","amounts","createdAt","updatedAt"],"properties":{"type":{"description":"Always `LstmtViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LstmtViewAttributes"]},"loanStatementId":{"$ref":"#/components/schemas/LstmtId","description":"Identifier of a loan statement."},"loanId":{"$ref":"#/components/schemas/LoanId","description":"Identifier of a loan."},"referenceStatementId":{"description":"The platform's own reference for this statement, which is what appears on a remittance.","type":"string"},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"The merchant the borrower trades with."},"customerId":{"$ref":"#/components/schemas/CustId","description":"The borrowing customer, on a trading-account loan."},"status":{"$ref":"#/components/schemas/LstmtStatus"},"periodStart":{"description":"First day of the period this statement covers.","type":"string","format":"date"},"periodEnd":{"description":"Last day of the period this statement covers.","type":"string","format":"date"},"billingDate":{"description":"The day the statement was cut.","type":"string","format":"date"},"dueDate":{"description":"The day payment falls due.","type":"string","format":"date"},"statementFrequency":{"$ref":"#/components/schemas/LprodFrequency","description":"The cycle this statement was cut on."},"amounts":{"$ref":"#/components/schemas/LstmtAmounts"},"entries":{"type":"array","items":{"$ref":"#/components/schemas/LstmtEntry"}},"lateFee":{"$ref":"#/components/schemas/LstmtLateFee"},"linkedStatementId":{"$ref":"#/components/schemas/LstmtId","description":"For a statement that exists because of another, a late-fee invoice, the statement it relates to."},"narrative":{"description":"An internal note about this statement.","type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"LtxnAdjustment":{"description":"A correction made to a movement's published amount.","oneOf":[{"$ref":"#/components/schemas/LtxnAdjustmentAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LtxnAdjustmentAttributes":"#/components/schemas/LtxnAdjustmentAttributes"}}},"LtxnAdjustmentAttributes":{"title":"LtxnAdjustmentAttributes","description":"A correction made to a movement's published amount.","examples":[{"type":"LtxnAdjustmentAttributes","adjustmentId":"abc123","amounts":{"type":"LstmtEntryAmountsAttributes","currency":"AUD","total":1250,"tax":1250,"net":1250},"description":"A short description.","adjustedAt":"2026-08-19T04:21:07Z","loanStatementId":"lstmt_9f2Kd8QpLzXw"}],"type":"object","required":["type","adjustmentId","amounts","description","adjustedAt"],"properties":{"type":{"description":"Always `LtxnAdjustmentAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LtxnAdjustmentAttributes"]},"adjustmentId":{"type":"string"},"amounts":{"$ref":"#/components/schemas/LstmtEntryAmounts","description":"The adjustment and the tax within it. Positive increases what the borrower owes."},"description":{"description":"Why the adjustment was made. Shown to the borrower.","type":"string"},"adjustedAt":{"type":"string","format":"date-time"},"loanStatementId":{"$ref":"#/components/schemas/LstmtId","description":"The statement the adjustment appears on. Adjustments go on a statement when they are made, so this is set from the start."}}},"LtxnAmounts":{"description":"The amounts at each stage of the movement, necessarily in the loan's currency.","oneOf":[{"$ref":"#/components/schemas/LtxnAmountsAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LtxnAmountsAttributes":"#/components/schemas/LtxnAmountsAttributes"}}},"LtxnAmountsAttributes":{"title":"LtxnAmountsAttributes","description":"A loan movement at each stage, and its tax. All are in the single currency given here.","examples":[{"type":"LtxnAmountsAttributes","currency":"AUD","authorised":1250,"captured":1250,"published":1250,"publishedTax":1250,"taxType":"example"}],"type":"object","required":["type","currency","authorised"],"properties":{"type":{"description":"Always `LtxnAmountsAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LtxnAmountsAttributes"]},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"authorised":{"$ref":"#/components/schemas/MinorUnits","description":"Authorised against the loan. Positive draws down, negative credits back."},"captured":{"$ref":"#/components/schemas/MinorUnits","description":"Captured. Less than `authorised` on a partial capture; absent until capture."},"published":{"$ref":"#/components/schemas/MinorUnits","description":"Posted to the borrower's statement. Can exceed `captured` where fees were added."},"publishedTax":{"$ref":"#/components/schemas/MinorUnits","description":"Tax within `published`."},"taxType":{"description":"What the tax is called, `GST`.","type":"string"}}},"LtxnCmd":{"oneOf":[{"$ref":"#/components/schemas/LtxnCmdPostManual"}],"discriminator":{"propertyName":"type","mapping":{"LtxnCmdPostManual":"#/components/schemas/LtxnCmdPostManual"}}},"LtxnCmdPostManual":{"title":"LtxnCmdPostManual","description":"Post a fee or an adjustment to a loan. This is edge's `CreateManualLoanTransaction`.","examples":[{"type":"LtxnCmdPostManual","loanId":"loan_9f2Kd8QpLzXw","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"lineItem":{"type":"LtxnLineItemEntryAttributes","entryType":"Charge","description":"A short description.","amounts":{"type":"LstmtEntryAmountsAttributes","currency":"AUD","total":1250,"tax":1250,"net":1250},"taxRate":0.9412,"taxType":"example"}}],"type":"object","required":["type","loanId","amount","lineItem"],"properties":{"type":{"description":"Always `LtxnCmdPostManual`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LtxnCmdPostManual"]},"loanId":{"$ref":"#/components/schemas/LoanId","description":"Identifier of a loan."},"amount":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"How much moves. Positive draws down, negative credits back. Must be in the loan's own currency."},"lineItem":{"$ref":"#/components/schemas/LtxnLineItemEntry"}}},"LtxnColumn":{"title":"LtxnColumn","type":"string","enum":["LoanTransactionId","LoanId","LoanProductId","LoanFacilityId","MerchantId","CustomerId","Status","AmountsCurrency","AmountsAuthorised","AmountsCaptured","AmountsPublished","AmountsPublishedTax","AmountsTaxType","ReferenceLoanTransactionId","CreatedAt","UpdatedAt"]},"LtxnCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/LtxnCreateRspFee"},{"$ref":"#/components/schemas/LtxnCreateRspMovement"}],"discriminator":{"propertyName":"type","mapping":{"LtxnCreateRspFee":"#/components/schemas/LtxnCreateRspFee","LtxnCreateRspMovement":"#/components/schemas/LtxnCreateRspMovement"}}},"LtxnCreateRspFee":{"title":"LtxnCreateRspFee","description":"A fee was added to the account. There is no movement behind it, so the loan's balances are what changed.","examples":[{"type":"LtxnCreateRspFee","balances":{"type":"LoanBalancesAttributes","currency":"AUD","limit":500000,"used":1250,"available":1250,"reserved":1250,"pending":1250}}],"type":"object","required":["type","balances"],"properties":{"type":{"description":"Always `LtxnCreateRspFee`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LtxnCreateRspFee"]},"balances":{"$ref":"#/components/schemas/LoanBalances","description":"The loan's balances after the fee went on."}}},"LtxnCreateRspMovement":{"title":"LtxnCreateRspMovement","description":"A movement was created.","examples":[{"type":"LtxnCreateRspMovement","created":{"type":"LtxnViewAttributes","loanTransactionId":"ltxn_9f2Kd8QpLzXw","loanId":"loan_9f2Kd8QpLzXw","loanProductId":"lprod_9f2Kd8QpLzXw","loanFacilityId":"lfac_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","customerId":"cust_9f2Kd8QpLzXw","status":"Authorised","amounts":{"type":"LtxnAmountsAttributes","currency":"AUD","authorised":1250,"captured":1250,"published":1250,"publishedTax":1250,"taxType":"example"},"specification":{"type":"LtxnSpecCardCharge","currency":"AUD","issuerTransactionId":"itxn_9f2Kd8QpLzXw","cardId":"dcard_9f2Kd8QpLzXw","realtimeSettlement":true,"authorisedAt":"2026-08-19T04:21:07Z","capturedOrCancelledAt":"2026-08-19T04:21:07Z","publishedAt":"2026-08-19T04:21:07Z","originalAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"lineItems":[{"type":"LtxnLineItemAttributes","entryType":"Charge","description":"A short description.","amounts":{"type":"LstmtEntryAmountsAttributes","currency":"AUD","total":1250,"tax":1250,"net":1250},"taxRate":0.9412,"taxType":"example","originalAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"source":"GeneratedSummary"}],"refunds":[{"type":"LtxnRefundAttributes","refundId":"rfnd_9f2Kd8QpLzXw","amounts":{"type":"LtxnRefundAmountsAttributes","currency":"AUD","amount":1250,"tax":1250,"taxType":"example"},"published":true,"originalAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"refundedAt":"2026-08-19T04:21:07Z","publishedAt":"2026-08-19T04:21:07Z","loanStatementId":"lstmt_9f2Kd8QpLzXw"}],"disputes":[{"type":"LtxnDisputeAttributes","disputeId":"dispute_9f2Kd8QpLzXw","outcome":"Pending","amount":1250,"originalAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"reason":"Requested by the customer.","raisedAt":"2026-08-19T04:21:07Z","concludedAt":"2026-08-19T04:21:07Z","loanStatementId":"lstmt_9f2Kd8QpLzXw"}],"adjustments":[{"type":"LtxnAdjustmentAttributes","adjustmentId":"abc123","amounts":{"type":"LstmtEntryAmountsAttributes","currency":"AUD","total":1250,"tax":1250,"net":1250},"description":"A short description.","adjustedAt":"2026-08-19T04:21:07Z","loanStatementId":"lstmt_9f2Kd8QpLzXw"}]},"loanStatementIds":["lstmt_9f2Kd8QpLzXw"],"referenceLoanTransactionId":"your-own-reference","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `LtxnCreateRspMovement`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LtxnCreateRspMovement"]},"created":{"$ref":"#/components/schemas/LtxnView","description":"A movement on a loan, a drawdown, a card charge, a fee or an adjustment."}}},"LtxnDispute":{"description":"A dispute raised against a card charge.","oneOf":[{"$ref":"#/components/schemas/LtxnDisputeAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LtxnDisputeAttributes":"#/components/schemas/LtxnDisputeAttributes"}}},"LtxnDisputeAttributes":{"title":"LtxnDisputeAttributes","description":"A dispute raised against a card charge.","examples":[{"type":"LtxnDisputeAttributes","disputeId":"dispute_9f2Kd8QpLzXw","outcome":"Pending","amount":1250,"originalAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"reason":"Requested by the customer.","raisedAt":"2026-08-19T04:21:07Z","concludedAt":"2026-08-19T04:21:07Z","loanStatementId":"lstmt_9f2Kd8QpLzXw"}],"type":"object","required":["type","disputeId","outcome","raisedAt"],"properties":{"type":{"description":"Always `LtxnDisputeAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LtxnDisputeAttributes"]},"disputeId":{"description":"The issuer's identifier for the dispute.","type":"string"},"outcome":{"$ref":"#/components/schemas/LtxnDisputeOutcome"},"amount":{"$ref":"#/components/schemas/MinorUnits","description":"The amount in dispute, where it is known, in the charge's currency."},"originalAmount":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"The amount before currency conversion, where the charge was in another currency."},"reason":{"type":"string"},"raisedAt":{"type":"string","format":"date-time"},"concludedAt":{"type":"string","format":"date-time"},"loanStatementId":{"$ref":"#/components/schemas/LstmtId","description":"The statement the dispute appears on, once it does."}}},"LtxnDisputeOutcome":{"title":"LtxnDisputeOutcome","type":"string","enum":["Pending","CustomerWon","CustomerLost","Unknown"]},"LtxnEntryType":{"title":"LtxnEntryType","type":"string","enum":["Charge","Refund","Dispute","DisputeFee","Insurance","AnnualFee","ImplementationFee","PremiumAccountFee","ExtendedPaymentTermsFee","CustomerTransactionFee","LatePaymentFee","BankFee","ThirdPartyServiceFee","ManualAdjustment","Unknown"]},"LtxnId":{"title":"LtxnId","examples":["ltxn_9f2Kd8QpLzXw"],"type":"string"},"LtxnLineItem":{"oneOf":[{"$ref":"#/components/schemas/LtxnLineItemAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LtxnLineItemAttributes":"#/components/schemas/LtxnLineItemAttributes"}}},"LtxnLineItemAttributes":{"title":"LtxnLineItemAttributes","description":"A line a movement puts on a statement.","examples":[{"type":"LtxnLineItemAttributes","entryType":"Charge","description":"A short description.","amounts":{"type":"LstmtEntryAmountsAttributes","currency":"AUD","total":1250,"tax":1250,"net":1250},"taxRate":0.9412,"taxType":"example","originalAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"source":"GeneratedSummary"}],"type":"object","required":["type","entryType","description","amounts","source"],"properties":{"type":{"description":"Always `LtxnLineItemAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LtxnLineItemAttributes"]},"entryType":{"$ref":"#/components/schemas/LtxnEntryType"},"description":{"type":"string"},"amounts":{"$ref":"#/components/schemas/LstmtEntryAmounts","description":"A statement line's total and the tax within it. Both are in the single currency given here."},"taxRate":{"description":"The rate the tax was charged at, as a decimal, `0.1` is 10%.","type":"number"},"taxType":{"description":"What the tax is called, `GST`.","type":"string"},"originalAmount":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"The amount before currency conversion, where the movement was converted."},"source":{"$ref":"#/components/schemas/LtxnLineItemSource"}}},"LtxnLineItemEntry":{"description":"The line this puts on the borrower's statement.","oneOf":[{"$ref":"#/components/schemas/LtxnLineItemEntryAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LtxnLineItemEntryAttributes":"#/components/schemas/LtxnLineItemEntryAttributes"}}},"LtxnLineItemEntryAttributes":{"title":"LtxnLineItemEntryAttributes","description":"The line a manual entry puts on the borrower's statement.","examples":[{"type":"LtxnLineItemEntryAttributes","entryType":"Charge","description":"A short description.","amounts":{"type":"LstmtEntryAmountsAttributes","currency":"AUD","total":1250,"tax":1250,"net":1250},"taxRate":0.9412,"taxType":"example"}],"type":"object","required":["type","entryType","description","amounts"],"properties":{"type":{"description":"Always `LtxnLineItemEntryAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LtxnLineItemEntryAttributes"]},"entryType":{"$ref":"#/components/schemas/LtxnEntryType"},"description":{"description":"What the borrower sees against this line.","type":"string"},"amounts":{"$ref":"#/components/schemas/LstmtEntryAmounts","description":"The line's total and the tax within it. Must be in the loan's own currency."},"taxRate":{"description":"The rate the tax is charged at, as a decimal, `0.1` is 10%.","type":"number"},"taxType":{"description":"What the tax is called, `GST`.","type":"string"}}},"LtxnLineItemSource":{"title":"LtxnLineItemSource","description":"Where the line came from, the platform's summary, the charge's metadata, a generated fee, or an operator.","type":"string","enum":["GeneratedSummary","Metadata","GeneratedFees","ManualEntry","Unknown"]},"LtxnPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/LtxnPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LtxnPageAttributes":"#/components/schemas/LtxnPageAttributes"}}},"LtxnPageAttributes":{"title":"LtxnPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"LtxnPageAttributes","data":[{"type":"LtxnViewAttributes","loanTransactionId":"ltxn_9f2Kd8QpLzXw","loanId":"loan_9f2Kd8QpLzXw","loanProductId":"lprod_9f2Kd8QpLzXw","loanFacilityId":"lfac_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","customerId":"cust_9f2Kd8QpLzXw","status":"Authorised","amounts":{"type":"LtxnAmountsAttributes","currency":"AUD","authorised":1250,"captured":1250,"published":1250,"publishedTax":1250,"taxType":"example"},"specification":{"type":"LtxnSpecCardCharge","currency":"AUD","issuerTransactionId":"itxn_9f2Kd8QpLzXw","cardId":"dcard_9f2Kd8QpLzXw","realtimeSettlement":true,"authorisedAt":"2026-08-19T04:21:07Z","capturedOrCancelledAt":"2026-08-19T04:21:07Z","publishedAt":"2026-08-19T04:21:07Z","originalAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"lineItems":[{"type":"LtxnLineItemAttributes","entryType":"Charge","description":"A short description.","amounts":{"type":"LstmtEntryAmountsAttributes","currency":"AUD","total":1250,"tax":1250,"net":1250},"taxRate":0.9412,"taxType":"example","originalAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"source":"GeneratedSummary"}],"refunds":[{"type":"LtxnRefundAttributes","refundId":"rfnd_9f2Kd8QpLzXw","amounts":{"type":"LtxnRefundAmountsAttributes","currency":"AUD","amount":1250,"tax":1250,"taxType":"example"},"published":true,"originalAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"refundedAt":"2026-08-19T04:21:07Z","publishedAt":"2026-08-19T04:21:07Z","loanStatementId":"lstmt_9f2Kd8QpLzXw"}],"disputes":[{"type":"LtxnDisputeAttributes","disputeId":"dispute_9f2Kd8QpLzXw","outcome":"Pending","amount":1250,"originalAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"reason":"Requested by the customer.","raisedAt":"2026-08-19T04:21:07Z","concludedAt":"2026-08-19T04:21:07Z","loanStatementId":"lstmt_9f2Kd8QpLzXw"}],"adjustments":[{"type":"LtxnAdjustmentAttributes","adjustmentId":"abc123","amounts":{"type":"LstmtEntryAmountsAttributes","currency":"AUD","total":1250,"tax":1250,"net":1250},"description":"A short description.","adjustedAt":"2026-08-19T04:21:07Z","loanStatementId":"lstmt_9f2Kd8QpLzXw"}]},"loanStatementIds":["lstmt_9f2Kd8QpLzXw"],"referenceLoanTransactionId":"your-own-reference","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `LtxnPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LtxnPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/LtxnView","description":"A movement on a loan, a drawdown, a card charge, a fee or an adjustment."}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"LtxnRefund":{"description":"A refund against a card charge.","oneOf":[{"$ref":"#/components/schemas/LtxnRefundAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LtxnRefundAttributes":"#/components/schemas/LtxnRefundAttributes"}}},"LtxnRefundAmounts":{"description":"Refunded, and the tax within it. Always positive.","oneOf":[{"$ref":"#/components/schemas/LtxnRefundAmountsAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LtxnRefundAmountsAttributes":"#/components/schemas/LtxnRefundAmountsAttributes"}}},"LtxnRefundAmountsAttributes":{"title":"LtxnRefundAmountsAttributes","description":"A refunded amount and the tax within it. Both are in the single currency given here.","examples":[{"type":"LtxnRefundAmountsAttributes","currency":"AUD","amount":1250,"tax":1250,"taxType":"example"}],"type":"object","required":["type","currency","amount"],"properties":{"type":{"description":"Always `LtxnRefundAmountsAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LtxnRefundAmountsAttributes"]},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"amount":{"$ref":"#/components/schemas/MinorUnits","description":"An amount in the minor units of the currency given by the enclosing object's `currency` field."},"tax":{"$ref":"#/components/schemas/MinorUnits","description":"An amount in the minor units of the currency given by the enclosing object's `currency` field."},"taxType":{"description":"What the tax is called, `GST`.","type":"string"}}},"LtxnRefundAttributes":{"title":"LtxnRefundAttributes","description":"A refund against a card charge.","examples":[{"type":"LtxnRefundAttributes","refundId":"rfnd_9f2Kd8QpLzXw","amounts":{"type":"LtxnRefundAmountsAttributes","currency":"AUD","amount":1250,"tax":1250,"taxType":"example"},"published":true,"originalAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"refundedAt":"2026-08-19T04:21:07Z","publishedAt":"2026-08-19T04:21:07Z","loanStatementId":"lstmt_9f2Kd8QpLzXw"}],"type":"object","required":["type","refundId","amounts","published","refundedAt"],"properties":{"type":{"description":"Always `LtxnRefundAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LtxnRefundAttributes"]},"refundId":{"description":"The issuer's identifier for the refund.","type":"string"},"amounts":{"$ref":"#/components/schemas/LtxnRefundAmounts"},"published":{"description":"Whether the refund has reached the borrower's statement.","type":"boolean"},"originalAmount":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"The amount before currency conversion, where the refund was in another currency."},"refundedAt":{"type":"string","format":"date-time"},"publishedAt":{"type":"string","format":"date-time"},"loanStatementId":{"$ref":"#/components/schemas/LstmtId","description":"The statement the refund appears on, once it does."}}},"LtxnSort":{"title":"LtxnSort","type":"string","enum":["createdAt","-createdAt","updatedAt","-updatedAt"]},"LtxnSpec":{"description":"Where the movement came from, and what is particular to that kind.","oneOf":[{"$ref":"#/components/schemas/LtxnSpecCardCharge"},{"$ref":"#/components/schemas/LtxnSpecFee"},{"$ref":"#/components/schemas/LtxnSpecManualEntry"},{"$ref":"#/components/schemas/LtxnSpecManualRefund"},{"$ref":"#/components/schemas/LtxnSpecRealtimeSettlement"}],"discriminator":{"propertyName":"type","mapping":{"LtxnSpecCardCharge":"#/components/schemas/LtxnSpecCardCharge","LtxnSpecFee":"#/components/schemas/LtxnSpecFee","LtxnSpecManualEntry":"#/components/schemas/LtxnSpecManualEntry","LtxnSpecManualRefund":"#/components/schemas/LtxnSpecManualRefund","LtxnSpecRealtimeSettlement":"#/components/schemas/LtxnSpecRealtimeSettlement"}}},"LtxnSpecCardCharge":{"title":"LtxnSpecCardCharge","description":"A charge on a card backed by this loan, and everything that has happened to it since.","examples":[{"type":"LtxnSpecCardCharge","currency":"AUD","issuerTransactionId":"itxn_9f2Kd8QpLzXw","cardId":"dcard_9f2Kd8QpLzXw","realtimeSettlement":true,"authorisedAt":"2026-08-19T04:21:07Z","capturedOrCancelledAt":"2026-08-19T04:21:07Z","publishedAt":"2026-08-19T04:21:07Z","originalAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"lineItems":[{"type":"LtxnLineItemAttributes","entryType":"Charge","description":"A short description.","amounts":{"type":"LstmtEntryAmountsAttributes","currency":"AUD","total":1250,"tax":1250,"net":1250},"taxRate":0.9412,"taxType":"example","originalAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"source":"GeneratedSummary"}],"refunds":[{"type":"LtxnRefundAttributes","refundId":"rfnd_9f2Kd8QpLzXw","amounts":{"type":"LtxnRefundAmountsAttributes","currency":"AUD","amount":1250,"tax":1250,"taxType":"example"},"published":true,"originalAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"refundedAt":"2026-08-19T04:21:07Z","publishedAt":"2026-08-19T04:21:07Z","loanStatementId":"lstmt_9f2Kd8QpLzXw"}],"disputes":[{"type":"LtxnDisputeAttributes","disputeId":"dispute_9f2Kd8QpLzXw","outcome":"Pending","amount":1250,"originalAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"reason":"Requested by the customer.","raisedAt":"2026-08-19T04:21:07Z","concludedAt":"2026-08-19T04:21:07Z","loanStatementId":"lstmt_9f2Kd8QpLzXw"}],"adjustments":[{"type":"LtxnAdjustmentAttributes","adjustmentId":"abc123","amounts":{"type":"LstmtEntryAmountsAttributes","currency":"AUD","total":1250,"tax":1250,"net":1250},"description":"A short description.","adjustedAt":"2026-08-19T04:21:07Z","loanStatementId":"lstmt_9f2Kd8QpLzXw"}]}],"type":"object","required":["type","currency","issuerTransactionId","realtimeSettlement","authorisedAt"],"properties":{"type":{"description":"Always `LtxnSpecCardCharge`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LtxnSpecCardCharge"]},"currency":{"$ref":"#/components/schemas/IsoCurrency","description":"The currency every amount below is in, the loan's own. Stated here so a nested refund or dispute reads on its own."},"issuerTransactionId":{"description":"The card issuer's own view of the charge.","type":"string"},"cardId":{"description":"The card the charge was made on, where it is known.","type":"string"},"realtimeSettlement":{"description":"Whether the captured funds clear to the merchant in real time.","type":"boolean"},"authorisedAt":{"description":"When the charge was authorised.","type":"string","format":"date-time"},"capturedOrCancelledAt":{"description":"When it was captured, or cancelled.","type":"string","format":"date-time"},"publishedAt":{"description":"When it went on the borrower's statement.","type":"string","format":"date-time"},"originalAmount":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"The amount before currency conversion, where the charge was in another currency. Genuinely in another currency, so it carries its own."},"lineItems":{"description":"The lines this charge puts on the statement. Set once the charge is published, because only then is the metadata known.","type":"array","items":{"$ref":"#/components/schemas/LtxnLineItem","description":"A line a movement puts on a statement."}},"refunds":{"description":"Refunds against this charge.","type":"array","items":{"$ref":"#/components/schemas/LtxnRefund"}},"disputes":{"description":"Disputes raised against this charge.","type":"array","items":{"$ref":"#/components/schemas/LtxnDispute"}},"adjustments":{"description":"Corrections made to the published amount.","type":"array","items":{"$ref":"#/components/schemas/LtxnAdjustment"}}}},"LtxnSpecFee":{"title":"LtxnSpecFee","description":"A fee the platform raised against the account, held until the statement it belongs on closes.","examples":[{"type":"LtxnSpecFee","lineItem":{"type":"LtxnLineItemAttributes","entryType":"Charge","description":"A short description.","amounts":{"type":"LstmtEntryAmountsAttributes","currency":"AUD","total":1250,"tax":1250,"net":1250},"taxRate":0.9412,"taxType":"example","originalAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"source":"GeneratedSummary"},"sourceLoanTransactionId":"ltxn_9f2Kd8QpLzXw","sourceIssuerTransactionId":"itxn_9f2Kd8QpLzXw"}],"type":"object","required":["type","lineItem"],"properties":{"type":{"description":"Always `LtxnSpecFee`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LtxnSpecFee"]},"lineItem":{"$ref":"#/components/schemas/LtxnLineItem","description":"The line this fee puts on the statement."},"sourceLoanTransactionId":{"description":"The drawdown the fee was derived from, where it was derived from one rather than from the account as a whole.","type":"string"},"sourceIssuerTransactionId":{"description":"The card charge behind that drawdown, on the same condition.","type":"string"}}},"LtxnSpecManualEntry":{"title":"LtxnSpecManualEntry","description":"A fee or adjustment posted to the account by hand.","examples":[{"type":"LtxnSpecManualEntry","lineItem":{"type":"LtxnLineItemAttributes","entryType":"Charge","description":"A short description.","amounts":{"type":"LstmtEntryAmountsAttributes","currency":"AUD","total":1250,"tax":1250,"net":1250},"taxRate":0.9412,"taxType":"example","originalAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"source":"GeneratedSummary"}}],"type":"object","required":["type","lineItem"],"properties":{"type":{"description":"Always `LtxnSpecManualEntry`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LtxnSpecManualEntry"]},"lineItem":{"$ref":"#/components/schemas/LtxnLineItem","description":"The line this movement puts on the statement."}}},"LtxnSpecManualRefund":{"title":"LtxnSpecManualRefund","description":"A credit raised by hand to resolve a discrepancy between the platform's view of a card charge and the issuer's.","examples":[{"type":"LtxnSpecManualRefund","lineItem":{"type":"LtxnLineItemAttributes","entryType":"Charge","description":"A short description.","amounts":{"type":"LstmtEntryAmountsAttributes","currency":"AUD","total":1250,"tax":1250,"net":1250},"taxRate":0.9412,"taxType":"example","originalAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"source":"GeneratedSummary"},"issuerTransactionDiscrepancyId":"abc123"}],"type":"object","required":["type","lineItem","issuerTransactionDiscrepancyId"],"properties":{"type":{"description":"Always `LtxnSpecManualRefund`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LtxnSpecManualRefund"]},"lineItem":{"$ref":"#/components/schemas/LtxnLineItem","description":"The line this credit puts on the statement."},"issuerTransactionDiscrepancyId":{"description":"The discrepancy this credit resolved. Its metadata and card details are read from the discrepancy itself.","type":"string"}}},"LtxnSpecRealtimeSettlement":{"title":"LtxnSpecRealtimeSettlement","description":"A drawdown that funded a merchant's settlement in real time. It carries nothing else, the payment it settled is a transaction.","examples":[{"type":"LtxnSpecRealtimeSettlement"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `LtxnSpecRealtimeSettlement`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LtxnSpecRealtimeSettlement"]}}},"LtxnStatus":{"title":"LtxnStatus","type":"string","enum":["Authorised","Captured","PublishedToStatement","Cancelled","Unknown"]},"LtxnUpdate":{"oneOf":[{"$ref":"#/components/schemas/LtxnUpdateCancel"},{"$ref":"#/components/schemas/LtxnUpdateCapture"},{"$ref":"#/components/schemas/LtxnUpdatePublish"}],"discriminator":{"propertyName":"type","mapping":{"LtxnUpdateCancel":"#/components/schemas/LtxnUpdateCancel","LtxnUpdateCapture":"#/components/schemas/LtxnUpdateCapture","LtxnUpdatePublish":"#/components/schemas/LtxnUpdatePublish"}}},"LtxnUpdateCancel":{"title":"LtxnUpdateCancel","description":"Release the reservation. There is no amount, cancelling releases whatever was held.","examples":[{"type":"LtxnUpdateCancel"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `LtxnUpdateCancel`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LtxnUpdateCancel"]}}},"LtxnUpdateCapture":{"title":"LtxnUpdateCapture","description":"Take the reserved funds. Capture less by naming a smaller amount; omit it to take the full authorisation.","examples":[{"type":"LtxnUpdateCapture","captureAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"publishOnCapture":true}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `LtxnUpdateCapture`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LtxnUpdateCapture"]},"captureAmount":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"An amount in minor current units of a given currency."},"publishOnCapture":{"description":"Bill it to the borrower's statement in the same step rather than as a second call.","type":"boolean"}}},"LtxnUpdatePublish":{"title":"LtxnUpdatePublish","description":"Bill an already-captured charge to the borrower's statement.","examples":[{"type":"LtxnUpdatePublish"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `LtxnUpdatePublish`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LtxnUpdatePublish"]}}},"LtxnUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/LtxnUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LtxnUpdateRspAttributes":"#/components/schemas/LtxnUpdateRspAttributes"}}},"LtxnUpdateRspAttributes":{"title":"LtxnUpdateRspAttributes","examples":[{"type":"LtxnUpdateRspAttributes","updated":{"type":"LtxnViewAttributes","loanTransactionId":"ltxn_9f2Kd8QpLzXw","loanId":"loan_9f2Kd8QpLzXw","loanProductId":"lprod_9f2Kd8QpLzXw","loanFacilityId":"lfac_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","customerId":"cust_9f2Kd8QpLzXw","status":"Authorised","amounts":{"type":"LtxnAmountsAttributes","currency":"AUD","authorised":1250,"captured":1250,"published":1250,"publishedTax":1250,"taxType":"example"},"specification":{"type":"LtxnSpecCardCharge","currency":"AUD","issuerTransactionId":"itxn_9f2Kd8QpLzXw","cardId":"dcard_9f2Kd8QpLzXw","realtimeSettlement":true,"authorisedAt":"2026-08-19T04:21:07Z","capturedOrCancelledAt":"2026-08-19T04:21:07Z","publishedAt":"2026-08-19T04:21:07Z","originalAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"lineItems":[{"type":"LtxnLineItemAttributes","entryType":"Charge","description":"A short description.","amounts":{"type":"LstmtEntryAmountsAttributes","currency":"AUD","total":1250,"tax":1250,"net":1250},"taxRate":0.9412,"taxType":"example","originalAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"source":"GeneratedSummary"}],"refunds":[{"type":"LtxnRefundAttributes","refundId":"rfnd_9f2Kd8QpLzXw","amounts":{"type":"LtxnRefundAmountsAttributes","currency":"AUD","amount":1250,"tax":1250,"taxType":"example"},"published":true,"originalAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"refundedAt":"2026-08-19T04:21:07Z","publishedAt":"2026-08-19T04:21:07Z","loanStatementId":"lstmt_9f2Kd8QpLzXw"}],"disputes":[{"type":"LtxnDisputeAttributes","disputeId":"dispute_9f2Kd8QpLzXw","outcome":"Pending","amount":1250,"originalAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"reason":"Requested by the customer.","raisedAt":"2026-08-19T04:21:07Z","concludedAt":"2026-08-19T04:21:07Z","loanStatementId":"lstmt_9f2Kd8QpLzXw"}],"adjustments":[{"type":"LtxnAdjustmentAttributes","adjustmentId":"abc123","amounts":{"type":"LstmtEntryAmountsAttributes","currency":"AUD","total":1250,"tax":1250,"net":1250},"description":"A short description.","adjustedAt":"2026-08-19T04:21:07Z","loanStatementId":"lstmt_9f2Kd8QpLzXw"}]},"loanStatementIds":["lstmt_9f2Kd8QpLzXw"],"referenceLoanTransactionId":"your-own-reference","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `LtxnUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LtxnUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/LtxnView","description":"The resource as it stands after the change."}}},"LtxnView":{"oneOf":[{"$ref":"#/components/schemas/LtxnViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"LtxnViewAttributes":"#/components/schemas/LtxnViewAttributes"}}},"LtxnViewAttributes":{"title":"LtxnViewAttributes","description":"A movement on a loan, a drawdown, a card charge, a fee or an adjustment.","examples":[{"type":"LtxnViewAttributes","loanTransactionId":"ltxn_9f2Kd8QpLzXw","loanId":"loan_9f2Kd8QpLzXw","loanProductId":"lprod_9f2Kd8QpLzXw","loanFacilityId":"lfac_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","customerId":"cust_9f2Kd8QpLzXw","status":"Authorised","amounts":{"type":"LtxnAmountsAttributes","currency":"AUD","authorised":1250,"captured":1250,"published":1250,"publishedTax":1250,"taxType":"example"},"specification":{"type":"LtxnSpecCardCharge","currency":"AUD","issuerTransactionId":"itxn_9f2Kd8QpLzXw","cardId":"dcard_9f2Kd8QpLzXw","realtimeSettlement":true,"authorisedAt":"2026-08-19T04:21:07Z","capturedOrCancelledAt":"2026-08-19T04:21:07Z","publishedAt":"2026-08-19T04:21:07Z","originalAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"lineItems":[{"type":"LtxnLineItemAttributes","entryType":"Charge","description":"A short description.","amounts":{"type":"LstmtEntryAmountsAttributes","currency":"AUD","total":1250,"tax":1250,"net":1250},"taxRate":0.9412,"taxType":"example","originalAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"source":"GeneratedSummary"}],"refunds":[{"type":"LtxnRefundAttributes","refundId":"rfnd_9f2Kd8QpLzXw","amounts":{"type":"LtxnRefundAmountsAttributes","currency":"AUD","amount":1250,"tax":1250,"taxType":"example"},"published":true,"originalAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"refundedAt":"2026-08-19T04:21:07Z","publishedAt":"2026-08-19T04:21:07Z","loanStatementId":"lstmt_9f2Kd8QpLzXw"}],"disputes":[{"type":"LtxnDisputeAttributes","disputeId":"dispute_9f2Kd8QpLzXw","outcome":"Pending","amount":1250,"originalAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"reason":"Requested by the customer.","raisedAt":"2026-08-19T04:21:07Z","concludedAt":"2026-08-19T04:21:07Z","loanStatementId":"lstmt_9f2Kd8QpLzXw"}],"adjustments":[{"type":"LtxnAdjustmentAttributes","adjustmentId":"abc123","amounts":{"type":"LstmtEntryAmountsAttributes","currency":"AUD","total":1250,"tax":1250,"net":1250},"description":"A short description.","adjustedAt":"2026-08-19T04:21:07Z","loanStatementId":"lstmt_9f2Kd8QpLzXw"}]},"loanStatementIds":["lstmt_9f2Kd8QpLzXw"],"referenceLoanTransactionId":"your-own-reference","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","loanTransactionId","loanId","loanProductId","loanFacilityId","merchantId","status","amounts","specification","createdAt","updatedAt"],"properties":{"type":{"description":"Always `LtxnViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["LtxnViewAttributes"]},"loanTransactionId":{"$ref":"#/components/schemas/LtxnId","description":"Identifier of a loan transaction."},"loanId":{"$ref":"#/components/schemas/LoanId","description":"Identifier of a loan."},"loanProductId":{"$ref":"#/components/schemas/LprodId"},"loanFacilityId":{"$ref":"#/components/schemas/LfacId"},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"The merchant the borrower trades with."},"customerId":{"$ref":"#/components/schemas/CustId","description":"The borrowing customer, on a trading-account loan."},"status":{"$ref":"#/components/schemas/LtxnStatus"},"amounts":{"$ref":"#/components/schemas/LtxnAmounts"},"specification":{"$ref":"#/components/schemas/LtxnSpec"},"loanStatementIds":{"description":"The statements this movement and its consequences appear on. A card charge that was later refunded appears on two.","type":"array","items":{"$ref":"#/components/schemas/LstmtId","description":"Identifier of a loan statement."}},"referenceLoanTransactionId":{"description":"Your own reference for this movement.","type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"MchtAddress":{"oneOf":[{"$ref":"#/components/schemas/MchtAddressAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MchtAddressAttributes":"#/components/schemas/MchtAddressAttributes"}}},"MchtAddressAttributes":{"title":"MchtAddressAttributes","description":"A postal address. Supplying one on a patch replaces the whole address, you cannot patch half of one.","examples":[{"type":"MchtAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"}],"type":"object","required":["type","streetNumber","streetName","postalCode","country"],"properties":{"type":{"description":"Always `MchtAddressAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtAddressAttributes"]},"unitNumber":{"description":"Unit, shop or level, as written on the building. Free text, `12`, `Shop 4`, `Level 3`. Omit where there is none.","type":"string"},"streetNumber":{"description":"Street number, including any range or letter, `34`, `34A`, `34-36`.","type":"string"},"streetName":{"description":"Street name, without the type, `Smith`, not `Smith Street`.","type":"string"},"streetType":{"description":"`Street`, `Road`, `Avenue`. Optional because not every address has one.","type":"string"},"suburb":{"description":"Suburb. This is where Australia and South Africa keep what other countries call the city.","type":"string"},"city":{"description":"City. **Required in New Zealand.** In Australia and South Africa send `suburb` instead, the platform moves whichever you send to where that country keeps it.","type":"string"},"state":{"description":"State, province or territory. **Required in Australia.**","type":"string"},"postalCode":{"type":"string"},"country":{"description":"ISO 3166-1 alpha-2.","type":"string"}}},"MchtApplePay":{"oneOf":[{"$ref":"#/components/schemas/MchtApplePayNone"},{"$ref":"#/components/schemas/MchtApplePayRegistered"}],"discriminator":{"propertyName":"type","mapping":{"MchtApplePayNone":"#/components/schemas/MchtApplePayNone","MchtApplePayRegistered":"#/components/schemas/MchtApplePayRegistered"}}},"MchtApplePayNone":{"title":"MchtApplePayNone","description":"Apple Pay is not registered for this merchant.","examples":[{"type":"MchtApplePayNone"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `MchtApplePayNone`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtApplePayNone"]}}},"MchtApplePayRegistered":{"title":"MchtApplePayRegistered","description":"Apple Pay is registered, and these are the domains it is offered on.","examples":[{"type":"MchtApplePayRegistered","domains":["example"],"encryptTo":"example","merchantUrl":"https://example.com/callback","partnerInternalMerchantIdentifier":"example","partnerMerchantName":"Ada Lovelace"}],"type":"object","required":["type","domains","encryptTo","partnerInternalMerchantIdentifier","partnerMerchantName"],"properties":{"type":{"description":"Always `MchtApplePayRegistered`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtApplePayRegistered"]},"domains":{"description":"Fully-qualified domains Apple Pay will process payments for. At least one.","type":"array","minItems":1,"items":{"type":"string"}},"encryptTo":{"description":"The certificate the payment payload is encrypted to.","type":"string"},"merchantUrl":{"description":"The merchant's site, as registered with Apple. Absent where the partner did not record one.","type":"string"},"partnerInternalMerchantIdentifier":{"description":"How the payment partner identifies this merchant to Apple.","type":"string"},"partnerMerchantName":{"description":"The name shown in the Apple Pay sheet.","type":"string"}}},"MchtBankAccount":{"description":"A bank account a merchant can be paid out to.","oneOf":[{"$ref":"#/components/schemas/MchtBankAccountAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MchtBankAccountAttributes":"#/components/schemas/MchtBankAccountAttributes"}}},"MchtBankAccountAttributes":{"title":"MchtBankAccountAttributes","description":"A bank account a merchant can be paid out to.","examples":[{"type":"MchtBankAccountAttributes","externalAccountId":"xacc_9f2Kd8QpLzXw","accountName":"Ada Lovelace","last4":"4242","currency":"AUD","isPrimary":true,"status":"Active","verificationStatus":"Active"}],"type":"object","required":["type","externalAccountId","accountName","last4","currency","isPrimary","status"],"properties":{"type":{"description":"Always `MchtBankAccountAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtBankAccountAttributes"]},"externalAccountId":{"type":"string"},"accountName":{"type":"string"},"last4":{"description":"Last four digits of the account number.","type":"string"},"currency":{"type":"string"},"isPrimary":{"description":"Whether payouts in this currency go here.","type":"boolean"},"status":{"type":"string"},"verificationStatus":{"description":"The result of the last verification against the bank, where one has run.","type":"string"}}},"MchtBankAccountDetails":{"description":"The account the supplier is paid into.","oneOf":[{"$ref":"#/components/schemas/MchtBankAccountDetailsAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MchtBankAccountDetailsAttributes":"#/components/schemas/MchtBankAccountDetailsAttributes"}}},"MchtBankAccountDetailsAttributes":{"title":"MchtBankAccountDetailsAttributes","description":"A bank account to pay a supplier into.","examples":[{"type":"MchtBankAccountDetailsAttributes","accountName":"Ada Lovelace","accountNumber":"example","routingNumber":"example","bankName":"Ada Lovelace","country":"AU","currency":"AUD","referenceAccountId":"your-own-reference","requesterId":"abc123"}],"type":"object","required":["type","accountName","accountNumber","routingNumber","country","currency"],"properties":{"type":{"description":"Always `MchtBankAccountDetailsAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtBankAccountDetailsAttributes"]},"accountName":{"type":"string"},"accountNumber":{"type":"string"},"routingNumber":{"description":"BSB in Australia, sort code in the UK, routing number in the US.","type":"string"},"bankName":{"type":"string"},"country":{"description":"ISO-3166 alpha-2 of the bank's country.","type":"string"},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"referenceAccountId":{"description":"Your own identifier for this account.","type":"string"},"requesterId":{"description":"Who is asking for the account to be verified. The bank's account-name check requires it.","type":"string"}}},"MchtBillingSettings":{"description":"How the merchant is billed for platform fees.","oneOf":[{"$ref":"#/components/schemas/MchtBillingSettingsAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MchtBillingSettingsAttributes":"#/components/schemas/MchtBillingSettingsAttributes"}}},"MchtBillingSettingsAttributes":{"title":"MchtBillingSettingsAttributes","description":"How the merchant is billed for platform fees.","examples":[{"type":"MchtBillingSettingsAttributes","notificationEmails":["ada@example.com"],"notificationsEnabled":true,"address":{"type":"MchtAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"},"paymentSourceId":"psrc_9f2Kd8QpLzXw"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `MchtBillingSettingsAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtBillingSettingsAttributes"]},"notificationEmails":{"type":"array","items":{"type":"string"}},"notificationsEnabled":{"type":"boolean"},"address":{"$ref":"#/components/schemas/MchtAddress","description":"A postal address. Supplying one on a patch replaces the whole address, you cannot patch half of one."},"paymentSourceId":{"description":"The payment source platform fees are charged to.","type":"string"}}},"MchtBillingSettingsPatch":{"description":"How the merchant is billed for platform fees. Only the fields sent change.","oneOf":[{"$ref":"#/components/schemas/MchtBillingSettingsPatchAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MchtBillingSettingsPatchAttributes":"#/components/schemas/MchtBillingSettingsPatchAttributes"}}},"MchtBillingSettingsPatchAttributes":{"title":"MchtBillingSettingsPatchAttributes","description":"How the merchant is billed for platform fees. Only the fields sent change.","examples":[{"type":"MchtBillingSettingsPatchAttributes","notificationEmails":["ada@example.com"],"notificationsEnabled":true,"address":{"type":"MchtAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"},"paymentSourceId":"psrc_9f2Kd8QpLzXw"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `MchtBillingSettingsPatchAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtBillingSettingsPatchAttributes"]},"notificationEmails":{"description":"Sending the list replaces it. An empty list sends billing notifications to the contact email.","type":"array","items":{"type":"string"}},"notificationsEnabled":{"type":"boolean"},"address":{"$ref":"#/components/schemas/MchtAddress","description":"A postal address. Supplying one on a patch replaces the whole address, you cannot patch half of one."},"paymentSourceId":{"description":"The payment source platform fees are charged to. `null` removes it.","type":["string","null"]}}},"MchtBinGroupId":{"title":"MchtBinGroupId","description":"Identifier of a BIN group.","examples":["bing_9f2Kd8QpLzXw"],"type":"string"},"MchtBranding":{"description":"Logo, colours and the look of hosted pages.","oneOf":[{"$ref":"#/components/schemas/MchtBrandingAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MchtBrandingAttributes":"#/components/schemas/MchtBrandingAttributes"}}},"MchtBrandingAttributes":{"title":"MchtBrandingAttributes","description":"Logo, colours and the look of hosted pages.","examples":[{"type":"MchtBrandingAttributes","logoFileId":"lfile_9f2Kd8QpLzXw","iconFileId":"lfile_9f2Kd8QpLzXw","logoAltText":"example","brandColour":"example"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `MchtBrandingAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtBrandingAttributes"]},"logoFileId":{"type":"string"},"iconFileId":{"type":"string"},"logoAltText":{"type":"string"},"brandColour":{"description":"Hex, e.g. #0B7285.","type":"string"}}},"MchtBrandingPatch":{"description":"Logo, colours and the look of hosted pages. Only the fields sent change, and `null` removes one.","oneOf":[{"$ref":"#/components/schemas/MchtBrandingPatchAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MchtBrandingPatchAttributes":"#/components/schemas/MchtBrandingPatchAttributes"}}},"MchtBrandingPatchAttributes":{"title":"MchtBrandingPatchAttributes","description":"Logo, colours and the look of hosted pages. Only the fields sent change, and `null` removes one.","examples":[{"type":"MchtBrandingPatchAttributes","logoFileId":"lfile_9f2Kd8QpLzXw","iconFileId":"lfile_9f2Kd8QpLzXw","logoAltText":"example","brandColour":"example"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `MchtBrandingPatchAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtBrandingPatchAttributes"]},"logoFileId":{"type":["string","null"]},"iconFileId":{"type":["string","null"]},"logoAltText":{"type":["string","null"]},"brandColour":{"description":"Hex, e.g. #0B7285.","type":["string","null"]}}},"MchtBusiness":{"description":"The trading identity of a merchant.","oneOf":[{"$ref":"#/components/schemas/MchtBusinessAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MchtBusinessAttributes":"#/components/schemas/MchtBusinessAttributes"}}},"MchtBusinessAttributes":{"title":"MchtBusinessAttributes","description":"The trading identity of a merchant.","examples":[{"type":"MchtBusinessAttributes","legalName":"Ada Lovelace","brandName":"Ada Lovelace","businessRegistrationNumber":"example","taxRegistrationNumber":"example","country":"AU","website":"example","contactEmail":"ada@example.com"}],"type":"object","required":["type","legalName","country","contactEmail"],"properties":{"type":{"description":"Always `MchtBusinessAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtBusinessAttributes"]},"legalName":{"description":"Registered legal name of the business.","type":"string"},"brandName":{"description":"Name the business trades under, where it differs from the legal name. Taken on `MchtCmdCreateSupplier`; on `MchtCmdCreate` the platform's create has nowhere to put it, so set it afterwards with `MchtUpdateBusinessProfile`.","type":"string"},"businessRegistrationNumber":{"description":"ABN in Australia, NZBN in New Zealand. Checked against `country`.","type":"string"},"taxRegistrationNumber":{"description":"ABN in Australia, IRD number in New Zealand. Checked against `country`, and given only with `businessRegistrationNumber`; in Australia it must be that same ABN. Read back as the business registration number in Australia when none was given.","type":"string"},"country":{"type":"string"},"website":{"description":"Taken on `MchtCmdCreateSupplier`; on `MchtCmdCreate` the platform's create has nowhere to put it, so set it afterwards with `MchtUpdateBusinessProfile`.","type":"string"},"contactEmail":{"type":"string"}}},"MchtBusinessProfilePatch":{"description":"Who the business is, legally. Only the fields sent change.","oneOf":[{"$ref":"#/components/schemas/MchtBusinessProfilePatchAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MchtBusinessProfilePatchAttributes":"#/components/schemas/MchtBusinessProfilePatchAttributes"}}},"MchtBusinessProfilePatchAttributes":{"title":"MchtBusinessProfilePatchAttributes","description":"Who the business is, legally. Only the fields sent change.","examples":[{"type":"MchtBusinessProfilePatchAttributes","legalName":"Ada Lovelace","businessType":"Company","companyType":"example","businessRegistrationNumber":"example","taxRegistrationNumber":"example","industry":"example","tradingCountry":"AU","timeZone":"example"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `MchtBusinessProfilePatchAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtBusinessProfilePatchAttributes"]},"legalName":{"description":"Registered legal name, as it appears against the business registration number.","type":"string"},"businessType":{"$ref":"#/components/schemas/MchtBusinessType"},"companyType":{"description":"Required when `businessType` is `Company`. `null` removes it.","type":["string","null"]},"businessRegistrationNumber":{"description":"ABN in Australia, NZBN in New Zealand.","type":"string"},"taxRegistrationNumber":{"description":"ABN in Australia, IRD number in New Zealand. `null` removes it, where the tax country does not require one.","type":["string","null"]},"industry":{"type":"string"},"tradingCountry":{"description":"ISO-3166 alpha-2. Only needed when the merchant trades somewhere other than its tax country. `null` removes it.","type":["string","null"]},"timeZone":{"type":"string"}}},"MchtBusinessType":{"title":"MchtBusinessType","type":"string","enum":["Company","Individual","SoleTrader","Partnership","Trust","Unknown"]},"MchtCapabilityTag":{"title":"MchtCapabilityTag","type":"string","enum":["DirectDebit","PayTo","CheckoutV2","LaddrToolsFinance","AllPayPlanVariants","ServiceProviderFinance","AmexDisallowed","PerformNoComms","EftposDisallowed","AllowLegacyDelegateCreation","ManualVerification","AllowPayoutRemitterUpdate","Unknown"]},"MchtCmd":{"oneOf":[{"$ref":"#/components/schemas/MchtCmdCreate"},{"$ref":"#/components/schemas/MchtCmdCreateSupplier"}],"discriminator":{"propertyName":"type","mapping":{"MchtCmdCreate":"#/components/schemas/MchtCmdCreate","MchtCmdCreateSupplier":"#/components/schemas/MchtCmdCreateSupplier"}}},"MchtCmdAction":{"oneOf":[{"$ref":"#/components/schemas/MchtCmdActivate"},{"$ref":"#/components/schemas/MchtCmdActivation"},{"$ref":"#/components/schemas/MchtCmdOnboard"},{"$ref":"#/components/schemas/MchtCmdRegisterApplePay"},{"$ref":"#/components/schemas/MchtCmdSubmitForReview"},{"$ref":"#/components/schemas/MchtCmdUnregisterApplePay"}],"discriminator":{"propertyName":"type","mapping":{"MchtCmdActivate":"#/components/schemas/MchtCmdActivate","MchtCmdActivation":"#/components/schemas/MchtCmdActivation","MchtCmdOnboard":"#/components/schemas/MchtCmdOnboard","MchtCmdRegisterApplePay":"#/components/schemas/MchtCmdRegisterApplePay","MchtCmdSubmitForReview":"#/components/schemas/MchtCmdSubmitForReview","MchtCmdUnregisterApplePay":"#/components/schemas/MchtCmdUnregisterApplePay"}}},"MchtCmdActivate":{"title":"MchtCmdActivate","description":"Check the business and, where it passes and the merchant is still onboarding, activate it: checkout is switched on, the welcome email is sent and the merchant-activated webhook fires. A merchant that fails the check is left as it was. Does not lift a suspension; `MchtCmdActivation` does.","examples":[{"type":"MchtCmdActivate","skipUboEntry":true}],"type":"object","required":["type","skipUboEntry"],"properties":{"type":{"description":"Always `MchtCmdActivate`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtCmdActivate"]},"skipUboEntry":{"description":"Whether to activate without a complete ultimate-beneficial-owner record. Required, not defaulted: skipping UBO entry is a compliance decision and the platform records who asked for it.","type":"boolean"}}},"MchtCmdActivation":{"title":"MchtCmdActivation","description":"Set whether the merchant is suspended and whether its checkout takes new payments. Both are stated, so one action suspends, lifts a suspension, or turns checkout off or on. Turning checkout on is refused with a 400 while the merchant's business is not verified.","examples":[{"type":"MchtCmdActivation","suspended":true,"checkoutEnabled":true}],"type":"object","required":["type","suspended","checkoutEnabled"],"properties":{"type":{"description":"Always `MchtCmdActivation`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtCmdActivation"]},"suspended":{"description":"Whether the merchant is blocked outright. `false` lifts a suspension.","type":"boolean"},"checkoutEnabled":{"description":"Whether checkout takes new payments. Payments already taken settle either way.","type":"boolean"}}},"MchtCmdCreate":{"title":"MchtCmdCreate","description":"Onboard a merchant that sells: takes payments, settles, and is paid out.","examples":[{"type":"MchtCmdCreate","marketplaceId":"mktp_9f2Kd8QpLzXw","business":{"type":"MchtBusinessAttributes","legalName":"Ada Lovelace","brandName":"Ada Lovelace","businessRegistrationNumber":"example","taxRegistrationNumber":"example","country":"AU","website":"example","contactEmail":"ada@example.com"},"slug":"example","timeZone":"example","referenceMerchantId":"your-own-reference","termsAndConditionsAccepted":true,"tradingCountry":"AU","organisationId":"org_9f2Kd8QpLzXw"}],"type":"object","required":["type","marketplaceId","business","slug","timeZone","termsAndConditionsAccepted"],"properties":{"type":{"description":"Always `MchtCmdCreate`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtCmdCreate"]},"marketplaceId":{"$ref":"#/components/schemas/MktpId","description":"The marketplace to onboard into. Named rather than inferred, an administrator's credential names no marketplace."},"business":{"$ref":"#/components/schemas/MchtBusiness"},"slug":{"type":"string"},"timeZone":{"type":"string"},"referenceMerchantId":{"description":"Your own identifier for this merchant.","type":"string"},"termsAndConditionsAccepted":{"description":"Whether the merchant has accepted the platform's terms. The operation records it against the merchant, so it is stated rather than assumed.","type":"boolean"},"tradingCountry":{"description":"ISO-3166 alpha-2. Only needed when the merchant trades somewhere other than `business.country`.","type":"string"},"organisationId":{"$ref":"#/components/schemas/OrgId","description":"An organisation already in the platform that this merchant is, such as a business already onboarded for another merchant. It must be one you can read on `/organisations`. The merchant shares that organisation's record instead of one being made from `business`, so `business.businessRegistrationNumber` and `business.taxRegistrationNumber` must be left out and `business.country` must be the organisation's country."}}},"MchtCmdCreateSupplier":{"title":"MchtCmdCreateSupplier","description":"Onboard a supplier: a merchant that receives money and never sells.","examples":[{"type":"MchtCmdCreateSupplier","marketplaceId":"mktp_9f2Kd8QpLzXw","business":{"type":"MchtBusinessAttributes","legalName":"Ada Lovelace","brandName":"Ada Lovelace","businessRegistrationNumber":"example","taxRegistrationNumber":"example","country":"AU","website":"example","contactEmail":"ada@example.com"},"referenceMerchantId":"your-own-reference","businessType":"Company","companyType":"example","industry":"example","contact":{"type":"MchtContactAttributes","firstName":"Ada Lovelace","lastName":"Ada Lovelace","title":"example","contactEmail":"ada@example.com","supportEmail":"ada@example.com","phoneNumber":"+61400000000","address":{"type":"MchtAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"}},"bankAccount":{"type":"MchtBankAccountDetailsAttributes","accountName":"Ada Lovelace","accountNumber":"example","routingNumber":"example","bankName":"Ada Lovelace","country":"AU","currency":"AUD","referenceAccountId":"your-own-reference","requesterId":"abc123"},"metadata":{"yourKey":{}},"payoutStatementDescriptor":"ADA COFFEE","organisationId":"org_9f2Kd8QpLzXw"}],"type":"object","required":["type","marketplaceId","business","referenceMerchantId","businessType","bankAccount"],"properties":{"type":{"description":"Always `MchtCmdCreateSupplier`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtCmdCreateSupplier"]},"marketplaceId":{"$ref":"#/components/schemas/MktpId","description":"The marketplace to onboard into. Named rather than inferred, an administrator's credential names no marketplace."},"business":{"$ref":"#/components/schemas/MchtBusiness"},"referenceMerchantId":{"description":"Your own identifier for this supplier. Required, a supplier is created against your reference for it.","type":"string"},"businessType":{"$ref":"#/components/schemas/MchtBusinessType"},"companyType":{"description":"Required when `businessType` is `Company`.","type":"string"},"industry":{"type":"string"},"contact":{"$ref":"#/components/schemas/MchtContact","description":"Who to contact at the supplier."},"bankAccount":{"$ref":"#/components/schemas/MchtBankAccountDetails"},"metadata":{"$ref":"#/components/schemas/Metadata","description":"Free-form data the platform stores and returns untouched."},"payoutStatementDescriptor":{"description":"Default reference on the payout, where the bank shows one.","type":"string"},"organisationId":{"$ref":"#/components/schemas/OrgId","description":"An organisation already in the platform that this merchant is, such as a business already onboarded for another merchant. It must be one you can read on `/organisations`. The merchant shares that organisation's record instead of one being made from `business`, so `business.businessRegistrationNumber` and `business.taxRegistrationNumber` must be left out, `business.country` must be the organisation's country, and `businessType` and `companyType` must agree with it where it states them."}}},"MchtCmdOnboard":{"title":"MchtCmdOnboard","description":"Create this merchant's gateway account and payment profile if it has none. A merchant already onboarded is unchanged.","examples":[{"type":"MchtCmdOnboard"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `MchtCmdOnboard`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtCmdOnboard"]}}},"MchtCmdRegisterApplePay":{"title":"MchtCmdRegisterApplePay","description":"Replace the domains Apple Pay is offered on, send the full list you want. At least one.","examples":[{"type":"MchtCmdRegisterApplePay","domains":["example"]}],"type":"object","required":["type","domains"],"properties":{"type":{"description":"Always `MchtCmdRegisterApplePay`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtCmdRegisterApplePay"]},"domains":{"type":"array","minItems":1,"items":{"type":"string"}}}},"MchtCmdSubmitForReview":{"title":"MchtCmdSubmitForReview","description":"Submit an onboarding merchant for review. Runs no business check and leaves checkout as it is.","examples":[{"type":"MchtCmdSubmitForReview"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `MchtCmdSubmitForReview`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtCmdSubmitForReview"]}}},"MchtCmdUnregisterApplePay":{"title":"MchtCmdUnregisterApplePay","description":"Stop offering Apple Pay on the named domains. At least one.","examples":[{"type":"MchtCmdUnregisterApplePay","domains":["example"]}],"type":"object","required":["type","domains"],"properties":{"type":{"description":"Always `MchtCmdUnregisterApplePay`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtCmdUnregisterApplePay"]},"domains":{"type":"array","minItems":1,"items":{"type":"string"}}}},"MchtCollectionUpdate":{"oneOf":[{"$ref":"#/components/schemas/MchtCollectionUpdateProcessOnboarding"}],"discriminator":{"propertyName":"type","mapping":{"MchtCollectionUpdateProcessOnboarding":"#/components/schemas/MchtCollectionUpdateProcessOnboarding"}}},"MchtCollectionUpdateProcessOnboarding":{"title":"MchtCollectionUpdateProcessOnboarding","description":"Advance every merchant with outstanding gateway onboarding, now rather than on the schedule. Test environments only, a 400 in production.","examples":[{"type":"MchtCollectionUpdateProcessOnboarding"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `MchtCollectionUpdateProcessOnboarding`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtCollectionUpdateProcessOnboarding"]}}},"MchtColumn":{"title":"MchtColumn","type":"string","enum":["Type","MerchantId","OrganisationId","ReferenceMerchantId","Slug","Status","VerificationStatus","BusinessLegalName","BusinessBrandName","BusinessBusinessRegistrationNumber","BusinessTaxRegistrationNumber","BusinessCountry","BusinessWebsite","BusinessContactEmail","TimeZone","PublicProfileBrandName","PublicProfileCardStatementName","PublicProfileSmsSenderName","PublicProfileWebsite","PublicProfileSupportSite","ContactFirstName","ContactLastName","ContactTitle","ContactContactEmail","ContactSupportEmail","ContactPhoneNumber","ContactAddressUnitNumber","ContactAddressStreetNumber","ContactAddressStreetName","ContactAddressStreetType","ContactAddressSuburb","ContactAddressCity","ContactAddressState","ContactAddressPostalCode","ContactAddressCountry","PayoutSettingsSchedule","PayoutSettingsDayOfWeek","PayoutSettingsDayOfMonth","PayoutSettingsDelayDays","PayoutSettingsStatementDescriptor","PayoutSettingsPayoutsEnabled","PayoutSettingsAutomatedPayoutsEnabled","PayoutSettingsAutomatedDisbursementsEnabled","PayoutSettingsRemitterName","BillingSettingsNotificationsEnabled","BillingSettingsAddressUnitNumber","BillingSettingsAddressStreetNumber","BillingSettingsAddressStreetName","BillingSettingsAddressStreetType","BillingSettingsAddressSuburb","BillingSettingsAddressCity","BillingSettingsAddressState","BillingSettingsAddressPostalCode","BillingSettingsAddressCountry","BillingSettingsPaymentSourceId","BrandingLogoFileId","BrandingIconFileId","BrandingLogoAltText","BrandingBrandColour","OrderSettingsNotifyOnPaid","RiskSettingsSettlementType","RiskSettingsBankAccountVerificationRequired","RiskSettingsBankAccountVerificationIncludeResultInResponse","RiskSettingsSourceVerificationEnabled","RiskSettingsPaymentLimitsCurrency","RiskSettingsPaymentLimitsMinimumPaymentAmount","RiskSettingsPaymentLimitsMaximumPaymentAmount","RiskSettingsDisputesWaived","RiskSettingsPayoutPriority","RiskSettingsShowPlatformLogoInTerms","RiskSettingsShowSavedPaymentMethodsInCheckout","RiskSettingsShowReferenceOrderIdToCustomer","RiskSettingsEmailPaymentReceipt","RiskSettingsEmailPaymentFailure","CreatedAt","UpdatedAt"]},"MchtContact":{"oneOf":[{"$ref":"#/components/schemas/MchtContactAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MchtContactAttributes":"#/components/schemas/MchtContactAttributes"}}},"MchtContactAttributes":{"title":"MchtContactAttributes","description":"Who to contact at the business.","examples":[{"type":"MchtContactAttributes","firstName":"Ada Lovelace","lastName":"Ada Lovelace","title":"example","contactEmail":"ada@example.com","supportEmail":"ada@example.com","phoneNumber":"+61400000000","address":{"type":"MchtAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"}}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `MchtContactAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtContactAttributes"]},"firstName":{"type":"string"},"lastName":{"type":"string"},"title":{"type":"string"},"contactEmail":{"type":"string"},"supportEmail":{"type":"string"},"phoneNumber":{"description":"E.164 format, e.g. +61400000000.","type":"string"},"address":{"$ref":"#/components/schemas/MchtAddress","description":"A postal address. Supplying one on a patch replaces the whole address, you cannot patch half of one."}}},"MchtContactPatch":{"description":"Set alongside, where the merchant has no valid contact yet. Omit to leave it as it is.","oneOf":[{"$ref":"#/components/schemas/MchtContactPatchAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MchtContactPatchAttributes":"#/components/schemas/MchtContactPatchAttributes"}}},"MchtContactPatchAttributes":{"title":"MchtContactPatchAttributes","description":"Who to contact at the business. Only the fields sent change.","examples":[{"type":"MchtContactPatchAttributes","firstName":"Ada Lovelace","lastName":"Ada Lovelace","title":"example","contactEmail":"ada@example.com","supportEmail":"ada@example.com","phoneNumber":"+61400000000","address":{"type":"MchtAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"}}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `MchtContactPatchAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtContactPatchAttributes"]},"firstName":{"type":"string"},"lastName":{"type":"string"},"title":{"type":"string"},"contactEmail":{"type":"string"},"supportEmail":{"description":"`null` removes it, and the contact email is used in its place.","type":["string","null"]},"phoneNumber":{"description":"E.164 format, e.g. +61400000000.","type":"string"},"address":{"$ref":"#/components/schemas/MchtAddress","description":"A postal address. Supplying one on a patch replaces the whole address, you cannot patch half of one."}}},"MchtCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/MchtCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MchtCreateRspAttributes":"#/components/schemas/MchtCreateRspAttributes"}}},"MchtCreateRspAttributes":{"title":"MchtCreateRspAttributes","examples":[{"type":"MchtCreateRspAttributes","created":{"type":"MchtViewStandard","merchantId":"mcht_9f2Kd8QpLzXw","organisationId":"org_9f2Kd8QpLzXw","referenceMerchantId":"your-own-reference","slug":"example","status":"Onboarding","verification":{"type":"MchtVerificationAttributes","status":"Pending","errorCodes":["example"],"details":["example"]},"business":{"type":"MchtBusinessAttributes","legalName":"Ada Lovelace","brandName":"Ada Lovelace","businessRegistrationNumber":"example","taxRegistrationNumber":"example","country":"AU","website":"example","contactEmail":"ada@example.com"},"timeZone":"example","publicProfile":{"type":"MchtPublicProfileAttributes","brandName":"Ada Lovelace","cardStatementName":"Ada Lovelace","smsSenderName":"Ada Lovelace","website":"example","supportSite":"example"},"contact":{"type":"MchtContactAttributes","firstName":"Ada Lovelace","lastName":"Ada Lovelace","title":"example","contactEmail":"ada@example.com","supportEmail":"ada@example.com","phoneNumber":"+61400000000","address":{"type":"MchtAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"}},"payoutSettings":{"type":"MchtPayoutSettingsAttributes","schedule":"Daily","dayOfWeek":"example","dayOfMonth":6,"delayDays":1250,"statementDescriptor":"ADA COFFEE","payoutsEnabled":true,"automatedPayoutsEnabled":true,"automatedDisbursementsEnabled":true,"notificationEmails":["ada@example.com"],"remitterName":"Ada Lovelace"},"billingSettings":{"type":"MchtBillingSettingsAttributes","notificationEmails":["ada@example.com"],"notificationsEnabled":true,"address":{"type":"MchtAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"},"paymentSourceId":"psrc_9f2Kd8QpLzXw"},"branding":{"type":"MchtBrandingAttributes","logoFileId":"lfile_9f2Kd8QpLzXw","iconFileId":"lfile_9f2Kd8QpLzXw","logoAltText":"example","brandColour":"example"},"orderSettings":{"type":"MchtOrderSettingsAttributes","customFields":[{"type":"MchtOrderCustomFieldAttributes","key":"example","label":"example","required":true,"visibleToPayer":true}],"notificationEmails":["ada@example.com"],"notifyOnPaid":true},"sourceRules":[{"type":"MchtRuleAttributes","criterion":{"type":"MchtRuleAlways"},"actions":[{"type":"MchtRuleAllow"}]}],"usageRules":{"type":"MchtUsageRulesAttributes","currencies":{"type":"MchtCurrencyAllow","currencies":["AUD"]},"issuerCountries":{"type":"MchtIssuerCountryAllow","countries":["AU"]}},"riskSettings":{"type":"MchtRiskSettingsAttributes","settlementType":"Net","bankAccountVerificationRequired":true,"bankAccountVerification":{"type":"MchtVerificationPolicyAttributes","accept":["Match"],"includeResultInResponse":true},"sourceVerificationEnabled":true,"supportedCustomerTypes":["Consumer"],"paymentLimits":{"type":"MchtPaymentLimitsAttributes","currency":"AUD","minimumPaymentAmount":1250,"maximumPaymentAmount":1250},"disputesWaived":true,"payoutPriority":10,"showPlatformLogoInTerms":true,"showSavedPaymentMethodsInCheckout":true,"showReferenceOrderIdToCustomer":true,"emailPaymentReceipt":true,"emailPaymentFailure":true},"bankAccounts":[{"type":"MchtBankAccountAttributes","externalAccountId":"xacc_9f2Kd8QpLzXw","accountName":"Ada Lovelace","last4":"4242","currency":"AUD","isPrimary":true,"status":"Active","verificationStatus":"Active"}],"capabilityTags":["DirectDebit"],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `MchtCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/MchtView","description":"The resource that was created."}}},"MchtCurrencyAllow":{"title":"MchtCurrencyAllow","description":"Only these currencies are accepted. Everything else is refused.","examples":[{"type":"MchtCurrencyAllow","currencies":["AUD"]}],"type":"object","required":["type","currencies"],"properties":{"type":{"description":"Always `MchtCurrencyAllow`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtCurrencyAllow"]},"currencies":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/IsoCurrency"}}}},"MchtCurrencyBlock":{"title":"MchtCurrencyBlock","description":"These currencies are refused. Everything else is accepted.","examples":[{"type":"MchtCurrencyBlock","currencies":["AUD"]}],"type":"object","required":["type","currencies"],"properties":{"type":{"description":"Always `MchtCurrencyBlock`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtCurrencyBlock"]},"currencies":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/IsoCurrency"}}}},"MchtCurrencyRestriction":{"oneOf":[{"$ref":"#/components/schemas/MchtCurrencyAllow"},{"$ref":"#/components/schemas/MchtCurrencyBlock"}],"discriminator":{"propertyName":"type","mapping":{"MchtCurrencyAllow":"#/components/schemas/MchtCurrencyAllow","MchtCurrencyBlock":"#/components/schemas/MchtCurrencyBlock"}}},"MchtCustomerType":{"title":"MchtCustomerType","type":"string","enum":["Consumer","Organisation","Unknown"]},"MchtId":{"title":"MchtId","examples":["mcht_9f2Kd8QpLzXw"],"type":"string"},"MchtIssuerCountryAllow":{"title":"MchtIssuerCountryAllow","description":"Only cards issued in these countries are accepted.","examples":[{"type":"MchtIssuerCountryAllow","countries":["AU"]}],"type":"object","required":["type","countries"],"properties":{"type":{"description":"Always `MchtIssuerCountryAllow`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtIssuerCountryAllow"]},"countries":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/IsoCountry"}}}},"MchtIssuerCountryBlock":{"title":"MchtIssuerCountryBlock","description":"Cards issued in these countries are refused.","examples":[{"type":"MchtIssuerCountryBlock","countries":["AU"]}],"type":"object","required":["type","countries"],"properties":{"type":{"description":"Always `MchtIssuerCountryBlock`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtIssuerCountryBlock"]},"countries":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/IsoCountry"}}}},"MchtIssuerCountryRestriction":{"oneOf":[{"$ref":"#/components/schemas/MchtIssuerCountryAllow"},{"$ref":"#/components/schemas/MchtIssuerCountryBlock"}],"discriminator":{"propertyName":"type","mapping":{"MchtIssuerCountryAllow":"#/components/schemas/MchtIssuerCountryAllow","MchtIssuerCountryBlock":"#/components/schemas/MchtIssuerCountryBlock"}}},"MchtOnboardingSweep":{"description":"The onboarding sweep was started. It runs asynchronously, so read the merchants back to see what moved.","oneOf":[{"$ref":"#/components/schemas/MchtOnboardingSweepAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MchtOnboardingSweepAttributes":"#/components/schemas/MchtOnboardingSweepAttributes"}}},"MchtOnboardingSweepAttributes":{"title":"MchtOnboardingSweepAttributes","description":"The onboarding sweep was started. It runs asynchronously, so read the merchants back to see what moved.","examples":[{"type":"MchtOnboardingSweepAttributes","started":true}],"type":"object","required":["type","started"],"properties":{"type":{"description":"Always `MchtOnboardingSweepAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtOnboardingSweepAttributes"]},"started":{"description":"Always `true`. Present because a response body that carries nothing cannot gain a field without a breaking change, and a sweep that learns to report counts should not need a new shape.","type":"boolean"}}},"MchtOrderCustomField":{"description":"An extra field captured against an order.","oneOf":[{"$ref":"#/components/schemas/MchtOrderCustomFieldAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MchtOrderCustomFieldAttributes":"#/components/schemas/MchtOrderCustomFieldAttributes"}}},"MchtOrderCustomFieldAttributes":{"title":"MchtOrderCustomFieldAttributes","description":"An extra field captured against an order.","examples":[{"type":"MchtOrderCustomFieldAttributes","key":"example","label":"example","required":true,"visibleToPayer":true}],"type":"object","required":["type","key","label","required","visibleToPayer"],"properties":{"type":{"description":"Always `MchtOrderCustomFieldAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtOrderCustomFieldAttributes"]},"key":{"description":"The key the value is stored and reported under.","type":"string"},"label":{"description":"What the field is called on the order form.","type":"string"},"required":{"description":"Whether the merchant must supply a value when raising a pay-by-link order.","type":"boolean"},"visibleToPayer":{"description":"Whether the field appears on order views and communications sent to the payer.","type":"boolean"}}},"MchtOrderSettings":{"description":"What the merchant collects on an order, and who is told about it.","oneOf":[{"$ref":"#/components/schemas/MchtOrderSettingsAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MchtOrderSettingsAttributes":"#/components/schemas/MchtOrderSettingsAttributes"}}},"MchtOrderSettingsAttributes":{"title":"MchtOrderSettingsAttributes","description":"What the merchant collects on an order, and who is told about it.","examples":[{"type":"MchtOrderSettingsAttributes","customFields":[{"type":"MchtOrderCustomFieldAttributes","key":"example","label":"example","required":true,"visibleToPayer":true}],"notificationEmails":["ada@example.com"],"notifyOnPaid":true}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `MchtOrderSettingsAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtOrderSettingsAttributes"]},"customFields":{"description":"Extra fields captured against an order. Sending the list replaces it.","type":"array","items":{"$ref":"#/components/schemas/MchtOrderCustomField"}},"notificationEmails":{"type":"array","items":{"type":"string"}},"notifyOnPaid":{"description":"Email the merchant when an order is paid.","type":"boolean"}}},"MchtOrderSettingsPatch":{"description":"What the merchant collects on an order, and who is told about it. Only the fields sent change.","oneOf":[{"$ref":"#/components/schemas/MchtOrderSettingsPatchAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MchtOrderSettingsPatchAttributes":"#/components/schemas/MchtOrderSettingsPatchAttributes"}}},"MchtOrderSettingsPatchAttributes":{"title":"MchtOrderSettingsPatchAttributes","description":"What the merchant collects on an order, and who is told about it. Only the fields sent change.","examples":[{"type":"MchtOrderSettingsPatchAttributes","customFields":[{"type":"MchtOrderCustomFieldAttributes","key":"example","label":"example","required":true,"visibleToPayer":true}],"notificationEmails":["ada@example.com"],"notifyOnPaid":true}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `MchtOrderSettingsPatchAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtOrderSettingsPatchAttributes"]},"customFields":{"description":"Extra fields captured against an order. Sending the list replaces it.","type":"array","items":{"$ref":"#/components/schemas/MchtOrderCustomField"}},"notificationEmails":{"description":"Sending the list replaces it.","type":"array","items":{"type":"string"}},"notifyOnPaid":{"description":"Email the merchant when an order is paid.","type":"boolean"}}},"MchtPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/MchtPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MchtPageAttributes":"#/components/schemas/MchtPageAttributes"}}},"MchtPageAttributes":{"title":"MchtPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"MchtPageAttributes","data":[{"type":"MchtViewStandard","merchantId":"mcht_9f2Kd8QpLzXw","organisationId":"org_9f2Kd8QpLzXw","referenceMerchantId":"your-own-reference","slug":"example","status":"Onboarding","verification":{"type":"MchtVerificationAttributes","status":"Pending","errorCodes":["example"],"details":["example"]},"business":{"type":"MchtBusinessAttributes","legalName":"Ada Lovelace","brandName":"Ada Lovelace","businessRegistrationNumber":"example","taxRegistrationNumber":"example","country":"AU","website":"example","contactEmail":"ada@example.com"},"timeZone":"example","publicProfile":{"type":"MchtPublicProfileAttributes","brandName":"Ada Lovelace","cardStatementName":"Ada Lovelace","smsSenderName":"Ada Lovelace","website":"example","supportSite":"example"},"contact":{"type":"MchtContactAttributes","firstName":"Ada Lovelace","lastName":"Ada Lovelace","title":"example","contactEmail":"ada@example.com","supportEmail":"ada@example.com","phoneNumber":"+61400000000","address":{"type":"MchtAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"}},"payoutSettings":{"type":"MchtPayoutSettingsAttributes","schedule":"Daily","dayOfWeek":"example","dayOfMonth":6,"delayDays":1250,"statementDescriptor":"ADA COFFEE","payoutsEnabled":true,"automatedPayoutsEnabled":true,"automatedDisbursementsEnabled":true,"notificationEmails":["ada@example.com"],"remitterName":"Ada Lovelace"},"billingSettings":{"type":"MchtBillingSettingsAttributes","notificationEmails":["ada@example.com"],"notificationsEnabled":true,"address":{"type":"MchtAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"},"paymentSourceId":"psrc_9f2Kd8QpLzXw"},"branding":{"type":"MchtBrandingAttributes","logoFileId":"lfile_9f2Kd8QpLzXw","iconFileId":"lfile_9f2Kd8QpLzXw","logoAltText":"example","brandColour":"example"},"orderSettings":{"type":"MchtOrderSettingsAttributes","customFields":[{"type":"MchtOrderCustomFieldAttributes","key":"example","label":"example","required":true,"visibleToPayer":true}],"notificationEmails":["ada@example.com"],"notifyOnPaid":true},"sourceRules":[{"type":"MchtRuleAttributes","criterion":{"type":"MchtRuleAlways"},"actions":[{"type":"MchtRuleAllow"}]}],"usageRules":{"type":"MchtUsageRulesAttributes","currencies":{"type":"MchtCurrencyAllow","currencies":["AUD"]},"issuerCountries":{"type":"MchtIssuerCountryAllow","countries":["AU"]}},"riskSettings":{"type":"MchtRiskSettingsAttributes","settlementType":"Net","bankAccountVerificationRequired":true,"bankAccountVerification":{"type":"MchtVerificationPolicyAttributes","accept":["Match"],"includeResultInResponse":true},"sourceVerificationEnabled":true,"supportedCustomerTypes":["Consumer"],"paymentLimits":{"type":"MchtPaymentLimitsAttributes","currency":"AUD","minimumPaymentAmount":1250,"maximumPaymentAmount":1250},"disputesWaived":true,"payoutPriority":10,"showPlatformLogoInTerms":true,"showSavedPaymentMethodsInCheckout":true,"showReferenceOrderIdToCustomer":true,"emailPaymentReceipt":true,"emailPaymentFailure":true},"bankAccounts":[{"type":"MchtBankAccountAttributes","externalAccountId":"xacc_9f2Kd8QpLzXw","accountName":"Ada Lovelace","last4":"4242","currency":"AUD","isPrimary":true,"status":"Active","verificationStatus":"Active"}],"capabilityTags":["DirectDebit"],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `MchtPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/MchtView"}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"MchtPaymentLimits":{"description":"The band of payment sizes the checkout will accept.","oneOf":[{"$ref":"#/components/schemas/MchtPaymentLimitsAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MchtPaymentLimitsAttributes":"#/components/schemas/MchtPaymentLimitsAttributes"}}},"MchtPaymentLimitsAttributes":{"title":"MchtPaymentLimitsAttributes","description":"The smallest and largest payments a checkout accepts. Both are in the single currency given here.","examples":[{"type":"MchtPaymentLimitsAttributes","currency":"AUD","minimumPaymentAmount":1250,"maximumPaymentAmount":1250}],"type":"object","required":["type","currency"],"properties":{"type":{"description":"Always `MchtPaymentLimitsAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtPaymentLimitsAttributes"]},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"minimumPaymentAmount":{"$ref":"#/components/schemas/MinorUnits","description":"Smallest payment the checkout will accept."},"maximumPaymentAmount":{"$ref":"#/components/schemas/MinorUnits","description":"Largest payment the checkout will accept."}}},"MchtPayoutSchedule":{"title":"MchtPayoutSchedule","type":"string","enum":["Daily","Weekly","Fortnightly","Monthly","Unknown"]},"MchtPayoutSettings":{"description":"When and how the merchant is paid out.","oneOf":[{"$ref":"#/components/schemas/MchtPayoutSettingsAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MchtPayoutSettingsAttributes":"#/components/schemas/MchtPayoutSettingsAttributes"}}},"MchtPayoutSettingsAttributes":{"title":"MchtPayoutSettingsAttributes","description":"When and how the merchant is paid out.","examples":[{"type":"MchtPayoutSettingsAttributes","schedule":"Daily","dayOfWeek":"example","dayOfMonth":6,"delayDays":1250,"statementDescriptor":"ADA COFFEE","payoutsEnabled":true,"automatedPayoutsEnabled":true,"automatedDisbursementsEnabled":true,"notificationEmails":["ada@example.com"],"remitterName":"Ada Lovelace"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `MchtPayoutSettingsAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtPayoutSettingsAttributes"]},"schedule":{"$ref":"#/components/schemas/MchtPayoutSchedule"},"dayOfWeek":{"description":"Required when `schedule` is `Weekly`.","type":"string"},"dayOfMonth":{"description":"Required when `schedule` is `Monthly`.","type":"integer","format":"int32"},"delayDays":{"description":"Business days to hold funds beyond the schedule before paying out: one to four.","type":"integer","format":"int32"},"statementDescriptor":{"description":"Default reference on the payout, where the bank shows one.","type":"string"},"payoutsEnabled":{"description":"Turn payouts off without changing the schedule.","type":"boolean"},"automatedPayoutsEnabled":{"description":"Read-only. Whether the platform raises payouts on the schedule, or the merchant asks for each one.","type":"boolean"},"automatedDisbursementsEnabled":{"description":"Read-only. Whether the platform sends the money, or someone pays it out of band and records it afterwards. This is what decides whether `PayoutUpdateRecordManualPayment` is accepted.","type":"boolean"},"notificationEmails":{"type":"array","items":{"type":"string"}},"remitterName":{"description":"The party named as the remitter on outgoing payments, where it differs from the merchant.","type":"string"}}},"MchtPayoutSettingsPatch":{"description":"When and how the merchant is paid out. Only the fields sent change.","oneOf":[{"$ref":"#/components/schemas/MchtPayoutSettingsPatchAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MchtPayoutSettingsPatchAttributes":"#/components/schemas/MchtPayoutSettingsPatchAttributes"}}},"MchtPayoutSettingsPatchAttributes":{"title":"MchtPayoutSettingsPatchAttributes","description":"When and how the merchant is paid out. Only the fields sent change.","examples":[{"type":"MchtPayoutSettingsPatchAttributes","schedule":"Daily","dayOfWeek":"example","dayOfMonth":6,"delayDays":1250,"statementDescriptor":"ADA COFFEE","payoutsEnabled":true,"notificationEmails":["ada@example.com"],"remitterName":"Ada Lovelace"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `MchtPayoutSettingsPatchAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtPayoutSettingsPatchAttributes"]},"schedule":{"$ref":"#/components/schemas/MchtPayoutSchedule"},"dayOfWeek":{"description":"Required when `schedule` is `Weekly` or `Fortnightly`, unless the merchant already has one.","type":"string"},"dayOfMonth":{"description":"Required when `schedule` is `Monthly`, unless the merchant already has one.","type":"integer","format":"int32"},"delayDays":{"description":"Business days to hold funds beyond the schedule before paying out: one to four.","type":"integer","format":"int32"},"statementDescriptor":{"description":"Default reference on the payout, where the bank shows one. `null` removes it.","type":["string","null"]},"payoutsEnabled":{"description":"Turn payouts off without changing the schedule.","type":"boolean"},"notificationEmails":{"description":"Sending the list replaces it.","type":"array","items":{"type":"string"}},"remitterName":{"description":"The party named as the remitter on outgoing payments, where it differs from the merchant. `null` removes it.","type":["string","null"]}}},"MchtPublicProfile":{"description":"How the business presents to a payer.","oneOf":[{"$ref":"#/components/schemas/MchtPublicProfileAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MchtPublicProfileAttributes":"#/components/schemas/MchtPublicProfileAttributes"}}},"MchtPublicProfileAttributes":{"title":"MchtPublicProfileAttributes","description":"How the business presents to a payer.","examples":[{"type":"MchtPublicProfileAttributes","brandName":"Ada Lovelace","cardStatementName":"Ada Lovelace","smsSenderName":"Ada Lovelace","website":"example","supportSite":"example"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `MchtPublicProfileAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtPublicProfileAttributes"]},"brandName":{"description":"The customer-facing name of the business.","type":"string"},"cardStatementName":{"description":"What appears on a card statement. Letters, numbers and spaces only.","type":"string"},"smsSenderName":{"description":"Sender name on SMS. Letters and digits only.","type":"string"},"website":{"type":"string"},"supportSite":{"type":"string"}}},"MchtPublicProfilePatch":{"description":"Set alongside, where the merchant has no valid presentation yet. Omit to leave it as it is.","oneOf":[{"$ref":"#/components/schemas/MchtPublicProfilePatchAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MchtPublicProfilePatchAttributes":"#/components/schemas/MchtPublicProfilePatchAttributes"}}},"MchtPublicProfilePatchAttributes":{"title":"MchtPublicProfilePatchAttributes","description":"How the business presents to a payer. Only the fields sent change, and every one of them always has a value.","examples":[{"type":"MchtPublicProfilePatchAttributes","brandName":"Ada Lovelace","cardStatementName":"Ada Lovelace","smsSenderName":"Ada Lovelace","website":"example","supportSite":"example"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `MchtPublicProfilePatchAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtPublicProfilePatchAttributes"]},"brandName":{"description":"The customer-facing name of the business.","type":"string"},"cardStatementName":{"description":"What appears on a card statement. Letters, numbers and spaces only.","type":"string"},"smsSenderName":{"description":"Sender name on SMS. Letters and digits only.","type":"string"},"website":{"type":"string"},"supportSite":{"type":"string"}}},"MchtRiskSettings":{"description":"Risk, settlement and verification policy for a merchant.","oneOf":[{"$ref":"#/components/schemas/MchtRiskSettingsAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MchtRiskSettingsAttributes":"#/components/schemas/MchtRiskSettingsAttributes"}}},"MchtRiskSettingsAttributes":{"title":"MchtRiskSettingsAttributes","description":"Risk, settlement and verification policy for a merchant.","examples":[{"type":"MchtRiskSettingsAttributes","settlementType":"Net","bankAccountVerificationRequired":true,"bankAccountVerification":{"type":"MchtVerificationPolicyAttributes","accept":["Match"],"includeResultInResponse":true},"sourceVerificationEnabled":true,"supportedCustomerTypes":["Consumer"],"paymentLimits":{"type":"MchtPaymentLimitsAttributes","currency":"AUD","minimumPaymentAmount":1250,"maximumPaymentAmount":1250},"disputesWaived":true,"payoutPriority":10,"showPlatformLogoInTerms":true,"showSavedPaymentMethodsInCheckout":true,"showReferenceOrderIdToCustomer":true,"emailPaymentReceipt":true,"emailPaymentFailure":true}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `MchtRiskSettingsAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtRiskSettingsAttributes"]},"settlementType":{"$ref":"#/components/schemas/MchtSettlementType","description":"`Net` rolls platform fees into each payout; `Gross` invoices them separately."},"bankAccountVerificationRequired":{"description":"Whether a bank account must be verified before it can be used.","type":"boolean"},"bankAccountVerification":{"$ref":"#/components/schemas/MchtVerificationPolicy"},"sourceVerificationEnabled":{"description":"Ask a payer to confirm a small debit before their source is used, 3DS's belt and braces.","type":"boolean"},"supportedCustomerTypes":{"description":"Which kinds of customer this merchant sells to.","type":"array","items":{"$ref":"#/components/schemas/MchtCustomerType"}},"paymentLimits":{"$ref":"#/components/schemas/MchtPaymentLimits"},"disputesWaived":{"description":"Do not charge this merchant for disputes.","type":"boolean"},"payoutPriority":{"description":"Higher values are paid out ahead of lower ones.","type":"integer","format":"int32"},"showPlatformLogoInTerms":{"description":"Show the platform's logo on the terms page shown to payers.","type":"boolean"},"showSavedPaymentMethodsInCheckout":{"description":"Offer the payer their saved payment sources in the checkout.","type":"boolean"},"showReferenceOrderIdToCustomer":{"description":"Show the merchant's own order reference on communications to the payer.","type":"boolean"},"emailPaymentReceipt":{"description":"Email the payer a receipt when an order is paid.","type":"boolean"},"emailPaymentFailure":{"description":"Email the payer after a failed attempt.","type":"boolean"}}},"MchtRule":{"description":"One source rule: what to do, and when it applies.","oneOf":[{"$ref":"#/components/schemas/MchtRuleAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MchtRuleAttributes":"#/components/schemas/MchtRuleAttributes"}}},"MchtRuleAction":{"oneOf":[{"$ref":"#/components/schemas/MchtRuleAllow"},{"$ref":"#/components/schemas/MchtRuleDisallow"},{"$ref":"#/components/schemas/MchtRuleImposePlatformFee"},{"$ref":"#/components/schemas/MchtRuleSurchargeExplicitFee"},{"$ref":"#/components/schemas/MchtRuleSurchargePlatformFee"},{"$ref":"#/components/schemas/MchtRuleSurchargeScaledFee"}],"discriminator":{"propertyName":"type","mapping":{"MchtRuleAllow":"#/components/schemas/MchtRuleAllow","MchtRuleDisallow":"#/components/schemas/MchtRuleDisallow","MchtRuleImposePlatformFee":"#/components/schemas/MchtRuleImposePlatformFee","MchtRuleSurchargeExplicitFee":"#/components/schemas/MchtRuleSurchargeExplicitFee","MchtRuleSurchargePlatformFee":"#/components/schemas/MchtRuleSurchargePlatformFee","MchtRuleSurchargeScaledFee":"#/components/schemas/MchtRuleSurchargeScaledFee"}}},"MchtRuleAllow":{"title":"MchtRuleAllow","description":"Allow payments matching the criterion.","examples":[{"type":"MchtRuleAllow"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `MchtRuleAllow`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtRuleAllow"]}}},"MchtRuleAlways":{"title":"MchtRuleAlways","description":"Always matches. Use it for the fallback rule.","examples":[{"type":"MchtRuleAlways"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `MchtRuleAlways`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtRuleAlways"]}}},"MchtRuleAnd":{"title":"MchtRuleAnd","description":"Matches when every nested criterion matches.","examples":[{"type":"MchtRuleAnd","criteria":[{}]}],"type":"object","required":["type","criteria"],"properties":{"type":{"description":"Always `MchtRuleAnd`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtRuleAnd"]},"criteria":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/MchtRuleCriterion"}}}},"MchtRuleAttributes":{"title":"MchtRuleAttributes","description":"One source rule: what to do, and when it applies.","examples":[{"type":"MchtRuleAttributes","criterion":{"type":"MchtRuleAlways"},"actions":[{"type":"MchtRuleAllow"}]}],"type":"object","required":["type","criterion","actions"],"properties":{"type":{"description":"Always `MchtRuleAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtRuleAttributes"]},"criterion":{"$ref":"#/components/schemas/MchtRuleCriterion"},"actions":{"description":"Every action to take when the criterion matches. At least one.","type":"array","minItems":1,"items":{"$ref":"#/components/schemas/MchtRuleAction"}}}},"MchtRuleCriterion":{"oneOf":[{"$ref":"#/components/schemas/MchtRuleAlways"},{"$ref":"#/components/schemas/MchtRuleAnd"},{"$ref":"#/components/schemas/MchtRuleForBinGroups"},{"$ref":"#/components/schemas/MchtRuleForCardBrand"},{"$ref":"#/components/schemas/MchtRuleForCardFunding"},{"$ref":"#/components/schemas/MchtRuleForCardPrepaid"},{"$ref":"#/components/schemas/MchtRuleForCurrency"},{"$ref":"#/components/schemas/MchtRuleForCustomerType"},{"$ref":"#/components/schemas/MchtRuleForIssuerCountry"},{"$ref":"#/components/schemas/MchtRuleForMethodType"},{"$ref":"#/components/schemas/MchtRuleForPayPlanVariant"},{"$ref":"#/components/schemas/MchtRuleForPayType"},{"$ref":"#/components/schemas/MchtRuleForProductType"},{"$ref":"#/components/schemas/MchtRuleForSchemeProduct"},{"$ref":"#/components/schemas/MchtRuleNot"},{"$ref":"#/components/schemas/MchtRuleOr"}],"discriminator":{"propertyName":"type","mapping":{"MchtRuleAlways":"#/components/schemas/MchtRuleAlways","MchtRuleAnd":"#/components/schemas/MchtRuleAnd","MchtRuleForBinGroups":"#/components/schemas/MchtRuleForBinGroups","MchtRuleForCardBrand":"#/components/schemas/MchtRuleForCardBrand","MchtRuleForCardFunding":"#/components/schemas/MchtRuleForCardFunding","MchtRuleForCardPrepaid":"#/components/schemas/MchtRuleForCardPrepaid","MchtRuleForCurrency":"#/components/schemas/MchtRuleForCurrency","MchtRuleForCustomerType":"#/components/schemas/MchtRuleForCustomerType","MchtRuleForIssuerCountry":"#/components/schemas/MchtRuleForIssuerCountry","MchtRuleForMethodType":"#/components/schemas/MchtRuleForMethodType","MchtRuleForPayPlanVariant":"#/components/schemas/MchtRuleForPayPlanVariant","MchtRuleForPayType":"#/components/schemas/MchtRuleForPayType","MchtRuleForProductType":"#/components/schemas/MchtRuleForProductType","MchtRuleForSchemeProduct":"#/components/schemas/MchtRuleForSchemeProduct","MchtRuleNot":"#/components/schemas/MchtRuleNot","MchtRuleOr":"#/components/schemas/MchtRuleOr"}}},"MchtRuleCustomerType":{"title":"MchtRuleCustomerType","type":"string","enum":["Consumer","Organisation","Unknown"]},"MchtRuleDisallow":{"title":"MchtRuleDisallow","description":"Refuse payments matching the criterion.","examples":[{"type":"MchtRuleDisallow"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `MchtRuleDisallow`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtRuleDisallow"]}}},"MchtRuleForBinGroups":{"title":"MchtRuleForBinGroups","description":"Matches cards in any of these BIN groups.","examples":[{"type":"MchtRuleForBinGroups","binGroupIds":["bing_9f2Kd8QpLzXw"]}],"type":"object","required":["type","binGroupIds"],"properties":{"type":{"description":"Always `MchtRuleForBinGroups`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtRuleForBinGroups"]},"binGroupIds":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/MchtBinGroupId"}}}},"MchtRuleForCardBrand":{"title":"MchtRuleForCardBrand","description":"Matches this card brand.","examples":[{"type":"MchtRuleForCardBrand","cardBrand":"Visa"}],"type":"object","required":["type","cardBrand"],"properties":{"type":{"description":"Always `MchtRuleForCardBrand`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtRuleForCardBrand"]},"cardBrand":{"$ref":"#/components/schemas/CardBrand"}}},"MchtRuleForCardFunding":{"title":"MchtRuleForCardFunding","description":"Matches cards with this funding source.","examples":[{"type":"MchtRuleForCardFunding","cardFunding":"Credit"}],"type":"object","required":["type","cardFunding"],"properties":{"type":{"description":"Always `MchtRuleForCardFunding`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtRuleForCardFunding"]},"cardFunding":{"$ref":"#/components/schemas/CardFunding"}}},"MchtRuleForCardPrepaid":{"title":"MchtRuleForCardPrepaid","description":"Matches prepaid cards, or matches everything but them.","examples":[{"type":"MchtRuleForCardPrepaid","isPrepaid":true}],"type":"object","required":["type","isPrepaid"],"properties":{"type":{"description":"Always `MchtRuleForCardPrepaid`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtRuleForCardPrepaid"]},"isPrepaid":{"type":"boolean"}}},"MchtRuleForCurrency":{"title":"MchtRuleForCurrency","description":"Matches payments in this currency.","examples":[{"type":"MchtRuleForCurrency","currency":"AUD"}],"type":"object","required":["type","currency"],"properties":{"type":{"description":"Always `MchtRuleForCurrency`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtRuleForCurrency"]},"currency":{"$ref":"#/components/schemas/IsoCurrency"}}},"MchtRuleForCustomerType":{"title":"MchtRuleForCustomerType","description":"Matches payments by this kind of customer.","examples":[{"type":"MchtRuleForCustomerType","customerType":"Consumer"}],"type":"object","required":["type","customerType"],"properties":{"type":{"description":"Always `MchtRuleForCustomerType`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtRuleForCustomerType"]},"customerType":{"$ref":"#/components/schemas/MchtRuleCustomerType"}}},"MchtRuleForIssuerCountry":{"title":"MchtRuleForIssuerCountry","description":"Matches cards issued in this country.","examples":[{"type":"MchtRuleForIssuerCountry","country":"AU"}],"type":"object","required":["type","country"],"properties":{"type":{"description":"Always `MchtRuleForIssuerCountry`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtRuleForIssuerCountry"]},"country":{"$ref":"#/components/schemas/IsoCountry"}}},"MchtRuleForMethodType":{"title":"MchtRuleForMethodType","description":"Matches this payment method.","examples":[{"type":"MchtRuleForMethodType","methodType":"Card"}],"type":"object","required":["type","methodType"],"properties":{"type":{"description":"Always `MchtRuleForMethodType`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtRuleForMethodType"]},"methodType":{"$ref":"#/components/schemas/MchtRuleMethodType"}}},"MchtRuleForPayPlanVariant":{"title":"MchtRuleForPayPlanVariant","description":"Matches this pay-plan variant.","examples":[{"type":"MchtRuleForPayPlanVariant","payPlanVariant":"Fortnightly4"}],"type":"object","required":["type","payPlanVariant"],"properties":{"type":{"description":"Always `MchtRuleForPayPlanVariant`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtRuleForPayPlanVariant"]},"payPlanVariant":{"$ref":"#/components/schemas/MchtRulePayPlanVariant"}}},"MchtRuleForPayType":{"title":"MchtRuleForPayType","description":"Matches this way of paying.","examples":[{"type":"MchtRuleForPayType","payType":"PayCard"}],"type":"object","required":["type","payType"],"properties":{"type":{"description":"Always `MchtRuleForPayType`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtRuleForPayType"]},"payType":{"$ref":"#/components/schemas/MchtRulePayType"}}},"MchtRuleForProductType":{"title":"MchtRuleForProductType","description":"Matches cards of this product type.","examples":[{"type":"MchtRuleForProductType","productType":"Consumer"}],"type":"object","required":["type","productType"],"properties":{"type":{"description":"Always `MchtRuleForProductType`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtRuleForProductType"]},"productType":{"$ref":"#/components/schemas/CardProductType"}}},"MchtRuleForSchemeProduct":{"title":"MchtRuleForSchemeProduct","description":"Matches cards of this scheme product.","examples":[{"type":"MchtRuleForSchemeProduct","schemeProduct":"MasterCardCrPer"}],"type":"object","required":["type","schemeProduct"],"properties":{"type":{"description":"Always `MchtRuleForSchemeProduct`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtRuleForSchemeProduct"]},"schemeProduct":{"$ref":"#/components/schemas/CardSchemeProduct"}}},"MchtRuleImposePlatformFee":{"title":"MchtRuleImposePlatformFee","description":"Charge the merchant a platform fee of this shape.","examples":[{"type":"MchtRuleImposePlatformFee","fixed":1250,"rate":0.9412}],"type":"object","required":["type","fixed","rate"],"properties":{"type":{"description":"Always `MchtRuleImposePlatformFee`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtRuleImposePlatformFee"]},"fixed":{"$ref":"#/components/schemas/MinorUnits","description":"A fixed amount, in the minor units of the payment's currency."},"rate":{"description":"A rate applied to the payment amount, as a decimal fraction, 0.0175 is 1.75%.","type":"number"}}},"MchtRuleMethodType":{"title":"MchtRuleMethodType","type":"string","enum":["Card","DirectDebit","BankTransfer","PayTo","Unknown"]},"MchtRuleNot":{"title":"MchtRuleNot","description":"Matches when the nested criterion does not.","examples":[{"type":"MchtRuleNot","criterion":{}}],"type":"object","required":["type","criterion"],"properties":{"type":{"description":"Always `MchtRuleNot`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtRuleNot"]},"criterion":{"$ref":"#/components/schemas/MchtRuleCriterion"}}},"MchtRuleOr":{"title":"MchtRuleOr","description":"Matches when any nested criterion matches.","examples":[{"type":"MchtRuleOr","criteria":[{}]}],"type":"object","required":["type","criteria"],"properties":{"type":{"description":"Always `MchtRuleOr`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtRuleOr"]},"criteria":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/MchtRuleCriterion"}}}},"MchtRulePayPlanVariant":{"title":"MchtRulePayPlanVariant","type":"string","enum":["Fortnightly4","Weekly4","Weekly8","Fortnightly26","Weekly52","Monthly2","Monthly3","Monthly4","Monthly5","Monthly6","Monthly7","Monthly8","Monthly9","Monthly10","Monthly11","Monthly12","FortnightlyDeferred","Weekly4Deferred","Weekly7Deferred","Days30Deferred","Unknown"]},"MchtRulePayType":{"title":"MchtRulePayType","type":"string","enum":["PayCard","PayPlan","Unknown"]},"MchtRuleSurchargeExplicitFee":{"title":"MchtRuleSurchargeExplicitFee","description":"Pass a surcharge of this shape to the payer.","examples":[{"type":"MchtRuleSurchargeExplicitFee","fixed":1250,"rate":0.9412}],"type":"object","required":["type","fixed","rate"],"properties":{"type":{"description":"Always `MchtRuleSurchargeExplicitFee`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtRuleSurchargeExplicitFee"]},"fixed":{"$ref":"#/components/schemas/MinorUnits","description":"A fixed amount, in the minor units of the payment's currency."},"rate":{"description":"A rate applied to the payment amount, as a decimal fraction, 0.0175 is 1.75%.","type":"number"}}},"MchtRuleSurchargePlatformFee":{"title":"MchtRuleSurchargePlatformFee","description":"Pass on exactly the platform fee this payment attracts.","examples":[{"type":"MchtRuleSurchargePlatformFee"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `MchtRuleSurchargePlatformFee`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtRuleSurchargePlatformFee"]}}},"MchtRuleSurchargeScaledFee":{"title":"MchtRuleSurchargeScaledFee","description":"Pass on a multiple of the platform fee this payment attracts.","examples":[{"type":"MchtRuleSurchargeScaledFee","multiplier":12.5}],"type":"object","required":["type","multiplier"],"properties":{"type":{"description":"Always `MchtRuleSurchargeScaledFee`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtRuleSurchargeScaledFee"]},"multiplier":{"description":"`1.0` passes on exactly the platform fee; `1.1` passes on ten per cent more.","type":"number"}}},"MchtSettlementType":{"title":"MchtSettlementType","type":"string","enum":["Net","Gross","Unknown"]},"MchtSort":{"title":"MchtSort","type":"string","enum":["createdAt","-createdAt","updatedAt","-updatedAt"]},"MchtStatus":{"title":"MchtStatus","type":"string","enum":["Onboarding","OnboardingReview","Active","CheckoutDisabled","Suspended","Closed","Unknown"]},"MchtStringMap":{"title":"MchtStringMap","examples":[{"yourKey":"example"}],"type":"object","additionalProperties":{"type":"string"}},"MchtUpdate":{"oneOf":[{"$ref":"#/components/schemas/MchtUpdateBillingSettings"},{"$ref":"#/components/schemas/MchtUpdateBranding"},{"$ref":"#/components/schemas/MchtUpdateBusinessProfile"},{"$ref":"#/components/schemas/MchtUpdateMetadata"},{"$ref":"#/components/schemas/MchtUpdateOrderSettings"},{"$ref":"#/components/schemas/MchtUpdateOrganisation"},{"$ref":"#/components/schemas/MchtUpdatePayoutSettings"}],"discriminator":{"propertyName":"type","mapping":{"MchtUpdateBillingSettings":"#/components/schemas/MchtUpdateBillingSettings","MchtUpdateBranding":"#/components/schemas/MchtUpdateBranding","MchtUpdateBusinessProfile":"#/components/schemas/MchtUpdateBusinessProfile","MchtUpdateMetadata":"#/components/schemas/MchtUpdateMetadata","MchtUpdateOrderSettings":"#/components/schemas/MchtUpdateOrderSettings","MchtUpdateOrganisation":"#/components/schemas/MchtUpdateOrganisation","MchtUpdatePayoutSettings":"#/components/schemas/MchtUpdatePayoutSettings"}}},"MchtUpdateBillingSettings":{"title":"MchtUpdateBillingSettings","description":"Change where billing notifications go and what address they carry.","examples":[{"type":"MchtUpdateBillingSettings","billingSettings":{"type":"MchtBillingSettingsPatchAttributes","notificationEmails":["ada@example.com"],"notificationsEnabled":true,"address":{"type":"MchtAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"},"paymentSourceId":"psrc_9f2Kd8QpLzXw"}}],"type":"object","required":["type","billingSettings"],"properties":{"type":{"description":"Always `MchtUpdateBillingSettings`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtUpdateBillingSettings"]},"billingSettings":{"$ref":"#/components/schemas/MchtBillingSettingsPatch"}}},"MchtUpdateBranding":{"title":"MchtUpdateBranding","description":"Change the logo, icon and brand colour a payer sees.","examples":[{"type":"MchtUpdateBranding","branding":{"type":"MchtBrandingPatchAttributes","logoFileId":"lfile_9f2Kd8QpLzXw","iconFileId":"lfile_9f2Kd8QpLzXw","logoAltText":"example","brandColour":"example"}}],"type":"object","required":["type","branding"],"properties":{"type":{"description":"Always `MchtUpdateBranding`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtUpdateBranding"]},"branding":{"$ref":"#/components/schemas/MchtBrandingPatch"}}},"MchtUpdateBusinessProfile":{"title":"MchtUpdateBusinessProfile","description":"Change the merchant's legal identity: registration, tax numbers, trading country.","examples":[{"type":"MchtUpdateBusinessProfile","businessProfile":{"type":"MchtBusinessProfilePatchAttributes","legalName":"Ada Lovelace","businessType":"Company","companyType":"example","businessRegistrationNumber":"example","taxRegistrationNumber":"example","industry":"example","tradingCountry":"AU","timeZone":"example"},"publicProfile":{"type":"MchtPublicProfilePatchAttributes","brandName":"Ada Lovelace","cardStatementName":"Ada Lovelace","smsSenderName":"Ada Lovelace","website":"example","supportSite":"example"},"contact":{"type":"MchtContactPatchAttributes","firstName":"Ada Lovelace","lastName":"Ada Lovelace","title":"example","contactEmail":"ada@example.com","supportEmail":"ada@example.com","phoneNumber":"+61400000000","address":{"type":"MchtAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"}}}],"type":"object","required":["type","businessProfile"],"properties":{"type":{"description":"Always `MchtUpdateBusinessProfile`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtUpdateBusinessProfile"]},"businessProfile":{"$ref":"#/components/schemas/MchtBusinessProfilePatch"},"publicProfile":{"$ref":"#/components/schemas/MchtPublicProfilePatch"},"contact":{"$ref":"#/components/schemas/MchtContactPatch"}}},"MchtUpdateMetadata":{"title":"MchtUpdateMetadata","description":"Replace the free-form data the platform stores and returns untouched.","examples":[{"type":"MchtUpdateMetadata","metadata":{"yourKey":{}}}],"type":"object","required":["type","metadata"],"properties":{"type":{"description":"Always `MchtUpdateMetadata`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtUpdateMetadata"]},"metadata":{"$ref":"#/components/schemas/Metadata","description":"Free-form data the platform stores and returns untouched. Values may be nested objects and arrays."}}},"MchtUpdateOrderSettings":{"title":"MchtUpdateOrderSettings","description":"Change the custom fields and notifications attached to this merchant's orders.","examples":[{"type":"MchtUpdateOrderSettings","orderSettings":{"type":"MchtOrderSettingsPatchAttributes","customFields":[{"type":"MchtOrderCustomFieldAttributes","key":"example","label":"example","required":true,"visibleToPayer":true}],"notificationEmails":["ada@example.com"],"notifyOnPaid":true}}],"type":"object","required":["type","orderSettings"],"properties":{"type":{"description":"Always `MchtUpdateOrderSettings`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtUpdateOrderSettings"]},"orderSettings":{"$ref":"#/components/schemas/MchtOrderSettingsPatch"}}},"MchtUpdateOrganisation":{"title":"MchtUpdateOrganisation","description":"Point the merchant at another existing organisation, for example where a duplicate record was made by mistake. It must be one you can read on `/organisations`. The organisation it leaves is kept as it is. Refused with a 409 once the merchant has an account at a payment gateway that holds the business's identity itself, such as Stripe, since the gateway would go on holding the old one.","examples":[{"type":"MchtUpdateOrganisation","organisationId":"org_9f2Kd8QpLzXw"}],"type":"object","required":["type","organisationId"],"properties":{"type":{"description":"Always `MchtUpdateOrganisation`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtUpdateOrganisation"]},"organisationId":{"$ref":"#/components/schemas/OrgId","description":"Identifier of an organisation: a business's legal record, shared by every merchant, customer and owner that is that business."}}},"MchtUpdatePayoutSettings":{"title":"MchtUpdatePayoutSettings","description":"Change how and when this merchant is paid out.","examples":[{"type":"MchtUpdatePayoutSettings","payoutSettings":{"type":"MchtPayoutSettingsPatchAttributes","schedule":"Daily","dayOfWeek":"example","dayOfMonth":6,"delayDays":1250,"statementDescriptor":"ADA COFFEE","payoutsEnabled":true,"notificationEmails":["ada@example.com"],"remitterName":"Ada Lovelace"}}],"type":"object","required":["type","payoutSettings"],"properties":{"type":{"description":"Always `MchtUpdatePayoutSettings`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtUpdatePayoutSettings"]},"payoutSettings":{"$ref":"#/components/schemas/MchtPayoutSettingsPatch"}}},"MchtUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/MchtUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MchtUpdateRspAttributes":"#/components/schemas/MchtUpdateRspAttributes"}}},"MchtUpdateRspAttributes":{"title":"MchtUpdateRspAttributes","examples":[{"type":"MchtUpdateRspAttributes","updated":{"type":"MchtViewStandard","merchantId":"mcht_9f2Kd8QpLzXw","organisationId":"org_9f2Kd8QpLzXw","referenceMerchantId":"your-own-reference","slug":"example","status":"Onboarding","verification":{"type":"MchtVerificationAttributes","status":"Pending","errorCodes":["example"],"details":["example"]},"business":{"type":"MchtBusinessAttributes","legalName":"Ada Lovelace","brandName":"Ada Lovelace","businessRegistrationNumber":"example","taxRegistrationNumber":"example","country":"AU","website":"example","contactEmail":"ada@example.com"},"timeZone":"example","publicProfile":{"type":"MchtPublicProfileAttributes","brandName":"Ada Lovelace","cardStatementName":"Ada Lovelace","smsSenderName":"Ada Lovelace","website":"example","supportSite":"example"},"contact":{"type":"MchtContactAttributes","firstName":"Ada Lovelace","lastName":"Ada Lovelace","title":"example","contactEmail":"ada@example.com","supportEmail":"ada@example.com","phoneNumber":"+61400000000","address":{"type":"MchtAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"}},"payoutSettings":{"type":"MchtPayoutSettingsAttributes","schedule":"Daily","dayOfWeek":"example","dayOfMonth":6,"delayDays":1250,"statementDescriptor":"ADA COFFEE","payoutsEnabled":true,"automatedPayoutsEnabled":true,"automatedDisbursementsEnabled":true,"notificationEmails":["ada@example.com"],"remitterName":"Ada Lovelace"},"billingSettings":{"type":"MchtBillingSettingsAttributes","notificationEmails":["ada@example.com"],"notificationsEnabled":true,"address":{"type":"MchtAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"},"paymentSourceId":"psrc_9f2Kd8QpLzXw"},"branding":{"type":"MchtBrandingAttributes","logoFileId":"lfile_9f2Kd8QpLzXw","iconFileId":"lfile_9f2Kd8QpLzXw","logoAltText":"example","brandColour":"example"},"orderSettings":{"type":"MchtOrderSettingsAttributes","customFields":[{"type":"MchtOrderCustomFieldAttributes","key":"example","label":"example","required":true,"visibleToPayer":true}],"notificationEmails":["ada@example.com"],"notifyOnPaid":true},"sourceRules":[{"type":"MchtRuleAttributes","criterion":{"type":"MchtRuleAlways"},"actions":[{"type":"MchtRuleAllow"}]}],"usageRules":{"type":"MchtUsageRulesAttributes","currencies":{"type":"MchtCurrencyAllow","currencies":["AUD"]},"issuerCountries":{"type":"MchtIssuerCountryAllow","countries":["AU"]}},"riskSettings":{"type":"MchtRiskSettingsAttributes","settlementType":"Net","bankAccountVerificationRequired":true,"bankAccountVerification":{"type":"MchtVerificationPolicyAttributes","accept":["Match"],"includeResultInResponse":true},"sourceVerificationEnabled":true,"supportedCustomerTypes":["Consumer"],"paymentLimits":{"type":"MchtPaymentLimitsAttributes","currency":"AUD","minimumPaymentAmount":1250,"maximumPaymentAmount":1250},"disputesWaived":true,"payoutPriority":10,"showPlatformLogoInTerms":true,"showSavedPaymentMethodsInCheckout":true,"showReferenceOrderIdToCustomer":true,"emailPaymentReceipt":true,"emailPaymentFailure":true},"bankAccounts":[{"type":"MchtBankAccountAttributes","externalAccountId":"xacc_9f2Kd8QpLzXw","accountName":"Ada Lovelace","last4":"4242","currency":"AUD","isPrimary":true,"status":"Active","verificationStatus":"Active"}],"capabilityTags":["DirectDebit"],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `MchtUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/MchtView","description":"The resource as it stands after the change."}}},"MchtUsageRules":{"description":"What the merchant will and will not accept.","oneOf":[{"$ref":"#/components/schemas/MchtUsageRulesAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MchtUsageRulesAttributes":"#/components/schemas/MchtUsageRulesAttributes"}}},"MchtUsageRulesAttributes":{"title":"MchtUsageRulesAttributes","description":"What the merchant will and will not accept.","examples":[{"type":"MchtUsageRulesAttributes","currencies":{"type":"MchtCurrencyAllow","currencies":["AUD"]},"issuerCountries":{"type":"MchtIssuerCountryAllow","countries":["AU"]}}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `MchtUsageRulesAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtUsageRulesAttributes"]},"currencies":{"$ref":"#/components/schemas/MchtCurrencyRestriction"},"issuerCountries":{"$ref":"#/components/schemas/MchtIssuerCountryRestriction"}}},"MchtVerification":{"description":"The outcome of verifying the business. Absent unless the principal may read merchant state.","oneOf":[{"$ref":"#/components/schemas/MchtVerificationAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MchtVerificationAttributes":"#/components/schemas/MchtVerificationAttributes"}}},"MchtVerificationAttributes":{"title":"MchtVerificationAttributes","description":"The outcome of verifying a business.","examples":[{"type":"MchtVerificationAttributes","status":"Pending","errorCodes":["example"],"details":["example"]}],"type":"object","required":["type","status"],"properties":{"type":{"description":"Always `MchtVerificationAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtVerificationAttributes"]},"status":{"$ref":"#/components/schemas/MchtVerificationStatus"},"errorCodes":{"description":"Why verification has not completed, as platform onboarding error codes.","type":"array","items":{"type":"string"}},"details":{"description":"Human-readable detail behind the error codes.","type":"array","items":{"type":"string"}}}},"MchtVerificationOutcome":{"title":"MchtVerificationOutcome","type":"string","enum":["Match","PartialMatch","NoMatch","AccountClosed","Failed","Unknown"]},"MchtVerificationPolicy":{"description":"Which verification outcomes are accepted, and whether the outcome is returned to the caller.","oneOf":[{"$ref":"#/components/schemas/MchtVerificationPolicyAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MchtVerificationPolicyAttributes":"#/components/schemas/MchtVerificationPolicyAttributes"}}},"MchtVerificationPolicyAttributes":{"title":"MchtVerificationPolicyAttributes","description":"Which bank-account verification outcomes are accepted.","examples":[{"type":"MchtVerificationPolicyAttributes","accept":["Match"],"includeResultInResponse":true}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `MchtVerificationPolicyAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtVerificationPolicyAttributes"]},"accept":{"description":"Outcomes that let the account be used. Anything else is refused. `Failed` and `Unknown` cannot be accepted and are ignored if sent: what happens when the bank cannot answer is the platform's decision, not a merchant's.","type":"array","items":{"$ref":"#/components/schemas/MchtVerificationOutcome"}},"includeResultInResponse":{"description":"Return the verification outcome to the caller. Off by default, because it is the bank's assessment of a person.","type":"boolean"}}},"MchtVerificationStatus":{"title":"MchtVerificationStatus","type":"string","enum":["Pending","Verified","Unknown"]},"MchtView":{"oneOf":[{"$ref":"#/components/schemas/MchtViewStandard"},{"$ref":"#/components/schemas/MchtViewSupplier"}],"discriminator":{"propertyName":"type","mapping":{"MchtViewStandard":"#/components/schemas/MchtViewStandard","MchtViewSupplier":"#/components/schemas/MchtViewSupplier"}}},"MchtViewStandard":{"title":"MchtViewStandard","description":"A merchant that sells: takes payments, settles, and is paid out.","examples":[{"type":"MchtViewStandard","merchantId":"mcht_9f2Kd8QpLzXw","organisationId":"org_9f2Kd8QpLzXw","referenceMerchantId":"your-own-reference","slug":"example","status":"Onboarding","verification":{"type":"MchtVerificationAttributes","status":"Pending","errorCodes":["example"],"details":["example"]},"business":{"type":"MchtBusinessAttributes","legalName":"Ada Lovelace","brandName":"Ada Lovelace","businessRegistrationNumber":"example","taxRegistrationNumber":"example","country":"AU","website":"example","contactEmail":"ada@example.com"},"timeZone":"example","publicProfile":{"type":"MchtPublicProfileAttributes","brandName":"Ada Lovelace","cardStatementName":"Ada Lovelace","smsSenderName":"Ada Lovelace","website":"example","supportSite":"example"},"contact":{"type":"MchtContactAttributes","firstName":"Ada Lovelace","lastName":"Ada Lovelace","title":"example","contactEmail":"ada@example.com","supportEmail":"ada@example.com","phoneNumber":"+61400000000","address":{"type":"MchtAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"}},"payoutSettings":{"type":"MchtPayoutSettingsAttributes","schedule":"Daily","dayOfWeek":"example","dayOfMonth":6,"delayDays":1250,"statementDescriptor":"ADA COFFEE","payoutsEnabled":true,"automatedPayoutsEnabled":true,"automatedDisbursementsEnabled":true,"notificationEmails":["ada@example.com"],"remitterName":"Ada Lovelace"},"billingSettings":{"type":"MchtBillingSettingsAttributes","notificationEmails":["ada@example.com"],"notificationsEnabled":true,"address":{"type":"MchtAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"},"paymentSourceId":"psrc_9f2Kd8QpLzXw"},"branding":{"type":"MchtBrandingAttributes","logoFileId":"lfile_9f2Kd8QpLzXw","iconFileId":"lfile_9f2Kd8QpLzXw","logoAltText":"example","brandColour":"example"},"orderSettings":{"type":"MchtOrderSettingsAttributes","customFields":[{"type":"MchtOrderCustomFieldAttributes","key":"example","label":"example","required":true,"visibleToPayer":true}],"notificationEmails":["ada@example.com"],"notifyOnPaid":true},"sourceRules":[{"type":"MchtRuleAttributes","criterion":{"type":"MchtRuleAlways"},"actions":[{"type":"MchtRuleAllow"}]}],"usageRules":{"type":"MchtUsageRulesAttributes","currencies":{"type":"MchtCurrencyAllow","currencies":["AUD"]},"issuerCountries":{"type":"MchtIssuerCountryAllow","countries":["AU"]}},"riskSettings":{"type":"MchtRiskSettingsAttributes","settlementType":"Net","bankAccountVerificationRequired":true,"bankAccountVerification":{"type":"MchtVerificationPolicyAttributes","accept":["Match"],"includeResultInResponse":true},"sourceVerificationEnabled":true,"supportedCustomerTypes":["Consumer"],"paymentLimits":{"type":"MchtPaymentLimitsAttributes","currency":"AUD","minimumPaymentAmount":1250,"maximumPaymentAmount":1250},"disputesWaived":true,"payoutPriority":10,"showPlatformLogoInTerms":true,"showSavedPaymentMethodsInCheckout":true,"showReferenceOrderIdToCustomer":true,"emailPaymentReceipt":true,"emailPaymentFailure":true},"bankAccounts":[{"type":"MchtBankAccountAttributes","externalAccountId":"xacc_9f2Kd8QpLzXw","accountName":"Ada Lovelace","last4":"4242","currency":"AUD","isPrimary":true,"status":"Active","verificationStatus":"Active"}],"capabilityTags":["DirectDebit"],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","merchantId","organisationId","slug","status","business","timeZone","createdAt","updatedAt"],"properties":{"type":{"description":"Always `MchtViewStandard`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtViewStandard"]},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"Identifier of a merchant."},"organisationId":{"$ref":"#/components/schemas/OrgId","description":"The organisation this merchant is, its legal record, read at `GET /organisations/{organisationId}`."},"referenceMerchantId":{"description":"The caller's own identifier for this merchant, if one was supplied.","type":"string"},"slug":{"description":"URL-safe identifier used for hosted pages.","type":"string"},"status":{"$ref":"#/components/schemas/MchtStatus"},"verification":{"$ref":"#/components/schemas/MchtVerification"},"business":{"$ref":"#/components/schemas/MchtBusiness"},"timeZone":{"type":"string"},"publicProfile":{"$ref":"#/components/schemas/MchtPublicProfile"},"contact":{"$ref":"#/components/schemas/MchtContact","description":"Who to contact at the business."},"payoutSettings":{"$ref":"#/components/schemas/MchtPayoutSettings"},"billingSettings":{"$ref":"#/components/schemas/MchtBillingSettings"},"branding":{"$ref":"#/components/schemas/MchtBranding"},"orderSettings":{"$ref":"#/components/schemas/MchtOrderSettings"},"sourceRules":{"description":"The platform's source rules for this merchant: what it is charged, what it surcharges, and what it may accept.","type":"array","items":{"$ref":"#/components/schemas/MchtRule"}},"usageRules":{"$ref":"#/components/schemas/MchtUsageRules"},"riskSettings":{"$ref":"#/components/schemas/MchtRiskSettings"},"bankAccounts":{"description":"Bank accounts the merchant can be paid out to.","type":"array","items":{"$ref":"#/components/schemas/MchtBankAccount"}},"capabilityTags":{"description":"The capability tags set on this merchant, which gate what some operations will do. Present on the by-id read only, because a page does not load them.","type":"array","items":{"$ref":"#/components/schemas/MchtCapabilityTag"}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"MchtViewSupplier":{"title":"MchtViewSupplier","description":"A supplier: a merchant that receives money and never sells.","examples":[{"type":"MchtViewSupplier","merchantId":"mcht_9f2Kd8QpLzXw","organisationId":"org_9f2Kd8QpLzXw","referenceMerchantId":"your-own-reference","slug":"example","status":"Onboarding","verification":{"type":"MchtVerificationAttributes","status":"Pending","errorCodes":["example"],"details":["example"]},"business":{"type":"MchtBusinessAttributes","legalName":"Ada Lovelace","brandName":"Ada Lovelace","businessRegistrationNumber":"example","taxRegistrationNumber":"example","country":"AU","website":"example","contactEmail":"ada@example.com"},"timeZone":"example","contact":{"type":"MchtContactAttributes","firstName":"Ada Lovelace","lastName":"Ada Lovelace","title":"example","contactEmail":"ada@example.com","supportEmail":"ada@example.com","phoneNumber":"+61400000000","address":{"type":"MchtAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"}},"payoutSettings":{"type":"MchtPayoutSettingsAttributes","schedule":"Daily","dayOfWeek":"example","dayOfMonth":6,"delayDays":1250,"statementDescriptor":"ADA COFFEE","payoutsEnabled":true,"automatedPayoutsEnabled":true,"automatedDisbursementsEnabled":true,"notificationEmails":["ada@example.com"],"remitterName":"Ada Lovelace"},"billingSettings":{"type":"MchtBillingSettingsAttributes","notificationEmails":["ada@example.com"],"notificationsEnabled":true,"address":{"type":"MchtAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"},"paymentSourceId":"psrc_9f2Kd8QpLzXw"},"riskSettings":{"type":"MchtRiskSettingsAttributes","settlementType":"Net","bankAccountVerificationRequired":true,"bankAccountVerification":{"type":"MchtVerificationPolicyAttributes","accept":["Match"],"includeResultInResponse":true},"sourceVerificationEnabled":true,"supportedCustomerTypes":["Consumer"],"paymentLimits":{"type":"MchtPaymentLimitsAttributes","currency":"AUD","minimumPaymentAmount":1250,"maximumPaymentAmount":1250},"disputesWaived":true,"payoutPriority":10,"showPlatformLogoInTerms":true,"showSavedPaymentMethodsInCheckout":true,"showReferenceOrderIdToCustomer":true,"emailPaymentReceipt":true,"emailPaymentFailure":true},"bankAccounts":[{"type":"MchtBankAccountAttributes","externalAccountId":"xacc_9f2Kd8QpLzXw","accountName":"Ada Lovelace","last4":"4242","currency":"AUD","isPrimary":true,"status":"Active","verificationStatus":"Active"}],"capabilityTags":["DirectDebit"],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","merchantId","organisationId","slug","status","business","timeZone","createdAt","updatedAt"],"properties":{"type":{"description":"Always `MchtViewSupplier`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MchtViewSupplier"]},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"Identifier of a merchant."},"organisationId":{"$ref":"#/components/schemas/OrgId","description":"The organisation this merchant is, its legal record, read at `GET /organisations/{organisationId}`."},"referenceMerchantId":{"description":"The caller's own identifier for this merchant, if one was supplied.","type":"string"},"slug":{"description":"URL-safe identifier used in back-office links.","type":"string"},"status":{"$ref":"#/components/schemas/MchtStatus"},"verification":{"$ref":"#/components/schemas/MchtVerification"},"business":{"$ref":"#/components/schemas/MchtBusiness"},"timeZone":{"type":"string"},"contact":{"$ref":"#/components/schemas/MchtContact","description":"Who to contact at the business."},"payoutSettings":{"$ref":"#/components/schemas/MchtPayoutSettings"},"billingSettings":{"$ref":"#/components/schemas/MchtBillingSettings"},"riskSettings":{"$ref":"#/components/schemas/MchtRiskSettings"},"bankAccounts":{"description":"Bank accounts the supplier is paid into. The reason this merchant exists. Each carries its own verification outcome.","type":"array","items":{"$ref":"#/components/schemas/MchtBankAccount"}},"capabilityTags":{"description":"The capability tags set on this merchant, which gate what some operations will do. Present on the by-id read only, because a page does not load them.","type":"array","items":{"$ref":"#/components/schemas/MchtCapabilityTag"}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"Metadata":{"title":"Metadata","examples":[{"purchaseOrder":"PO-1234","costCentre":{"code":"CC-42"}}],"type":"object","additionalProperties":{}},"MinorUnits":{"title":"MinorUnits","type":"integer","format":"int64"},"MinvAmounts":{"description":"What is owed on the invoice and what has been paid. All in the single currency given here.","oneOf":[{"$ref":"#/components/schemas/MinvAmountsAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MinvAmountsAttributes":"#/components/schemas/MinvAmountsAttributes"}}},"MinvAmountsAttributes":{"title":"MinvAmountsAttributes","description":"What is owed on the invoice and what has been paid. All in the single currency given here.","examples":[{"type":"MinvAmountsAttributes","currency":"AUD","invoiced":1250,"paid":1250,"outstanding":1250}],"type":"object","required":["type","currency","invoiced","paid","outstanding"],"properties":{"type":{"description":"Always `MinvAmountsAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MinvAmountsAttributes"]},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"invoiced":{"$ref":"#/components/schemas/MinorUnits","description":"The invoice total."},"paid":{"$ref":"#/components/schemas/MinorUnits","description":"Credited towards it so far."},"outstanding":{"$ref":"#/components/schemas/MinorUnits","description":"Still owing. `invoiced` less `paid`."}}},"MinvBilling":{"description":"Who the invoice is addressed to. Present on a by-id read.","oneOf":[{"$ref":"#/components/schemas/MinvBillingAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MinvBillingAttributes":"#/components/schemas/MinvBillingAttributes"}}},"MinvBillingAttributes":{"title":"MinvBillingAttributes","description":"Who the invoice is addressed to.","examples":[{"type":"MinvBillingAttributes","businessName":"Ada Lovelace","taxId":"abc123","emailAddress":"ada@example.com","phoneNumber":"+61400000000","address":{"type":"PsonAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"}}],"type":"object","required":["type","businessName","taxId","emailAddress","phoneNumber","address"],"properties":{"type":{"description":"Always `MinvBillingAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MinvBillingAttributes"]},"businessName":{"type":"string"},"taxId":{"type":"string"},"emailAddress":{"type":"string"},"phoneNumber":{"description":"Phone number in E.164 format.","type":"string"},"address":{"$ref":"#/components/schemas/PsonAddress"}}},"MinvCmd":{"oneOf":[{"$ref":"#/components/schemas/MinvCmdCreate"}],"discriminator":{"propertyName":"type","mapping":{"MinvCmdCreate":"#/components/schemas/MinvCmdCreate"}}},"MinvCmdCreate":{"title":"MinvCmdCreate","description":"Raise an invoice for the credential's own merchant, over a period.","examples":[{"type":"MinvCmdCreate","category":"example","currency":"AUD","periodStart":"2026-08-19","periodEnd":"2026-08-19","dueDate":"2026-08-19","narrative":"example"}],"type":"object","required":["type","category","currency","periodStart","periodEnd"],"properties":{"type":{"description":"Always `MinvCmdCreate`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MinvCmdCreate"]},"category":{"description":"Which of the payer's ledgers to invoice. A merchant has several, and this decides what the invoice is for.","type":"string"},"currency":{"$ref":"#/components/schemas/IsoCurrency","description":"Which currency's books to invoice. Required, a merchant may keep more than one."},"periodStart":{"description":"First day of the period to bill.","type":"string","format":"date"},"periodEnd":{"description":"Last day of the period to bill.","type":"string","format":"date"},"dueDate":{"description":"When payment falls due. Omit to let the platform apply the merchant's terms.","type":"string","format":"date"},"narrative":{"description":"What the invoice covers, in words. Shown to the payer.","type":"string"}}},"MinvColumn":{"title":"MinvColumn","type":"string","enum":["MerchantInvoiceId","Reference","PayerMerchantId","PayerName","PayeeMerchantId","PayerMarketplaceId","PayerEnterpriseId","Status","AmountsCurrency","AmountsInvoiced","AmountsPaid","AmountsOutstanding","PeriodStart","PeriodEnd","DueDate","IssuedOn","Narrative","OrderId","LedgerClearanceSystemLedgerId","LedgerClearanceFirstSequence","LedgerClearanceLastSequence","BillingBusinessName","BillingTaxId","BillingEmailAddress","BillingPhoneNumber","BillingAddressUnitNumber","BillingAddressStreetNumber","BillingAddressStreetName","BillingAddressStreetType","BillingAddressSuburb","BillingAddressCity","BillingAddressState","BillingAddressPostalCode","BillingAddressCountry","ManualPaymentToken","ManualPaymentPaymentUrl","ManualPaymentOrderId","CreatedAt","UpdatedAt"]},"MinvCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/MinvCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MinvCreateRspAttributes":"#/components/schemas/MinvCreateRspAttributes"}}},"MinvCreateRspAttributes":{"title":"MinvCreateRspAttributes","examples":[{"type":"MinvCreateRspAttributes","created":{"type":"MinvViewAttributes","merchantInvoiceId":"minv_9f2Kd8QpLzXw","reference":"your-own-reference","payerMerchantId":"mcht_9f2Kd8QpLzXw","payerName":"Ada Lovelace","payeeMerchantId":"mcht_9f2Kd8QpLzXw","payerMarketplaceId":"mktp_9f2Kd8QpLzXw","payerEnterpriseId":"ent_9f2Kd8QpLzXw","status":"Draft","amounts":{"type":"MinvAmountsAttributes","currency":"AUD","invoiced":1250,"paid":1250,"outstanding":1250},"periodStart":"2026-08-19","periodEnd":"2026-08-19","dueDate":"2026-08-19","issuedOn":"2026-08-19","narrative":"example","orderId":"ordr_9f2Kd8QpLzXw","ledgerClearance":{"type":"MinvLedgerClearanceAttributes","systemLedgerId":"abc123","firstSequence":1250,"lastSequence":1250},"payments":[{"type":"MinvPaymentAbandoned","at":"2026-08-19T04:21:07Z","summary":"example"}],"items":[{"type":"MinvItemAttributes","itemType":"PayInFullFee","category":"example","categoryLabel":"example","unitPrice":"example","count":42,"transactionValue":1250,"fees":1250,"tax":1250}],"billing":{"type":"MinvBillingAttributes","businessName":"Ada Lovelace","taxId":"abc123","emailAddress":"ada@example.com","phoneNumber":"+61400000000","address":{"type":"PsonAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"}},"manualPayment":{"type":"MinvManualPaymentAttributes","token":"tok_9f2Kd8QpLzXwR4mN","paymentUrl":"https://example.com/callback","orderId":"ordr_9f2Kd8QpLzXw"},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `MinvCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MinvCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/MinvView","description":"The resource that was created."}}},"MinvId":{"title":"MinvId","description":"Identifier of a merchant invoice.","examples":["minv_9f2Kd8QpLzXw"],"type":"string"},"MinvItem":{"description":"One line of an invoice. Amounts are in the invoice's currency.","oneOf":[{"$ref":"#/components/schemas/MinvItemAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MinvItemAttributes":"#/components/schemas/MinvItemAttributes"}}},"MinvItemAttributes":{"title":"MinvItemAttributes","description":"One line of an invoice. Amounts are in the invoice's currency.","examples":[{"type":"MinvItemAttributes","itemType":"PayInFullFee","category":"example","categoryLabel":"example","unitPrice":"example","count":42,"transactionValue":1250,"fees":1250,"tax":1250}],"type":"object","required":["type","itemType","count","fees","tax"],"properties":{"type":{"description":"Always `MinvItemAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MinvItemAttributes"]},"itemType":{"$ref":"#/components/schemas/MinvItemType"},"category":{"description":"Which payment product the line covers, where the item type has one.","type":"string"},"categoryLabel":{"description":"That category in words, for printing.","type":"string"},"unitPrice":{"description":"What one of these costs, as printed. A rate rather than an amount, `1.75% + $0.30`, so it is a string.","type":"string"},"count":{"description":"How many of them.","type":"integer","format":"int64"},"transactionValue":{"$ref":"#/components/schemas/MinorUnits","description":"The value of the transactions this line covers, where the line is charged on transaction value."},"fees":{"$ref":"#/components/schemas/MinorUnits","description":"Fees charged on the line, excluding tax."},"tax":{"$ref":"#/components/schemas/MinorUnits","description":"Tax charged on those fees."}}},"MinvItemType":{"title":"MinvItemType","type":"string","enum":["PayInFullFee","PayPlanFee","PaymentFeeReversal","DisputeFee","DisputeFeeReversal","ManualTopUp","ManualTopUpReversal","TransactionTransferFeeReversal","OverdueInvoiceFee","Other","Unknown"]},"MinvLedgerClearance":{"description":"Which stretch of the payer's ledger this invoice cleared, so the total is reproducible from the books.","oneOf":[{"$ref":"#/components/schemas/MinvLedgerClearanceAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MinvLedgerClearanceAttributes":"#/components/schemas/MinvLedgerClearanceAttributes"}}},"MinvLedgerClearanceAttributes":{"title":"MinvLedgerClearanceAttributes","description":"Which stretch of the payer's ledger this invoice cleared.","examples":[{"type":"MinvLedgerClearanceAttributes","systemLedgerId":"abc123","firstSequence":1250,"lastSequence":1250}],"type":"object","required":["type","systemLedgerId","firstSequence","lastSequence"],"properties":{"type":{"description":"Always `MinvLedgerClearanceAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MinvLedgerClearanceAttributes"]},"systemLedgerId":{"type":"string"},"firstSequence":{"description":"Sequence of the first ledger entry included.","type":"integer","format":"int64"},"lastSequence":{"description":"Sequence of the last ledger entry included.","type":"integer","format":"int64"}}},"MinvManualPayment":{"description":"How a person can pay this invoice by hand. Present on a by-id read, where the platform issued a link.","oneOf":[{"$ref":"#/components/schemas/MinvManualPaymentAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MinvManualPaymentAttributes":"#/components/schemas/MinvManualPaymentAttributes"}}},"MinvManualPaymentAttributes":{"title":"MinvManualPaymentAttributes","description":"How a person can pay this invoice by hand.","examples":[{"type":"MinvManualPaymentAttributes","token":"tok_9f2Kd8QpLzXwR4mN","paymentUrl":"https://example.com/callback","orderId":"ordr_9f2Kd8QpLzXw"}],"type":"object","required":["type","token","paymentUrl","orderId"],"properties":{"type":{"description":"Always `MinvManualPaymentAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MinvManualPaymentAttributes"]},"token":{"description":"Authorises the holder to pay this invoice. Valid for 28 days.","type":"string"},"paymentUrl":{"description":"Where to send a person to pay it. Carries the token.","type":"string"},"orderId":{"description":"The order that represents payment of this invoice.","type":"string"}}},"MinvPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/MinvPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MinvPageAttributes":"#/components/schemas/MinvPageAttributes"}}},"MinvPageAttributes":{"title":"MinvPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"MinvPageAttributes","data":[{"type":"MinvViewAttributes","merchantInvoiceId":"minv_9f2Kd8QpLzXw","reference":"your-own-reference","payerMerchantId":"mcht_9f2Kd8QpLzXw","payerName":"Ada Lovelace","payeeMerchantId":"mcht_9f2Kd8QpLzXw","payerMarketplaceId":"mktp_9f2Kd8QpLzXw","payerEnterpriseId":"ent_9f2Kd8QpLzXw","status":"Draft","amounts":{"type":"MinvAmountsAttributes","currency":"AUD","invoiced":1250,"paid":1250,"outstanding":1250},"periodStart":"2026-08-19","periodEnd":"2026-08-19","dueDate":"2026-08-19","issuedOn":"2026-08-19","narrative":"example","orderId":"ordr_9f2Kd8QpLzXw","ledgerClearance":{"type":"MinvLedgerClearanceAttributes","systemLedgerId":"abc123","firstSequence":1250,"lastSequence":1250},"payments":[{"type":"MinvPaymentAbandoned","at":"2026-08-19T04:21:07Z","summary":"example"}],"items":[{"type":"MinvItemAttributes","itemType":"PayInFullFee","category":"example","categoryLabel":"example","unitPrice":"example","count":42,"transactionValue":1250,"fees":1250,"tax":1250}],"billing":{"type":"MinvBillingAttributes","businessName":"Ada Lovelace","taxId":"abc123","emailAddress":"ada@example.com","phoneNumber":"+61400000000","address":{"type":"PsonAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"}},"manualPayment":{"type":"MinvManualPaymentAttributes","token":"tok_9f2Kd8QpLzXwR4mN","paymentUrl":"https://example.com/callback","orderId":"ordr_9f2Kd8QpLzXw"},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `MinvPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MinvPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/MinvView","description":"What the platform billed a merchant for a period, and what has been paid against it."}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"MinvPayment":{"oneOf":[{"$ref":"#/components/schemas/MinvPaymentAbandoned"},{"$ref":"#/components/schemas/MinvPaymentFailed"},{"$ref":"#/components/schemas/MinvPaymentFromCredit"},{"$ref":"#/components/schemas/MinvPaymentInProgress"},{"$ref":"#/components/schemas/MinvPaymentMarked"},{"$ref":"#/components/schemas/MinvPaymentSucceeded"}],"discriminator":{"propertyName":"type","mapping":{"MinvPaymentAbandoned":"#/components/schemas/MinvPaymentAbandoned","MinvPaymentFailed":"#/components/schemas/MinvPaymentFailed","MinvPaymentFromCredit":"#/components/schemas/MinvPaymentFromCredit","MinvPaymentInProgress":"#/components/schemas/MinvPaymentInProgress","MinvPaymentMarked":"#/components/schemas/MinvPaymentMarked","MinvPaymentSucceeded":"#/components/schemas/MinvPaymentSucceeded"}}},"MinvPaymentAbandoned":{"title":"MinvPaymentAbandoned","description":"The platform stopped retrying an automatic payment.","examples":[{"type":"MinvPaymentAbandoned","at":"2026-08-19T04:21:07Z","summary":"example"}],"type":"object","required":["type","at","summary"],"properties":{"type":{"description":"Always `MinvPaymentAbandoned`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MinvPaymentAbandoned"]},"at":{"type":"string","format":"date-time"},"summary":{"type":"string"}}},"MinvPaymentFailed":{"title":"MinvPaymentFailed","description":"An automatic payment was refused.","examples":[{"type":"MinvPaymentFailed","at":"2026-08-19T04:21:07Z","summary":"example"}],"type":"object","required":["type","at","summary"],"properties":{"type":{"description":"Always `MinvPaymentFailed`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MinvPaymentFailed"]},"at":{"type":"string","format":"date-time"},"summary":{"type":"string"}}},"MinvPaymentFromCredit":{"title":"MinvPaymentFromCredit","description":"The invoice was settled from the payer's credit balance rather than a payment.","examples":[{"type":"MinvPaymentFromCredit","at":"2026-08-19T04:21:07Z","summary":"example"}],"type":"object","required":["type","at","summary"],"properties":{"type":{"description":"Always `MinvPaymentFromCredit`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MinvPaymentFromCredit"]},"at":{"type":"string","format":"date-time"},"summary":{"type":"string"}}},"MinvPaymentInProgress":{"title":"MinvPaymentInProgress","description":"An automatic payment was started, a direct debit, typically, and has not resolved.","examples":[{"type":"MinvPaymentInProgress","at":"2026-08-19T04:21:07Z","summary":"example"}],"type":"object","required":["type","at","summary"],"properties":{"type":{"description":"Always `MinvPaymentInProgress`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MinvPaymentInProgress"]},"at":{"type":"string","format":"date-time"},"summary":{"type":"string"}}},"MinvPaymentMarked":{"title":"MinvPaymentMarked","description":"Someone recorded that the invoice was settled outside the platform.","examples":[{"type":"MinvPaymentMarked","at":"2026-08-19T04:21:07Z","summary":"example"}],"type":"object","required":["type","at","summary"],"properties":{"type":{"description":"Always `MinvPaymentMarked`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MinvPaymentMarked"]},"at":{"type":"string","format":"date-time"},"summary":{"type":"string"}}},"MinvPaymentSucceeded":{"title":"MinvPaymentSucceeded","description":"An automatic payment succeeded.","examples":[{"type":"MinvPaymentSucceeded","at":"2026-08-19T04:21:07Z","amountPaid":1250,"newStatus":"Draft","summary":"example"}],"type":"object","required":["type","at","amountPaid","newStatus","summary"],"properties":{"type":{"description":"Always `MinvPaymentSucceeded`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MinvPaymentSucceeded"]},"at":{"type":"string","format":"date-time"},"amountPaid":{"$ref":"#/components/schemas/MinorUnits","description":"How much was taken."},"newStatus":{"$ref":"#/components/schemas/MinvStatus","description":"The status the invoice moved to. A part payment does not reach `Paid`."},"summary":{"type":"string"}}},"MinvSort":{"title":"MinvSort","type":"string","enum":["createdAt","-createdAt","updatedAt","-updatedAt"]},"MinvStatus":{"title":"MinvStatus","type":"string","enum":["Draft","Outstanding","NearDue","Due","Overdue","Paid","Cancelled","Defaulted","Unknown"]},"MinvUpdate":{"oneOf":[{"$ref":"#/components/schemas/MinvUpdateMarkPaid"},{"$ref":"#/components/schemas/MinvUpdateProcess"},{"$ref":"#/components/schemas/MinvUpdateResendEmail"}],"discriminator":{"propertyName":"type","mapping":{"MinvUpdateMarkPaid":"#/components/schemas/MinvUpdateMarkPaid","MinvUpdateProcess":"#/components/schemas/MinvUpdateProcess","MinvUpdateResendEmail":"#/components/schemas/MinvUpdateResendEmail"}}},"MinvUpdateMarkPaid":{"title":"MinvUpdateMarkPaid","description":"Record that the invoice was settled outside the platform.","examples":[{"type":"MinvUpdateMarkPaid","amountCredited":1250}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `MinvUpdateMarkPaid`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MinvUpdateMarkPaid"]},"amountCredited":{"$ref":"#/components/schemas/MinorUnits","description":"How much to credit, in minor units of the invoice's currency. Omit to credit the whole outstanding amount. A part payment leaves the invoice unpaid."}}},"MinvUpdateProcess":{"title":"MinvUpdateProcess","description":"Push this invoice through a billing run now. Test contexts only, a `400` anywhere else.","examples":[{"type":"MinvUpdateProcess"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `MinvUpdateProcess`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MinvUpdateProcess"]}}},"MinvUpdateResendEmail":{"title":"MinvUpdateResendEmail","description":"Send the payer their latest invoice by email again.","examples":[{"type":"MinvUpdateResendEmail","emailTo":["ada@example.com"]}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `MinvUpdateResendEmail`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MinvUpdateResendEmail"]},"emailTo":{"description":"Who to send it to. Omit to use the payer's billing notification addresses.","type":"array","items":{"type":"string"}}}},"MinvUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/MinvUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MinvUpdateRspAttributes":"#/components/schemas/MinvUpdateRspAttributes"}}},"MinvUpdateRspAttributes":{"title":"MinvUpdateRspAttributes","examples":[{"type":"MinvUpdateRspAttributes","updated":{"type":"MinvViewAttributes","merchantInvoiceId":"minv_9f2Kd8QpLzXw","reference":"your-own-reference","payerMerchantId":"mcht_9f2Kd8QpLzXw","payerName":"Ada Lovelace","payeeMerchantId":"mcht_9f2Kd8QpLzXw","payerMarketplaceId":"mktp_9f2Kd8QpLzXw","payerEnterpriseId":"ent_9f2Kd8QpLzXw","status":"Draft","amounts":{"type":"MinvAmountsAttributes","currency":"AUD","invoiced":1250,"paid":1250,"outstanding":1250},"periodStart":"2026-08-19","periodEnd":"2026-08-19","dueDate":"2026-08-19","issuedOn":"2026-08-19","narrative":"example","orderId":"ordr_9f2Kd8QpLzXw","ledgerClearance":{"type":"MinvLedgerClearanceAttributes","systemLedgerId":"abc123","firstSequence":1250,"lastSequence":1250},"payments":[{"type":"MinvPaymentAbandoned","at":"2026-08-19T04:21:07Z","summary":"example"}],"items":[{"type":"MinvItemAttributes","itemType":"PayInFullFee","category":"example","categoryLabel":"example","unitPrice":"example","count":42,"transactionValue":1250,"fees":1250,"tax":1250}],"billing":{"type":"MinvBillingAttributes","businessName":"Ada Lovelace","taxId":"abc123","emailAddress":"ada@example.com","phoneNumber":"+61400000000","address":{"type":"PsonAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"}},"manualPayment":{"type":"MinvManualPaymentAttributes","token":"tok_9f2Kd8QpLzXwR4mN","paymentUrl":"https://example.com/callback","orderId":"ordr_9f2Kd8QpLzXw"},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `MinvUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MinvUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/MinvView","description":"The resource as it stands after the change."}}},"MinvView":{"oneOf":[{"$ref":"#/components/schemas/MinvViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MinvViewAttributes":"#/components/schemas/MinvViewAttributes"}}},"MinvViewAttributes":{"title":"MinvViewAttributes","description":"What the platform billed a merchant for a period, and what has been paid against it.","examples":[{"type":"MinvViewAttributes","merchantInvoiceId":"minv_9f2Kd8QpLzXw","reference":"your-own-reference","payerMerchantId":"mcht_9f2Kd8QpLzXw","payerName":"Ada Lovelace","payeeMerchantId":"mcht_9f2Kd8QpLzXw","payerMarketplaceId":"mktp_9f2Kd8QpLzXw","payerEnterpriseId":"ent_9f2Kd8QpLzXw","status":"Draft","amounts":{"type":"MinvAmountsAttributes","currency":"AUD","invoiced":1250,"paid":1250,"outstanding":1250},"periodStart":"2026-08-19","periodEnd":"2026-08-19","dueDate":"2026-08-19","issuedOn":"2026-08-19","narrative":"example","orderId":"ordr_9f2Kd8QpLzXw","ledgerClearance":{"type":"MinvLedgerClearanceAttributes","systemLedgerId":"abc123","firstSequence":1250,"lastSequence":1250},"payments":[{"type":"MinvPaymentAbandoned","at":"2026-08-19T04:21:07Z","summary":"example"}],"items":[{"type":"MinvItemAttributes","itemType":"PayInFullFee","category":"example","categoryLabel":"example","unitPrice":"example","count":42,"transactionValue":1250,"fees":1250,"tax":1250}],"billing":{"type":"MinvBillingAttributes","businessName":"Ada Lovelace","taxId":"abc123","emailAddress":"ada@example.com","phoneNumber":"+61400000000","address":{"type":"PsonAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"}},"manualPayment":{"type":"MinvManualPaymentAttributes","token":"tok_9f2Kd8QpLzXwR4mN","paymentUrl":"https://example.com/callback","orderId":"ordr_9f2Kd8QpLzXw"},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","merchantInvoiceId","reference","payerMerchantId","payerName","payeeMerchantId","payerEnterpriseId","status","amounts","periodStart","periodEnd","dueDate","narrative","ledgerClearance","createdAt","updatedAt"],"properties":{"type":{"description":"Always `MinvViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MinvViewAttributes"]},"merchantInvoiceId":{"$ref":"#/components/schemas/MinvId"},"reference":{"description":"The reference a payer quotes. Derived from the identifier, and the two convert both ways.","type":"string"},"payerMerchantId":{"$ref":"#/components/schemas/MchtId","description":"The merchant being billed."},"payerName":{"description":"Business name of the merchant billed, so a listing reads without a second call.","type":"string"},"payeeMerchantId":{"$ref":"#/components/schemas/MchtId","description":"The merchant receiving the funds. Usually the platform's own; a marketplace that self-manages gross settlement is its own payee."},"payerMarketplaceId":{"$ref":"#/components/schemas/MktpId","description":"The marketplace the payer trades under, where it does."},"payerEnterpriseId":{"$ref":"#/components/schemas/EntId","description":"Identifier of an enterprise."},"status":{"$ref":"#/components/schemas/MinvStatus"},"amounts":{"$ref":"#/components/schemas/MinvAmounts"},"periodStart":{"description":"First day of the period billed.","type":"string","format":"date"},"periodEnd":{"description":"Last day of the period billed.","type":"string","format":"date"},"dueDate":{"description":"When payment falls due.","type":"string","format":"date"},"issuedOn":{"description":"When the invoice was issued to the payer. Absent while the invoice is a draft.","type":"string","format":"date"},"narrative":{"description":"What the invoice covers, in words.","type":"string"},"orderId":{"description":"The order raised to represent payment of this invoice. Read it to see how payment is going.","type":"string"},"ledgerClearance":{"$ref":"#/components/schemas/MinvLedgerClearance"},"payments":{"description":"Every attempt at paying this invoice, in order. Empty where none has been made.","type":"array","items":{"$ref":"#/components/schemas/MinvPayment"}},"items":{"description":"The lines that make up the invoice. Present on a by-id read; a listing is not itemised.","type":"array","items":{"$ref":"#/components/schemas/MinvItem"}},"billing":{"$ref":"#/components/schemas/MinvBilling"},"manualPayment":{"$ref":"#/components/schemas/MinvManualPayment"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"MktpBankTransfers":{"description":"How the marketplace is paid by bank transfer. Absent where you may not read its financials, which is not the same as it not being set up.","oneOf":[{"$ref":"#/components/schemas/MktpBankTransfersAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MktpBankTransfersAttributes":"#/components/schemas/MktpBankTransfersAttributes"}}},"MktpBankTransfersAttributes":{"title":"MktpBankTransfersAttributes","description":"How a marketplace is paid by bank transfer.","examples":[{"type":"MktpBankTransfersAttributes","bankAccountBsb":"example","bankAccountNumber":"example","payId":"abc123"}],"type":"object","required":["type","bankAccountBsb","bankAccountNumber","payId"],"properties":{"type":{"description":"Always `MktpBankTransfersAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MktpBankTransfersAttributes"]},"bankAccountBsb":{"description":"Bank-state-branch of the account the platform issued.","type":"string"},"bankAccountNumber":{"description":"Account number of that account.","type":"string"},"payId":{"description":"The PayID the platform issued. This is what to give a payer.","type":"string"}}},"MktpBranding":{"oneOf":[{"$ref":"#/components/schemas/MktpBrandingAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MktpBrandingAttributes":"#/components/schemas/MktpBrandingAttributes"}}},"MktpBrandingAttributes":{"title":"MktpBrandingAttributes","description":"Branding sub-merchants inherit where they have none of their own. Whole, not merged, send every field you want to keep.","examples":[{"type":"MktpBrandingAttributes","iconUri":"https://example.com/callback","logoUri":"https://example.com/callback","logoAltText":"example","supportEmail":"ada@example.com","businessDisplayName":"Ada Lovelace","businessWebsite":"example","customOrderBaseUri":"https://example.com/callback","primaryColor":"example"}],"type":"object","required":["type","iconUri","logoUri","logoAltText"],"properties":{"type":{"description":"Always `MktpBrandingAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MktpBrandingAttributes"]},"iconUri":{"description":"Fully qualified https URI of the icon image.","type":"string"},"logoUri":{"description":"Fully qualified https URI of the logo image.","type":"string"},"logoAltText":{"description":"Shown when the logo image cannot be loaded.","type":"string"},"supportEmail":{"description":"Where sub-merchants' customers are told to write.","type":"string"},"businessDisplayName":{"description":"The name sub-merchants' customers see, where it differs from the registered business name.","type":"string"},"businessWebsite":{"type":"string"},"customOrderBaseUri":{"description":"Base URI for pay-by-link order URLs generated for sub-merchants.","type":"string"},"primaryColor":{"description":"Hex, e.g. #0B7285. Overrides the theme's primary colour in customer-facing components.","type":"string"}}},"MktpBusinessRegistration":{"description":"How the marketplace entity is registered in one tax country.","oneOf":[{"$ref":"#/components/schemas/MktpBusinessRegistrationAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MktpBusinessRegistrationAttributes":"#/components/schemas/MktpBusinessRegistrationAttributes"}}},"MktpBusinessRegistrationAttributes":{"title":"MktpBusinessRegistrationAttributes","description":"How the marketplace entity is registered in one tax country.","examples":[{"type":"MktpBusinessRegistrationAttributes","businessName":"Ada Lovelace","businessType":"Company","industry":"example","businessRegistrationNumber":"example","taxRegistrationNumber":"example"}],"type":"object","required":["type","businessName","businessType","industry","businessRegistrationNumber"],"properties":{"type":{"description":"Always `MktpBusinessRegistrationAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MktpBusinessRegistrationAttributes"]},"businessName":{"description":"Business name, as it appears against the registration number.","type":"string"},"businessType":{"$ref":"#/components/schemas/MchtBusinessType"},"industry":{"description":"Industry classification, the MCC code's name.","type":"string"},"businessRegistrationNumber":{"description":"The business registration number: the ABN in Australia, the NZBN in New Zealand.","type":"string"},"taxRegistrationNumber":{"description":"The tax registration number, where it differs: the ABN in Australia, the IRD number in New Zealand.","type":"string"}}},"MktpCmd":{"oneOf":[{"$ref":"#/components/schemas/MktpCmdCreate"}],"discriminator":{"propertyName":"type","mapping":{"MktpCmdCreate":"#/components/schemas/MktpCmdCreate"}}},"MktpCmdCreate":{"title":"MktpCmdCreate","description":"Create a marketplace under an enterprise.","examples":[{"type":"MktpCmdCreate","enterpriseId":"ent_9f2Kd8QpLzXw","slug":"example","businessName":"Ada Lovelace","website":"example","companyEmail":"ada@example.com","companyPhone":"+61400000000","merchantDashboardAccess":true,"shortenerBaseUri":"https://example.com/callback","zendeskUserGroupId":1250}],"type":"object","required":["type","enterpriseId","slug","businessName","website","companyEmail","companyPhone","merchantDashboardAccess"],"properties":{"type":{"description":"Always `MktpCmdCreate`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MktpCmdCreate"]},"enterpriseId":{"$ref":"#/components/schemas/EntId","description":"Identifier of an enterprise."},"slug":{"description":"The marketplace's short name, used in URLs. Unchangeable once set.","type":"string"},"businessName":{"type":"string"},"website":{"description":"The marketplace's public website.","type":"string"},"companyEmail":{"type":"string"},"companyPhone":{"description":"Phone number in E.164 format.","type":"string"},"merchantDashboardAccess":{"description":"Whether sub-merchants may sign in to their own dashboard. Required, there is no safe default.","type":"boolean"},"shortenerBaseUri":{"description":"Base URL for the marketplace's short links, where it has its own.","type":"string"},"zendeskUserGroupId":{"description":"The marketplace's Zendesk group, where support is routed through one.","type":"integer","format":"int64"}}},"MktpColumn":{"title":"MktpColumn","type":"string","enum":["MarketplaceId","EnterpriseId","Slug","BusinessName","Website","CompanyEmail","CompanyPhone","Status","MerchantDashboardAccess","SelfManagedGrossSettlement","ShortenerBaseUri","ZendeskUserGroupId","BankTransfersBankAccountBsb","BankTransfersBankAccountNumber","BankTransfersPayId","CreatedAt","UpdatedAt"]},"MktpContact":{"description":"Who to contact at the marketplace. Used on communications sent on behalf of its sub-merchants.","oneOf":[{"$ref":"#/components/schemas/MktpContactAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MktpContactAttributes":"#/components/schemas/MktpContactAttributes"}}},"MktpContactAttributes":{"title":"MktpContactAttributes","description":"Who to contact at the marketplace. Used on communications sent on behalf of its sub-merchants.","examples":[{"type":"MktpContactAttributes","firstName":"Ada Lovelace","lastName":"Ada Lovelace","title":"example","contactEmail":"ada@example.com","supportEmail":"ada@example.com","phoneNumber":"+61400000000","address":{"type":"MchtAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"}}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `MktpContactAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MktpContactAttributes"]},"firstName":{"type":"string"},"lastName":{"type":"string"},"title":{"type":"string"},"contactEmail":{"description":"The marketplace's own email address.","type":"string"},"supportEmail":{"description":"Where sub-merchants' customers are told to write. Omit to use `contactEmail`.","type":"string"},"phoneNumber":{"description":"E.164 format, e.g. +61400000000.","type":"string"},"address":{"$ref":"#/components/schemas/MchtAddress","description":"A postal address. Supplying one on a patch replaces the whole address, you cannot patch half of one."}}},"MktpCountrySettings":{"description":"A marketplace's profile and sub-merchant template for one tax country. Sections you may not read are absent.","oneOf":[{"$ref":"#/components/schemas/MktpCountrySettingsAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MktpCountrySettingsAttributes":"#/components/schemas/MktpCountrySettingsAttributes"}}},"MktpCountrySettingsAttributes":{"title":"MktpCountrySettingsAttributes","description":"A marketplace's profile and sub-merchant template for one tax country. Sections you may not read are absent.","examples":[{"type":"MktpCountrySettingsAttributes","taxCountry":"AU","contact":{"type":"MktpContactAttributes","firstName":"Ada Lovelace","lastName":"Ada Lovelace","title":"example","contactEmail":"ada@example.com","supportEmail":"ada@example.com","phoneNumber":"+61400000000","address":{"type":"MchtAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"}},"businessRegistration":{"type":"MktpBusinessRegistrationAttributes","businessName":"Ada Lovelace","businessType":"Company","industry":"example","businessRegistrationNumber":"example","taxRegistrationNumber":"example"},"branding":{"type":"MktpBrandingAttributes","iconUri":"https://example.com/callback","logoUri":"https://example.com/callback","logoAltText":"example","supportEmail":"ada@example.com","businessDisplayName":"Ada Lovelace","businessWebsite":"example","customOrderBaseUri":"https://example.com/callback","primaryColor":"example"},"customerDashboardBranding":{"type":"MktpBrandingAttributes","iconUri":"https://example.com/callback","logoUri":"https://example.com/callback","logoAltText":"example","supportEmail":"ada@example.com","businessDisplayName":"Ada Lovelace","businessWebsite":"example","customOrderBaseUri":"https://example.com/callback","primaryColor":"example"},"payoutDefaults":{"type":"MktpPayoutDefaultsAttributes","payoutDescription":"A short description.","schedule":"Daily","dayOfWeek":"example","dayOfMonth":6,"delayDays":1250,"issueDelayDays":1250,"automatedPayoutsEnabled":true,"automatedDisbursementsEnabled":true},"subMerchantFees":{"type":"FeesByPaymentForm","fees":{"type":"FeeStructAttributes","split":{"type":"FeeTableAttributes","domestic":{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]},"international":{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]}},"full":{"type":"FeeTableAttributes","domestic":{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]},"international":{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]}}}},"sourceRules":[{"type":"MchtRuleAttributes","criterion":{"type":"MchtRuleAlways"},"actions":[{"type":"MchtRuleAllow"}]}],"calculateTaxOnFee":true,"feesTaxExempt":true,"emailTemplates":{"type":"MktpEmailTemplatesAttributes","platformSupportSenderName":"Ada Lovelace","platformSupportEmail":"ada@example.com","platformSupportEmailSignedBy":"ada@example.com","platformSupportReplyToName":"Ada Lovelace","platformSupportReplyToEmail":"ada@example.com","customerSupportSenderName":"Ada Lovelace","customerSupportEmail":"ada@example.com","customerSupportEmailSignedBy":"ada@example.com","customerSupportReplyToName":"Ada Lovelace","customerSupportReplyToEmail":"ada@example.com","customerEmailBrandLogo":"ada@example.com","merchantOnboardingRequestedTemplateId":"abc123","merchantOnboardingCompletedTemplateId":"abc123","merchantResetPasswordTemplateId":"abc123","merchantResetPasswordConfirmationTemplateId":"abc123","merchantNewOrganisationCustomerDelegateTemplateId":"abc123","merchantNewOrganisationCustomerDelegateConfirmationTemplateId":"abc123"},"paymentProfile":"StripeConnectAU","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","taxCountry","contact","businessRegistration"],"properties":{"type":{"description":"Always `MktpCountrySettingsAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MktpCountrySettingsAttributes"]},"taxCountry":{"$ref":"#/components/schemas/IsoCountry","description":"ISO 3166-1 alpha-2."},"contact":{"$ref":"#/components/schemas/MktpContact"},"businessRegistration":{"$ref":"#/components/schemas/MktpBusinessRegistration"},"branding":{"$ref":"#/components/schemas/MktpBranding","description":"Branding sub-merchants inherit on checkouts and communications."},"customerDashboardBranding":{"$ref":"#/components/schemas/MktpBranding","description":"Branding on sub-merchants' own dashboards."},"payoutDefaults":{"$ref":"#/components/schemas/MktpPayoutDefaults","description":"Payout defaults sub-merchants inherit."},"subMerchantFees":{"$ref":"#/components/schemas/Fees","description":"The fees new sub-merchants are created with. Copied onto each one, not inherited."},"sourceRules":{"description":"Source rules created alongside those fees.","type":"array","items":{"$ref":"#/components/schemas/MchtRule"}},"calculateTaxOnFee":{"description":"Whether tax is added to the platform's fees.","type":"boolean"},"feesTaxExempt":{"description":"Whether the sub-merchant is exempt from tax on fees.","type":"boolean"},"emailTemplates":{"$ref":"#/components/schemas/MktpEmailTemplates"},"paymentProfile":{"$ref":"#/components/schemas/MktpPaymentProfile","description":"The payment provider new sub-merchants are created on."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"MktpCreateRsp":{"description":"A newly created marketplace, and the API key it starts with.","oneOf":[{"$ref":"#/components/schemas/MktpCreateRspCreated"}],"discriminator":{"propertyName":"type","mapping":{"MktpCreateRspCreated":"#/components/schemas/MktpCreateRspCreated"}}},"MktpCreateRspCreated":{"title":"MktpCreateRspCreated","description":"A newly created marketplace, and the API key it starts with.","examples":[{"type":"MktpCreateRspCreated","created":{"type":"MktpViewAttributes","marketplaceId":"mktp_9f2Kd8QpLzXw","enterpriseId":"ent_9f2Kd8QpLzXw","slug":"example","businessName":"Ada Lovelace","website":"example","companyEmail":"ada@example.com","companyPhone":"+61400000000","status":"Enabled","merchantDashboardAccess":true,"selfManagedGrossSettlement":true,"shortenerBaseUri":"https://example.com/callback","zendeskUserGroupId":1250,"bankTransfers":{"type":"MktpBankTransfersAttributes","bankAccountBsb":"example","bankAccountNumber":"example","payId":"abc123"},"sourceRules":["example"],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"},"apiKey":"example"}],"type":"object","required":["type","created","apiKey"],"properties":{"type":{"description":"Always `MktpCreateRspCreated`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MktpCreateRspCreated"]},"created":{"$ref":"#/components/schemas/MktpView","description":"A marketplace, a platform whose sub-merchants take payments under it."},"apiKey":{"description":"The marketplace's first API key. Returned once, here, and never retrievable again, store it now.","type":"string"}}},"MktpDefaults":{"description":"The settings sub-merchants inherit where they have set none of their own. An absent field is left as it is.","oneOf":[{"$ref":"#/components/schemas/MktpDefaultsAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MktpDefaultsAttributes":"#/components/schemas/MktpDefaultsAttributes"}}},"MktpDefaultsAttributes":{"title":"MktpDefaultsAttributes","description":"The settings sub-merchants inherit where they have set none of their own. An absent field is left as it is.","examples":[{"type":"MktpDefaultsAttributes","settlementType":"Net","bankAccountVerificationRequired":true,"bankAccountVerification":{"type":"MchtVerificationPolicyAttributes","accept":["Match"],"includeResultInResponse":true},"sourceVerificationEnabled":true,"supportedCustomerTypes":["Consumer"],"payInFullMinimum":1250,"payInFullMaximum":1250,"disputesWaived":true,"payoutPriority":10,"showPlatformLogoInTerms":true,"showSavedPaymentMethodsInCheckout":true,"showReferenceOrderIdToCustomer":true,"emailPaymentReceipt":true,"emailPaymentFailure":true,"offerGooglePay":true,"allowCheckoutWithoutPayInFull":true,"manualPaymentsCardOnly":true,"useMarketplaceReceivableAccount":true,"payIdDomain":"example","payoutChannels":["Standard"],"payoutRemitterName":"Ada Lovelace","disbursementSourceAccountId":"abc123"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `MktpDefaultsAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MktpDefaultsAttributes"]},"settlementType":{"$ref":"#/components/schemas/MchtSettlementType","description":"`Net` rolls platform fees into each payout; `Gross` invoices them separately."},"bankAccountVerificationRequired":{"description":"Whether a bank account must be verified before it can be used.","type":"boolean"},"bankAccountVerification":{"$ref":"#/components/schemas/MchtVerificationPolicy"},"sourceVerificationEnabled":{"description":"Ask a payer to confirm a small debit before their source is used, 3DS's belt and braces.","type":"boolean"},"supportedCustomerTypes":{"description":"Which kinds of customer sub-merchants sell to. At least one; sending an empty list is refused.","type":"array","items":{"$ref":"#/components/schemas/MchtCustomerType"}},"payInFullMinimum":{"$ref":"#/components/schemas/MinorUnits","description":"Smallest pay-in-full payment a sub-merchant checkout will accept, in the minor units of *that sub-merchant's* currency."},"payInFullMaximum":{"$ref":"#/components/schemas/MinorUnits","description":"Largest pay-in-full payment a sub-merchant checkout will accept, in the minor units of *that sub-merchant's* currency."},"disputesWaived":{"description":"Do not charge sub-merchants for disputes.","type":"boolean"},"payoutPriority":{"description":"Higher values are paid out ahead of lower ones.","type":"integer","format":"int32"},"showPlatformLogoInTerms":{"description":"Show the platform's logo on the terms page shown to payers. **Stated positively** the platform holds the negation.","type":"boolean"},"showSavedPaymentMethodsInCheckout":{"description":"Offer the payer their saved payment sources in the checkout.","type":"boolean"},"showReferenceOrderIdToCustomer":{"description":"Show the sub-merchant's own order reference on communications to the payer. **Stated positively.**","type":"boolean"},"emailPaymentReceipt":{"description":"Email the payer a receipt when an order is paid.","type":"boolean"},"emailPaymentFailure":{"description":"Email the payer after a failed attempt.","type":"boolean"},"offerGooglePay":{"description":"Offer Google Pay in sub-merchant checkouts. **Stated positively** the platform holds `inhibitGooglePay`.","type":"boolean"},"allowCheckoutWithoutPayInFull":{"description":"Let sub-merchants configure a checkout that offers pay plans only, with no pay-in-full option.","type":"boolean"},"manualPaymentsCardOnly":{"description":"Accept only cards on manually entered payments, no bank transfers or direct debits.","type":"boolean"},"useMarketplaceReceivableAccount":{"description":"Use the marketplace's own receivable account for sub-merchant bank transfers, rather than giving each one its own.","type":"boolean"},"payIdDomain":{"description":"Domain for the PayIDs issued to sub-merchants. Must already be a domain the platform holds proof of ownership for.","type":"string"},"payoutChannels":{"description":"Payout channels to attempt, in order. `Fast` first is the usual arrangement.","type":"array","items":{"$ref":"#/components/schemas/MktpPayoutChannel"}},"payoutRemitterName":{"description":"The name shown as the remitter on sub-merchants' payouts.","type":"string"},"disbursementSourceAccountId":{"description":"Bank account disbursements are paid from, where it is not the platform's default.","type":"string"}}},"MktpEmailTemplates":{"description":"The email templates communications are sent from on behalf of the marketplace and its sub-merchants.","oneOf":[{"$ref":"#/components/schemas/MktpEmailTemplatesAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MktpEmailTemplatesAttributes":"#/components/schemas/MktpEmailTemplatesAttributes"}}},"MktpEmailTemplatesAttributes":{"title":"MktpEmailTemplatesAttributes","description":"The email templates communications are sent from on behalf of the marketplace and its sub-merchants.","examples":[{"type":"MktpEmailTemplatesAttributes","platformSupportSenderName":"Ada Lovelace","platformSupportEmail":"ada@example.com","platformSupportEmailSignedBy":"ada@example.com","platformSupportReplyToName":"Ada Lovelace","platformSupportReplyToEmail":"ada@example.com","customerSupportSenderName":"Ada Lovelace","customerSupportEmail":"ada@example.com","customerSupportEmailSignedBy":"ada@example.com","customerSupportReplyToName":"Ada Lovelace","customerSupportReplyToEmail":"ada@example.com","customerEmailBrandLogo":"ada@example.com","merchantOnboardingRequestedTemplateId":"abc123","merchantOnboardingCompletedTemplateId":"abc123","merchantResetPasswordTemplateId":"abc123","merchantResetPasswordConfirmationTemplateId":"abc123","merchantNewOrganisationCustomerDelegateTemplateId":"abc123","merchantNewOrganisationCustomerDelegateConfirmationTemplateId":"abc123"}],"type":"object","required":["type","platformSupportSenderName","platformSupportEmail","merchantOnboardingRequestedTemplateId","merchantOnboardingCompletedTemplateId","merchantResetPasswordTemplateId","merchantResetPasswordConfirmationTemplateId"],"properties":{"type":{"description":"Always `MktpEmailTemplatesAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MktpEmailTemplatesAttributes"]},"platformSupportSenderName":{"description":"Name shown as the sender on platform-support communications.","type":"string"},"platformSupportEmail":{"type":"string"},"platformSupportEmailSignedBy":{"description":"Name the email is signed with, where it differs from the sender.","type":"string"},"platformSupportReplyToName":{"type":"string"},"platformSupportReplyToEmail":{"type":"string"},"customerSupportSenderName":{"description":"Name shown as the sender on communications to sub-merchants' customers. Omit to use the platform-support name.","type":"string"},"customerSupportEmail":{"type":"string"},"customerSupportEmailSignedBy":{"type":"string"},"customerSupportReplyToName":{"type":"string"},"customerSupportReplyToEmail":{"type":"string"},"customerEmailBrandLogo":{"description":"Fully qualified https URI of the logo shown in emails to customers.","type":"string"},"merchantOnboardingRequestedTemplateId":{"description":"Template sent when a sub-merchant is asked to onboard.","type":"string"},"merchantOnboardingCompletedTemplateId":{"description":"Template sent when a sub-merchant finishes onboarding.","type":"string"},"merchantResetPasswordTemplateId":{"type":"string"},"merchantResetPasswordConfirmationTemplateId":{"type":"string"},"merchantNewOrganisationCustomerDelegateTemplateId":{"description":"Template sent to a new delegate of an organisation customer. Absent where the marketplace has no organisation customers.","type":"string"},"merchantNewOrganisationCustomerDelegateConfirmationTemplateId":{"type":"string"}}},"MktpId":{"title":"MktpId","examples":["mktp_9f2Kd8QpLzXw"],"type":"string"},"MktpPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/MktpPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MktpPageAttributes":"#/components/schemas/MktpPageAttributes"}}},"MktpPageAttributes":{"title":"MktpPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"MktpPageAttributes","data":[{"type":"MktpViewAttributes","marketplaceId":"mktp_9f2Kd8QpLzXw","enterpriseId":"ent_9f2Kd8QpLzXw","slug":"example","businessName":"Ada Lovelace","website":"example","companyEmail":"ada@example.com","companyPhone":"+61400000000","status":"Enabled","merchantDashboardAccess":true,"selfManagedGrossSettlement":true,"shortenerBaseUri":"https://example.com/callback","zendeskUserGroupId":1250,"bankTransfers":{"type":"MktpBankTransfersAttributes","bankAccountBsb":"example","bankAccountNumber":"example","payId":"abc123"},"sourceRules":["example"],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `MktpPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MktpPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/MktpView","description":"A marketplace, a platform whose sub-merchants take payments under it."}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"MktpPaymentProfile":{"title":"MktpPaymentProfile","type":"string","enum":["StripeConnectAU","StripeConnectAUAbacus","StripeConnectNZAbacus","AbacusCheckout","AbacusCheckoutStripeComposite","AbacusCardless","AbacusWorldpayAu","AbacusWorldpayNz","AbacusWorldpayStripeCompositeAu","AbacusWorldpayStripeCompositeNz","AbacusFiserv","AbacusFiservStripeComposite","AbacusFiservNz","AbacusFiservNzStripeComposite","AbacusReslyNzStripeConnect","AbacusOnUsAu","AbacusOnUsNz","AbacusOnUsHk","AbacusOnUsSg","AbacusMock","Unknown"]},"MktpPayoutChannel":{"title":"MktpPayoutChannel","type":"string","enum":["Standard","Fast","Unknown"]},"MktpPayoutDefaults":{"oneOf":[{"$ref":"#/components/schemas/MktpPayoutDefaultsAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MktpPayoutDefaultsAttributes":"#/components/schemas/MktpPayoutDefaultsAttributes"}}},"MktpPayoutDefaultsAttributes":{"title":"MktpPayoutDefaultsAttributes","description":"Payout defaults inherited by sub-merchants that have set none of their own. Whole, not merged.","examples":[{"type":"MktpPayoutDefaultsAttributes","payoutDescription":"A short description.","schedule":"Daily","dayOfWeek":"example","dayOfMonth":6,"delayDays":1250,"issueDelayDays":1250,"automatedPayoutsEnabled":true,"automatedDisbursementsEnabled":true}],"type":"object","required":["type","payoutDescription"],"properties":{"type":{"description":"Always `MktpPayoutDefaultsAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MktpPayoutDefaultsAttributes"]},"payoutDescription":{"description":"What appears on the recipient's bank statement.","type":"string"},"schedule":{"$ref":"#/components/schemas/MchtPayoutSchedule"},"dayOfWeek":{"description":"`Monday` to `Friday`. Read when `schedule` is `Weekly` or `Fortnightly`; defaults to `Monday`.","type":"string"},"dayOfMonth":{"description":"Read when `schedule` is `Monthly`; defaults to `1`.","type":"integer","format":"int32"},"delayDays":{"description":"Business days held between taking a payment and disbursing it. One to four; the platform's own default is two.","type":"integer","format":"int32"},"issueDelayDays":{"description":"Days between creating a payout and issuing it. Defaults to `0`.","type":"integer","format":"int32"},"automatedPayoutsEnabled":{"description":"Pay out any available balance automatically on the schedule.","type":"boolean"},"automatedDisbursementsEnabled":{"description":"Let the system disburse the payout rather than an operator doing it by hand.","type":"boolean"}}},"MktpSettings":{"oneOf":[{"$ref":"#/components/schemas/MktpSettingsConfigured"},{"$ref":"#/components/schemas/MktpSettingsNotConfigured"}],"discriminator":{"propertyName":"type","mapping":{"MktpSettingsConfigured":"#/components/schemas/MktpSettingsConfigured","MktpSettingsNotConfigured":"#/components/schemas/MktpSettingsNotConfigured"}}},"MktpSettingsConfigured":{"title":"MktpSettingsConfigured","description":"The marketplace has its own defaults, and here they are.","examples":[{"type":"MktpSettingsConfigured","defaults":{"type":"MktpDefaultsAttributes","settlementType":"Net","bankAccountVerificationRequired":true,"bankAccountVerification":{"type":"MchtVerificationPolicyAttributes","accept":["Match"],"includeResultInResponse":true},"sourceVerificationEnabled":true,"supportedCustomerTypes":["Consumer"],"payInFullMinimum":1250,"payInFullMaximum":1250,"disputesWaived":true,"payoutPriority":10,"showPlatformLogoInTerms":true,"showSavedPaymentMethodsInCheckout":true,"showReferenceOrderIdToCustomer":true,"emailPaymentReceipt":true,"emailPaymentFailure":true,"offerGooglePay":true,"allowCheckoutWithoutPayInFull":true,"manualPaymentsCardOnly":true,"useMarketplaceReceivableAccount":true,"payIdDomain":"example","payoutChannels":["Standard"],"payoutRemitterName":"Ada Lovelace","disbursementSourceAccountId":"abc123"},"taxCountries":["AU"]}],"type":"object","required":["type","defaults"],"properties":{"type":{"description":"Always `MktpSettingsConfigured`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MktpSettingsConfigured"]},"defaults":{"$ref":"#/components/schemas/MktpDefaults"},"taxCountries":{"description":"Every tax country the marketplace can create sub-merchants in, and therefore has a template for.","type":"array","items":{"$ref":"#/components/schemas/IsoCountry"}}}},"MktpSettingsNotConfigured":{"title":"MktpSettingsNotConfigured","description":"No defaults of the marketplace's own, sub-merchants take the platform's. Also what you see without permission to read them.","examples":[{"type":"MktpSettingsNotConfigured","taxCountries":["AU"]}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `MktpSettingsNotConfigured`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MktpSettingsNotConfigured"]},"taxCountries":{"description":"Every tax country the marketplace can create sub-merchants in, and therefore has a template for.","type":"array","items":{"$ref":"#/components/schemas/IsoCountry"}}}},"MktpSort":{"title":"MktpSort","type":"string","enum":["createdAt","-createdAt","updatedAt","-updatedAt"]},"MktpStatus":{"title":"MktpStatus","type":"string","enum":["Enabled","Disabled","Unknown"]},"MktpTag":{"title":"MktpTag","type":"string","enum":["DirectDebit","PayTo","CheckoutV2","CheckoutV3","ServiceProviderFinance","AmexDisallowed","EftposDisallowed","PerformNoComms","ManualVerification","AllowLegacyDelegateCreation","AllowPayoutRemitterUpdate","Travel","Laddr","ApplySurcharge","Unknown"]},"MktpUpdate":{"oneOf":[{"$ref":"#/components/schemas/MktpUpdateBankTransfers"},{"$ref":"#/components/schemas/MktpUpdateBranding"},{"$ref":"#/components/schemas/MktpUpdateBusinessRegistration"},{"$ref":"#/components/schemas/MktpUpdateClearBranding"},{"$ref":"#/components/schemas/MktpUpdateClearCustomerDashboardBranding"},{"$ref":"#/components/schemas/MktpUpdateClearSourceRules"},{"$ref":"#/components/schemas/MktpUpdateClearTags"},{"$ref":"#/components/schemas/MktpUpdateContact"},{"$ref":"#/components/schemas/MktpUpdateCustomerDashboardBranding"},{"$ref":"#/components/schemas/MktpUpdateDefaults"},{"$ref":"#/components/schemas/MktpUpdateEmailTemplates"},{"$ref":"#/components/schemas/MktpUpdatePaymentProfile"},{"$ref":"#/components/schemas/MktpUpdatePayoutDefaults"},{"$ref":"#/components/schemas/MktpUpdateSelfManagedGrossSettlement"},{"$ref":"#/components/schemas/MktpUpdateSourceRules"},{"$ref":"#/components/schemas/MktpUpdateSubMerchantFees"},{"$ref":"#/components/schemas/MktpUpdateTags"}],"discriminator":{"propertyName":"type","mapping":{"MktpUpdateBankTransfers":"#/components/schemas/MktpUpdateBankTransfers","MktpUpdateBranding":"#/components/schemas/MktpUpdateBranding","MktpUpdateBusinessRegistration":"#/components/schemas/MktpUpdateBusinessRegistration","MktpUpdateClearBranding":"#/components/schemas/MktpUpdateClearBranding","MktpUpdateClearCustomerDashboardBranding":"#/components/schemas/MktpUpdateClearCustomerDashboardBranding","MktpUpdateClearSourceRules":"#/components/schemas/MktpUpdateClearSourceRules","MktpUpdateClearTags":"#/components/schemas/MktpUpdateClearTags","MktpUpdateContact":"#/components/schemas/MktpUpdateContact","MktpUpdateCustomerDashboardBranding":"#/components/schemas/MktpUpdateCustomerDashboardBranding","MktpUpdateDefaults":"#/components/schemas/MktpUpdateDefaults","MktpUpdateEmailTemplates":"#/components/schemas/MktpUpdateEmailTemplates","MktpUpdatePaymentProfile":"#/components/schemas/MktpUpdatePaymentProfile","MktpUpdatePayoutDefaults":"#/components/schemas/MktpUpdatePayoutDefaults","MktpUpdateSelfManagedGrossSettlement":"#/components/schemas/MktpUpdateSelfManagedGrossSettlement","MktpUpdateSourceRules":"#/components/schemas/MktpUpdateSourceRules","MktpUpdateSubMerchantFees":"#/components/schemas/MktpUpdateSubMerchantFees","MktpUpdateTags":"#/components/schemas/MktpUpdateTags"}}},"MktpUpdateBankTransfers":{"title":"MktpUpdateBankTransfers","description":"Set up bank transfers. The platform issues the account and the PayID; you supply the domain half.","examples":[{"type":"MktpUpdateBankTransfers","payIdDomain":"example"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `MktpUpdateBankTransfers`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MktpUpdateBankTransfers"]},"payIdDomain":{"description":"The domain half of the PayID to issue, `payments.example.com`. Omit for the platform's default.","type":"string"}}},"MktpUpdateBranding":{"title":"MktpUpdateBranding","description":"Replace the branding sub-merchants inherit for one tax country. Whole, not merged, payout defaults are untouched.","examples":[{"type":"MktpUpdateBranding","taxCountry":"AU","branding":{"type":"MktpBrandingAttributes","iconUri":"https://example.com/callback","logoUri":"https://example.com/callback","logoAltText":"example","supportEmail":"ada@example.com","businessDisplayName":"Ada Lovelace","businessWebsite":"example","customOrderBaseUri":"https://example.com/callback","primaryColor":"example"}}],"type":"object","required":["type","taxCountry","branding"],"properties":{"type":{"description":"Always `MktpUpdateBranding`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MktpUpdateBranding"]},"taxCountry":{"$ref":"#/components/schemas/IsoCountry","description":"ISO 3166-1 alpha-2. The tax country whose branding is being written."},"branding":{"$ref":"#/components/schemas/MktpBranding","description":"Branding sub-merchants inherit where they have none of their own. Whole, not merged, send every field you want to keep."}}},"MktpUpdateBusinessRegistration":{"title":"MktpUpdateBusinessRegistration","description":"Replace how the marketplace entity is registered in one tax country. Whole, not merged.","examples":[{"type":"MktpUpdateBusinessRegistration","taxCountry":"AU","businessRegistration":{"type":"MktpBusinessRegistrationAttributes","businessName":"Ada Lovelace","businessType":"Company","industry":"example","businessRegistrationNumber":"example","taxRegistrationNumber":"example"}}],"type":"object","required":["type","taxCountry","businessRegistration"],"properties":{"type":{"description":"Always `MktpUpdateBusinessRegistration`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MktpUpdateBusinessRegistration"]},"taxCountry":{"$ref":"#/components/schemas/IsoCountry","description":"ISO 3166-1 alpha-2. The tax country whose registration is being written."},"businessRegistration":{"$ref":"#/components/schemas/MktpBusinessRegistration"}}},"MktpUpdateClearBranding":{"title":"MktpUpdateClearBranding","description":"Remove the branding sub-merchants inherit for one tax country.","examples":[{"type":"MktpUpdateClearBranding","taxCountry":"AU"}],"type":"object","required":["type","taxCountry"],"properties":{"type":{"description":"Always `MktpUpdateClearBranding`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MktpUpdateClearBranding"]},"taxCountry":{"$ref":"#/components/schemas/IsoCountry","description":"ISO 3166-1 alpha-2. The tax country whose branding is being cleared."}}},"MktpUpdateClearCustomerDashboardBranding":{"title":"MktpUpdateClearCustomerDashboardBranding","description":"Remove the sub-merchant dashboard branding for one tax country.","examples":[{"type":"MktpUpdateClearCustomerDashboardBranding","taxCountry":"AU"}],"type":"object","required":["type","taxCountry"],"properties":{"type":{"description":"Always `MktpUpdateClearCustomerDashboardBranding`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MktpUpdateClearCustomerDashboardBranding"]},"taxCountry":{"$ref":"#/components/schemas/IsoCountry","description":"ISO 3166-1 alpha-2. The tax country whose dashboard branding is being cleared."}}},"MktpUpdateClearSourceRules":{"title":"MktpUpdateClearSourceRules","description":"Remove every source rule from this marketplace's sub-merchants.","examples":[{"type":"MktpUpdateClearSourceRules"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `MktpUpdateClearSourceRules`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MktpUpdateClearSourceRules"]}}},"MktpUpdateClearTags":{"title":"MktpUpdateClearTags","description":"Remove every feature tag from the marketplace.","examples":[{"type":"MktpUpdateClearTags"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `MktpUpdateClearTags`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MktpUpdateClearTags"]}}},"MktpUpdateContact":{"title":"MktpUpdateContact","description":"Replace the marketplace's contact details for one tax country. Whole, not merged.","examples":[{"type":"MktpUpdateContact","taxCountry":"AU","contact":{"type":"MktpContactAttributes","firstName":"Ada Lovelace","lastName":"Ada Lovelace","title":"example","contactEmail":"ada@example.com","supportEmail":"ada@example.com","phoneNumber":"+61400000000","address":{"type":"MchtAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"}}}],"type":"object","required":["type","taxCountry","contact"],"properties":{"type":{"description":"Always `MktpUpdateContact`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MktpUpdateContact"]},"taxCountry":{"$ref":"#/components/schemas/IsoCountry","description":"ISO 3166-1 alpha-2. The tax country whose profile is being written."},"contact":{"$ref":"#/components/schemas/MktpContact"}}},"MktpUpdateCustomerDashboardBranding":{"title":"MktpUpdateCustomerDashboardBranding","description":"Replace the branding on sub-merchant dashboards for one tax country. Whole, not merged.","examples":[{"type":"MktpUpdateCustomerDashboardBranding","taxCountry":"AU","branding":{"type":"MktpBrandingAttributes","iconUri":"https://example.com/callback","logoUri":"https://example.com/callback","logoAltText":"example","supportEmail":"ada@example.com","businessDisplayName":"Ada Lovelace","businessWebsite":"example","customOrderBaseUri":"https://example.com/callback","primaryColor":"example"}}],"type":"object","required":["type","taxCountry","branding"],"properties":{"type":{"description":"Always `MktpUpdateCustomerDashboardBranding`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MktpUpdateCustomerDashboardBranding"]},"taxCountry":{"$ref":"#/components/schemas/IsoCountry","description":"ISO 3166-1 alpha-2. The tax country whose dashboard branding is being written."},"branding":{"$ref":"#/components/schemas/MktpBranding","description":"Branding sub-merchants inherit where they have none of their own. Whole, not merged, send every field you want to keep."}}},"MktpUpdateDefaults":{"title":"MktpUpdateDefaults","description":"Change the defaults sub-merchants inherit. An absent field is left as it is, not cleared.","examples":[{"type":"MktpUpdateDefaults","defaults":{"type":"MktpDefaultsAttributes","settlementType":"Net","bankAccountVerificationRequired":true,"bankAccountVerification":{"type":"MchtVerificationPolicyAttributes","accept":["Match"],"includeResultInResponse":true},"sourceVerificationEnabled":true,"supportedCustomerTypes":["Consumer"],"payInFullMinimum":1250,"payInFullMaximum":1250,"disputesWaived":true,"payoutPriority":10,"showPlatformLogoInTerms":true,"showSavedPaymentMethodsInCheckout":true,"showReferenceOrderIdToCustomer":true,"emailPaymentReceipt":true,"emailPaymentFailure":true,"offerGooglePay":true,"allowCheckoutWithoutPayInFull":true,"manualPaymentsCardOnly":true,"useMarketplaceReceivableAccount":true,"payIdDomain":"example","payoutChannels":["Standard"],"payoutRemitterName":"Ada Lovelace","disbursementSourceAccountId":"abc123"}}],"type":"object","required":["type","defaults"],"properties":{"type":{"description":"Always `MktpUpdateDefaults`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MktpUpdateDefaults"]},"defaults":{"$ref":"#/components/schemas/MktpDefaults"}}},"MktpUpdateEmailTemplates":{"title":"MktpUpdateEmailTemplates","description":"Replace the email templates communications are sent from, for one tax country. Whole, not merged.","examples":[{"type":"MktpUpdateEmailTemplates","taxCountry":"AU","emailTemplates":{"type":"MktpEmailTemplatesAttributes","platformSupportSenderName":"Ada Lovelace","platformSupportEmail":"ada@example.com","platformSupportEmailSignedBy":"ada@example.com","platformSupportReplyToName":"Ada Lovelace","platformSupportReplyToEmail":"ada@example.com","customerSupportSenderName":"Ada Lovelace","customerSupportEmail":"ada@example.com","customerSupportEmailSignedBy":"ada@example.com","customerSupportReplyToName":"Ada Lovelace","customerSupportReplyToEmail":"ada@example.com","customerEmailBrandLogo":"ada@example.com","merchantOnboardingRequestedTemplateId":"abc123","merchantOnboardingCompletedTemplateId":"abc123","merchantResetPasswordTemplateId":"abc123","merchantResetPasswordConfirmationTemplateId":"abc123","merchantNewOrganisationCustomerDelegateTemplateId":"abc123","merchantNewOrganisationCustomerDelegateConfirmationTemplateId":"abc123"}}],"type":"object","required":["type","taxCountry","emailTemplates"],"properties":{"type":{"description":"Always `MktpUpdateEmailTemplates`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MktpUpdateEmailTemplates"]},"taxCountry":{"$ref":"#/components/schemas/IsoCountry","description":"ISO 3166-1 alpha-2. The tax country whose templates are being written."},"emailTemplates":{"$ref":"#/components/schemas/MktpEmailTemplates"}}},"MktpUpdatePaymentProfile":{"title":"MktpUpdatePaymentProfile","description":"Set the payment provider new sub-merchants are created on. Copied, existing sub-merchants stay where they are.","examples":[{"type":"MktpUpdatePaymentProfile","taxCountry":"AU","paymentProfile":"StripeConnectAU"}],"type":"object","required":["type","taxCountry","paymentProfile"],"properties":{"type":{"description":"Always `MktpUpdatePaymentProfile`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MktpUpdatePaymentProfile"]},"taxCountry":{"$ref":"#/components/schemas/IsoCountry","description":"ISO 3166-1 alpha-2. The tax country whose template is being written."},"paymentProfile":{"$ref":"#/components/schemas/MktpPaymentProfile"}}},"MktpUpdatePayoutDefaults":{"title":"MktpUpdatePayoutDefaults","description":"Replace the payout defaults sub-merchants inherit for one tax country. Whole, not merged, branding is untouched.","examples":[{"type":"MktpUpdatePayoutDefaults","taxCountry":"AU","payoutDefaults":{"type":"MktpPayoutDefaultsAttributes","payoutDescription":"A short description.","schedule":"Daily","dayOfWeek":"example","dayOfMonth":6,"delayDays":1250,"issueDelayDays":1250,"automatedPayoutsEnabled":true,"automatedDisbursementsEnabled":true}}],"type":"object","required":["type","taxCountry","payoutDefaults"],"properties":{"type":{"description":"Always `MktpUpdatePayoutDefaults`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MktpUpdatePayoutDefaults"]},"taxCountry":{"$ref":"#/components/schemas/IsoCountry","description":"ISO 3166-1 alpha-2. The tax country whose payout defaults are being written."},"payoutDefaults":{"$ref":"#/components/schemas/MktpPayoutDefaults","description":"Payout defaults inherited by sub-merchants that have set none of their own. Whole, not merged."}}},"MktpUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/MktpUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MktpUpdateRspAttributes":"#/components/schemas/MktpUpdateRspAttributes"}}},"MktpUpdateRspAttributes":{"title":"MktpUpdateRspAttributes","examples":[{"type":"MktpUpdateRspAttributes","updated":{"type":"MktpViewAttributes","marketplaceId":"mktp_9f2Kd8QpLzXw","enterpriseId":"ent_9f2Kd8QpLzXw","slug":"example","businessName":"Ada Lovelace","website":"example","companyEmail":"ada@example.com","companyPhone":"+61400000000","status":"Enabled","merchantDashboardAccess":true,"selfManagedGrossSettlement":true,"shortenerBaseUri":"https://example.com/callback","zendeskUserGroupId":1250,"bankTransfers":{"type":"MktpBankTransfersAttributes","bankAccountBsb":"example","bankAccountNumber":"example","payId":"abc123"},"sourceRules":["example"],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `MktpUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MktpUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/MktpView","description":"The resource as it stands after the change."}}},"MktpUpdateSelfManagedGrossSettlement":{"title":"MktpUpdateSelfManagedGrossSettlement","description":"Set whether the marketplace collects its own sub-merchants' invoice fees.","examples":[{"type":"MktpUpdateSelfManagedGrossSettlement","selfManagedGrossSettlement":true}],"type":"object","required":["type","selfManagedGrossSettlement"],"properties":{"type":{"description":"Always `MktpUpdateSelfManagedGrossSettlement`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MktpUpdateSelfManagedGrossSettlement"]},"selfManagedGrossSettlement":{"description":"`true` makes the marketplace responsible for collecting its sub-merchants' invoice fees, and lets it mark their invoices paid.","type":"boolean"}}},"MktpUpdateSourceRules":{"title":"MktpUpdateSourceRules","description":"Replace the rules deciding which payment sources sub-merchants may take. Whole, not merged, send every rule you want to keep.","examples":[{"type":"MktpUpdateSourceRules","sourceRules":[{"type":"MchtRuleAttributes","criterion":{"type":"MchtRuleAlways"},"actions":[{"type":"MchtRuleAllow"}]}]}],"type":"object","required":["type","sourceRules"],"properties":{"type":{"description":"Always `MktpUpdateSourceRules`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MktpUpdateSourceRules"]},"sourceRules":{"description":"The rules, in full. At least one, to remove them all, use `MktpUpdateClearSourceRules`.","type":"array","minItems":1,"items":{"$ref":"#/components/schemas/MchtRule"}}}},"MktpUpdateSubMerchantFees":{"title":"MktpUpdateSubMerchantFees","description":"Replace the fees new sub-merchants are created with. Copied onto each new sub-merchant, existing ones keep the rates they signed up under.","examples":[{"type":"MktpUpdateSubMerchantFees","taxCountry":"AU","fees":{"type":"FeesByPaymentForm","fees":{"type":"FeeStructAttributes","split":{"type":"FeeTableAttributes","domestic":{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]},"international":{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]}},"full":{"type":"FeeTableAttributes","domestic":{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]},"international":{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]}}}},"sourceRules":[{"type":"MchtRuleAttributes","criterion":{"type":"MchtRuleAlways"},"actions":[{"type":"MchtRuleAllow"}]}],"calculateTaxOnFee":true,"feesTaxExempt":true}],"type":"object","required":["type","taxCountry","fees","calculateTaxOnFee"],"properties":{"type":{"description":"Always `MktpUpdateSubMerchantFees`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MktpUpdateSubMerchantFees"]},"taxCountry":{"$ref":"#/components/schemas/IsoCountry","description":"ISO 3166-1 alpha-2. The tax country whose template is being written."},"fees":{"$ref":"#/components/schemas/Fees"},"sourceRules":{"description":"Source rules created alongside the fees, surcharging and platform-fee rules that go with them.","type":"array","items":{"$ref":"#/components/schemas/MchtRule"}},"calculateTaxOnFee":{"description":"Add tax to the platform's fees. `false` where the marketplace's fees are quoted tax-inclusive.","type":"boolean"},"feesTaxExempt":{"description":"The sub-merchant trades in a country it is not a tax resident of and is exempt, so no tax is added regardless.","type":"boolean"}}},"MktpUpdateTags":{"title":"MktpUpdateTags","description":"Replace the feature tags on the marketplace. Whole, not merged, a tag left out is removed.","examples":[{"type":"MktpUpdateTags","tags":["DirectDebit"]}],"type":"object","required":["type","tags"],"properties":{"type":{"description":"Always `MktpUpdateTags`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MktpUpdateTags"]},"tags":{"description":"The tags to have, in full. At least one, to remove them all, use `MktpUpdateClearTags`. Repeats are ignored.","type":"array","minItems":1,"items":{"$ref":"#/components/schemas/MktpTag"}}}},"MktpView":{"oneOf":[{"$ref":"#/components/schemas/MktpViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MktpViewAttributes":"#/components/schemas/MktpViewAttributes"}}},"MktpViewAttributes":{"title":"MktpViewAttributes","description":"A marketplace, a platform whose sub-merchants take payments under it.","examples":[{"type":"MktpViewAttributes","marketplaceId":"mktp_9f2Kd8QpLzXw","enterpriseId":"ent_9f2Kd8QpLzXw","slug":"example","businessName":"Ada Lovelace","website":"example","companyEmail":"ada@example.com","companyPhone":"+61400000000","status":"Enabled","merchantDashboardAccess":true,"selfManagedGrossSettlement":true,"shortenerBaseUri":"https://example.com/callback","zendeskUserGroupId":1250,"bankTransfers":{"type":"MktpBankTransfersAttributes","bankAccountBsb":"example","bankAccountNumber":"example","payId":"abc123"},"sourceRules":["example"],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","marketplaceId","enterpriseId","slug","businessName","website","companyEmail","companyPhone","status","merchantDashboardAccess","selfManagedGrossSettlement","createdAt","updatedAt"],"properties":{"type":{"description":"Always `MktpViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MktpViewAttributes"]},"marketplaceId":{"$ref":"#/components/schemas/MktpId","description":"Identifier of a marketplace."},"enterpriseId":{"$ref":"#/components/schemas/EntId","description":"Identifier of an enterprise."},"slug":{"description":"The marketplace's short name, used in URLs and dashboards. Unique, and set at creation.","type":"string"},"businessName":{"type":"string"},"website":{"description":"The marketplace's public website.","type":"string"},"companyEmail":{"description":"Where to contact the marketplace.","type":"string"},"companyPhone":{"description":"Phone number in E.164 format.","type":"string"},"status":{"$ref":"#/components/schemas/MktpStatus"},"merchantDashboardAccess":{"description":"Whether sub-merchants may sign in to their own dashboard.","type":"boolean"},"selfManagedGrossSettlement":{"description":"Whether the marketplace collects its own sub-merchants' invoice fees. This decides who may mark a merchant invoice paid.","type":"boolean"},"shortenerBaseUri":{"description":"Base URL the marketplace's short links are issued under, where it has its own.","type":"string"},"zendeskUserGroupId":{"description":"The marketplace's Zendesk group, where support is routed through one.","type":"integer","format":"int64"},"bankTransfers":{"$ref":"#/components/schemas/MktpBankTransfers"},"sourceRules":{"description":"The rules deciding which payment sources its sub-merchants may take. Empty means no restriction.","type":"array","items":{"type":"string"}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"MktpfeestructCmd":{"oneOf":[{"$ref":"#/components/schemas/MktpfeestructCmdCreate"}],"discriminator":{"propertyName":"type","mapping":{"MktpfeestructCmdCreate":"#/components/schemas/MktpfeestructCmdCreate"}}},"MktpfeestructCmdCreate":{"title":"MktpfeestructCmdCreate","description":"Add a fee structure to a marketplace.","examples":[{"type":"MktpfeestructCmdCreate","marketplaceId":"mktp_9f2Kd8QpLzXw","marketplaceMerchantId":"mcht_9f2Kd8QpLzXw","subMerchantId":"mcht_9f2Kd8QpLzXw","fees":{"type":"FeesByPaymentForm","fees":{"type":"FeeStructAttributes","split":{"type":"FeeTableAttributes","domestic":{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]},"international":{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]}},"full":{"type":"FeeTableAttributes","domestic":{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]},"international":{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]}}}},"enabled":true}],"type":"object","required":["type","marketplaceId","marketplaceMerchantId","fees","enabled"],"properties":{"type":{"description":"Always `MktpfeestructCmdCreate`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MktpfeestructCmdCreate"]},"marketplaceId":{"$ref":"#/components/schemas/MktpId","description":"The marketplace whose earnings these are."},"marketplaceMerchantId":{"$ref":"#/components/schemas/MchtId","description":"The marketplace's own merchant entity, where the earnings are credited."},"subMerchantId":{"$ref":"#/components/schemas/MchtId","description":"The sub-merchant it applies to. Omit to apply it to every sub-merchant of the marketplace."},"fees":{"$ref":"#/components/schemas/Fees"},"enabled":{"description":"`false` configures it without earning on it yet.","type":"boolean"}}},"MktpfeestructCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/MktpfeestructCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MktpfeestructCreateRspAttributes":"#/components/schemas/MktpfeestructCreateRspAttributes"}}},"MktpfeestructCreateRspAttributes":{"title":"MktpfeestructCreateRspAttributes","examples":[{"type":"MktpfeestructCreateRspAttributes","created":{"type":"MktpfeestructViewAttributes","feeStructureId":"mktpfeestruct_9f2Kd8QpLzXw","marketplaceId":"mktp_9f2Kd8QpLzXw","marketplaceMerchantId":"mcht_9f2Kd8QpLzXw","subMerchantId":"mcht_9f2Kd8QpLzXw","fees":{"type":"FeesByPaymentForm","fees":{"type":"FeeStructAttributes","split":{"type":"FeeTableAttributes","domestic":{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]},"international":{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]}},"full":{"type":"FeeTableAttributes","domestic":{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]},"international":{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]}}}},"enabled":true,"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `MktpfeestructCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MktpfeestructCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/MktpfeestructView","description":"The resource that was created."}}},"MktpfeestructId":{"title":"MktpfeestructId","description":"Identifier of a marketplace fee structure.","examples":["mktpfeestruct_9f2Kd8QpLzXw"],"type":"string"},"MktpfeestructUpdate":{"oneOf":[{"$ref":"#/components/schemas/MktpfeestructUpdateDisable"},{"$ref":"#/components/schemas/MktpfeestructUpdateEnable"},{"$ref":"#/components/schemas/MktpfeestructUpdateFees"},{"$ref":"#/components/schemas/MktpfeestructUpdateSubject"}],"discriminator":{"propertyName":"type","mapping":{"MktpfeestructUpdateDisable":"#/components/schemas/MktpfeestructUpdateDisable","MktpfeestructUpdateEnable":"#/components/schemas/MktpfeestructUpdateEnable","MktpfeestructUpdateFees":"#/components/schemas/MktpfeestructUpdateFees","MktpfeestructUpdateSubject":"#/components/schemas/MktpfeestructUpdateSubject"}}},"MktpfeestructUpdateDisable":{"title":"MktpfeestructUpdateDisable","description":"Stop earning on this structure, leaving its rates configured.","examples":[{"type":"MktpfeestructUpdateDisable"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `MktpfeestructUpdateDisable`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MktpfeestructUpdateDisable"]}}},"MktpfeestructUpdateEnable":{"title":"MktpfeestructUpdateEnable","description":"Earn on this structure.","examples":[{"type":"MktpfeestructUpdateEnable"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `MktpfeestructUpdateEnable`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MktpfeestructUpdateEnable"]}}},"MktpfeestructUpdateFees":{"title":"MktpfeestructUpdateFees","description":"Replace the rates. Whole, not merged, send every rate you want to keep.","examples":[{"type":"MktpfeestructUpdateFees","fees":{"type":"FeesByPaymentForm","fees":{"type":"FeeStructAttributes","split":{"type":"FeeTableAttributes","domestic":{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]},"international":{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]}},"full":{"type":"FeeTableAttributes","domestic":{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]},"international":{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]}}}}}],"type":"object","required":["type","fees"],"properties":{"type":{"description":"Always `MktpfeestructUpdateFees`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MktpfeestructUpdateFees"]},"fees":{"$ref":"#/components/schemas/Fees"}}},"MktpfeestructUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/MktpfeestructUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MktpfeestructUpdateRspAttributes":"#/components/schemas/MktpfeestructUpdateRspAttributes"}}},"MktpfeestructUpdateRspAttributes":{"title":"MktpfeestructUpdateRspAttributes","examples":[{"type":"MktpfeestructUpdateRspAttributes","updated":{"type":"MktpfeestructViewAttributes","feeStructureId":"mktpfeestruct_9f2Kd8QpLzXw","marketplaceId":"mktp_9f2Kd8QpLzXw","marketplaceMerchantId":"mcht_9f2Kd8QpLzXw","subMerchantId":"mcht_9f2Kd8QpLzXw","fees":{"type":"FeesByPaymentForm","fees":{"type":"FeeStructAttributes","split":{"type":"FeeTableAttributes","domestic":{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]},"international":{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]}},"full":{"type":"FeeTableAttributes","domestic":{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]},"international":{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]}}}},"enabled":true,"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `MktpfeestructUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MktpfeestructUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/MktpfeestructView","description":"The resource as it stands after the change."}}},"MktpfeestructUpdateSubject":{"title":"MktpfeestructUpdateSubject","description":"Change who the structure applies to and who its earnings are credited to.","examples":[{"type":"MktpfeestructUpdateSubject","marketplaceMerchantId":"mcht_9f2Kd8QpLzXw","subMerchantId":"mcht_9f2Kd8QpLzXw"}],"type":"object","required":["type","marketplaceMerchantId"],"properties":{"type":{"description":"Always `MktpfeestructUpdateSubject`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MktpfeestructUpdateSubject"]},"marketplaceMerchantId":{"$ref":"#/components/schemas/MchtId","description":"The marketplace's own merchant entity, where the earnings are credited."},"subMerchantId":{"$ref":"#/components/schemas/MchtId","description":"The sub-merchant it applies to. Omit to apply it to every sub-merchant of the marketplace."}}},"MktpfeestructView":{"oneOf":[{"$ref":"#/components/schemas/MktpfeestructViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MktpfeestructViewAttributes":"#/components/schemas/MktpfeestructViewAttributes"}}},"MktpfeestructViewAttributes":{"title":"MktpfeestructViewAttributes","description":"What a marketplace earns on payments taken by one of its sub-merchants, or by all of them.","examples":[{"type":"MktpfeestructViewAttributes","feeStructureId":"mktpfeestruct_9f2Kd8QpLzXw","marketplaceId":"mktp_9f2Kd8QpLzXw","marketplaceMerchantId":"mcht_9f2Kd8QpLzXw","subMerchantId":"mcht_9f2Kd8QpLzXw","fees":{"type":"FeesByPaymentForm","fees":{"type":"FeeStructAttributes","split":{"type":"FeeTableAttributes","domestic":{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]},"international":{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]}},"full":{"type":"FeeTableAttributes","domestic":{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]},"international":{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]}}}},"enabled":true,"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","feeStructureId","marketplaceId","marketplaceMerchantId","fees","enabled","createdAt","updatedAt"],"properties":{"type":{"description":"Always `MktpfeestructViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MktpfeestructViewAttributes"]},"feeStructureId":{"$ref":"#/components/schemas/MktpfeestructId"},"marketplaceId":{"$ref":"#/components/schemas/MktpId","description":"Identifier of a marketplace."},"marketplaceMerchantId":{"$ref":"#/components/schemas/MchtId","description":"The marketplace's own merchant entity, where the earnings are credited."},"subMerchantId":{"$ref":"#/components/schemas/MchtId","description":"The sub-merchant this applies to. Absent means every sub-merchant of the marketplace."},"fees":{"$ref":"#/components/schemas/Fees"},"enabled":{"description":"`false` leaves the structure configured but earns nothing, the marketplace falls back to a less specific one, or to none.","type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"MspwId":{"title":"MspwId","description":"Identifier of a merchant's statement password, which is the merchant's own identifier.","examples":["mcht_9f2Kd8QpLzXw"],"type":"string"},"MspwUpdate":{"oneOf":[{"$ref":"#/components/schemas/MspwUpdateReset"}],"discriminator":{"propertyName":"type","mapping":{"MspwUpdateReset":"#/components/schemas/MspwUpdateReset"}}},"MspwUpdateReset":{"title":"MspwUpdateReset","description":"Replace the merchant's password with a newly generated one. The old one stops opening statements sent from now on. Audited.","examples":[{"type":"MspwUpdateReset"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `MspwUpdateReset`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MspwUpdateReset"]}}},"MspwUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/MspwUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MspwUpdateRspAttributes":"#/components/schemas/MspwUpdateRspAttributes"}}},"MspwUpdateRspAttributes":{"title":"MspwUpdateRspAttributes","examples":[{"type":"MspwUpdateRspAttributes","updated":{"type":"MspwViewAttributes","merchantStatementPasswordId":"mcht_9f2Kd8QpLzXw","password":"example"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `MspwUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MspwUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/MspwView","description":"The resource as it stands after the change."}}},"MspwView":{"oneOf":[{"$ref":"#/components/schemas/MspwViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"MspwViewAttributes":"#/components/schemas/MspwViewAttributes"}}},"MspwViewAttributes":{"title":"MspwViewAttributes","description":"The password the merchant's payout statement files are sealed with. Reading it is an audited reveal: it is recorded who asked, and the password reaches no log. Staff only.","examples":[{"type":"MspwViewAttributes","merchantStatementPasswordId":"mcht_9f2Kd8QpLzXw","password":"example"}],"type":"object","required":["type","merchantStatementPasswordId"],"properties":{"type":{"description":"Always `MspwViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["MspwViewAttributes"]},"merchantStatementPasswordId":{"$ref":"#/components/schemas/MspwId"},"password":{"description":"The password in clear. Present only on a read: a reset answers without it, so that revealing it is a read of its own, and audited as one.","type":"string"}}},"NlstCmd":{"oneOf":[{"$ref":"#/components/schemas/NlstCmdCreate"}],"discriminator":{"propertyName":"type","mapping":{"NlstCmdCreate":"#/components/schemas/NlstCmdCreate"}}},"NlstCmdCreate":{"title":"NlstCmdCreate","description":"Make a named list holding these entries, as version 1. It is owned by the caller's tenant or, with `owner`, by a tenant beneath it. Every entry is checked against the kind, and a list whose entries are not all members of it is refused with 400 and every reason.","examples":[{"type":"NlstCmdCreate","domain":"example","owner":{"type":"RpolOwnerEnterprise","enterpriseId":"ent_9f2Kd8QpLzXw"},"name":"Ada Lovelace","kind":"example","description":"A short description.","entries":["example"]}],"type":"object","required":["type","domain","name","kind"],"properties":{"type":{"description":"Always `NlstCmdCreate`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["NlstCmdCreate"]},"domain":{"description":"The area the list is for, as `ruleAreaId` names it.","type":"string"},"owner":{"$ref":"#/components/schemas/RpolOwner","description":"The tenant that owns the list. Absent for the caller's own tenant."},"name":{"type":"string"},"kind":{"description":"The kind of entry it holds, one of the area's `listKinds`.","type":"string"},"description":{"type":"string"},"entries":{"type":"array","items":{"type":"string"}}}},"NlstColumn":{"title":"NlstColumn","type":"string","enum":["NamedListId","Name","Domain","Kind","Description","Version","CreatedAt","CreatedBy","UpdatedAt","RetiredAt"]},"NlstCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/NlstCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"NlstCreateRspAttributes":"#/components/schemas/NlstCreateRspAttributes"}}},"NlstCreateRspAttributes":{"title":"NlstCreateRspAttributes","examples":[{"type":"NlstCreateRspAttributes","created":{"type":"NlstViewAttributes","namedListId":"nlst_9f2Kd8QpLzXw","name":"Ada Lovelace","domain":"example","owner":{"type":"RpolOwnerEnterprise","enterpriseId":"ent_9f2Kd8QpLzXw"},"kind":"example","description":"A short description.","version":1250,"createdAt":"2026-08-19T04:21:07Z","createdBy":"example","updatedAt":"2026-08-19T04:21:07Z","retiredAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `NlstCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["NlstCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/NlstView","description":"The resource that was created."}}},"NlstEntry":{"description":"One entry of a list, as the list held it at a version.","oneOf":[{"$ref":"#/components/schemas/NlstEntryAttributes"}],"discriminator":{"propertyName":"type","mapping":{"NlstEntryAttributes":"#/components/schemas/NlstEntryAttributes"}}},"NlstEntryAttributes":{"title":"NlstEntryAttributes","description":"One entry of a list, as the list held it at a version.","examples":[{"type":"NlstEntryAttributes","value":"example","addedIn":1250,"removedIn":1250,"addedAt":"2026-08-19T04:21:07Z","addedBy":"example"}],"type":"object","required":["type","value","addedIn","addedAt","addedBy"],"properties":{"type":{"description":"Always `NlstEntryAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["NlstEntryAttributes"]},"value":{"description":"The entry as its list holds it: the text it normalises to.","type":"string"},"addedIn":{"description":"The version the entry was added in.","type":"integer","format":"int32"},"removedIn":{"description":"The version it was removed in. Absent for an entry still in the list.","type":"integer","format":"int32"},"addedAt":{"type":"string","format":"date-time"},"addedBy":{"type":"string"}}},"NlstEntryEdit":{"description":"The entries an edit adds to a list and takes from it.","oneOf":[{"$ref":"#/components/schemas/NlstEntryEditAttributes"}],"discriminator":{"propertyName":"type","mapping":{"NlstEntryEditAttributes":"#/components/schemas/NlstEntryEditAttributes"}}},"NlstEntryEditAttributes":{"title":"NlstEntryEditAttributes","description":"The entries an edit adds to a list and takes from it.","examples":[{"type":"NlstEntryEditAttributes","add":["example"],"remove":["example"]}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `NlstEntryEditAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["NlstEntryEditAttributes"]},"add":{"type":"array","items":{"type":"string"}},"remove":{"type":"array","items":{"type":"string"}}}},"NlstEntryPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/NlstEntryPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"NlstEntryPageAttributes":"#/components/schemas/NlstEntryPageAttributes"}}},"NlstEntryPageAttributes":{"title":"NlstEntryPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"NlstEntryPageAttributes","data":[{"type":"NlstEntryAttributes","value":"example","addedIn":1250,"removedIn":1250,"addedAt":"2026-08-19T04:21:07Z","addedBy":"example"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `NlstEntryPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["NlstEntryPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/NlstEntry"}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"NlstId":{"title":"NlstId","description":"Identifier of a named list.","examples":["nlst_9f2Kd8QpLzXw"],"type":"string"},"NlstPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/NlstPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"NlstPageAttributes":"#/components/schemas/NlstPageAttributes"}}},"NlstPageAttributes":{"title":"NlstPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"NlstPageAttributes","data":[{"type":"NlstViewAttributes","namedListId":"nlst_9f2Kd8QpLzXw","name":"Ada Lovelace","domain":"example","owner":{"type":"RpolOwnerEnterprise","enterpriseId":"ent_9f2Kd8QpLzXw"},"kind":"example","description":"A short description.","version":1250,"createdAt":"2026-08-19T04:21:07Z","createdBy":"example","updatedAt":"2026-08-19T04:21:07Z","retiredAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `NlstPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["NlstPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/NlstView","description":"A named set of entries that rules read by name, such as the countries a rule applies to. A rule names a list rather than holding its entries, so an edit to the list reaches every rule that names it. A list has one owner, which alone adds and removes its entries, as do the tenants above it. A rule may name the lists of its own owner and of the tenants above it, and no others."}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"NlstUpdate":{"oneOf":[{"$ref":"#/components/schemas/NlstUpdateEdit"}],"discriminator":{"propertyName":"type","mapping":{"NlstUpdateEdit":"#/components/schemas/NlstUpdateEdit"}}},"NlstUpdateEdit":{"title":"NlstUpdateEdit","description":"Add entries to the list and take entries from it, as the next version. A value already in the list, or not in it to remove, changes nothing, and an edit that changes nothing writes no version.","examples":[{"type":"NlstUpdateEdit","expectedVersion":1250,"entries":{"type":"NlstEntryEditAttributes","add":["example"],"remove":["example"]},"reason":"Requested by the customer."}],"type":"object","required":["type","expectedVersion","entries"],"properties":{"type":{"description":"Always `NlstUpdateEdit`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["NlstUpdateEdit"]},"expectedVersion":{"description":"The version the caller last read. A change to any other version is refused with 409.","type":"integer","format":"int32"},"entries":{"$ref":"#/components/schemas/NlstEntryEdit"},"reason":{"type":"string"}}},"NlstUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/NlstUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"NlstUpdateRspAttributes":"#/components/schemas/NlstUpdateRspAttributes"}}},"NlstUpdateRspAttributes":{"title":"NlstUpdateRspAttributes","examples":[{"type":"NlstUpdateRspAttributes","updated":{"type":"NlstViewAttributes","namedListId":"nlst_9f2Kd8QpLzXw","name":"Ada Lovelace","domain":"example","owner":{"type":"RpolOwnerEnterprise","enterpriseId":"ent_9f2Kd8QpLzXw"},"kind":"example","description":"A short description.","version":1250,"createdAt":"2026-08-19T04:21:07Z","createdBy":"example","updatedAt":"2026-08-19T04:21:07Z","retiredAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `NlstUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["NlstUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/NlstView","description":"The resource as it stands after the change."}}},"NlstVersion":{"description":"One version of a list: the entries added and removed, why, by whom and when.","oneOf":[{"$ref":"#/components/schemas/NlstVersionAttributes"}],"discriminator":{"propertyName":"type","mapping":{"NlstVersionAttributes":"#/components/schemas/NlstVersionAttributes"}}},"NlstVersionAttributes":{"title":"NlstVersionAttributes","description":"One version of a list: the entries added and removed, why, by whom and when.","examples":[{"type":"NlstVersionAttributes","version":1250,"change":"example","added":["example"],"removed":["example"],"reason":"Requested by the customer.","changedBy":"example","changedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","version","change","changedBy","changedAt"],"properties":{"type":{"description":"Always `NlstVersionAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["NlstVersionAttributes"]},"version":{"description":"The version's number, from 1.","type":"integer","format":"int32"},"change":{"description":"What the version changed: `Created`, `Edited` or `Retired`.","type":"string"},"added":{"type":"array","items":{"type":"string"}},"removed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"changedBy":{"type":"string"},"changedAt":{"type":"string","format":"date-time"}}},"NlstVersionPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/NlstVersionPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"NlstVersionPageAttributes":"#/components/schemas/NlstVersionPageAttributes"}}},"NlstVersionPageAttributes":{"title":"NlstVersionPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"NlstVersionPageAttributes","data":[{"type":"NlstVersionAttributes","version":1250,"change":"example","added":["example"],"removed":["example"],"reason":"Requested by the customer.","changedBy":"example","changedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `NlstVersionPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["NlstVersionPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/NlstVersion"}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"NlstView":{"oneOf":[{"$ref":"#/components/schemas/NlstViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"NlstViewAttributes":"#/components/schemas/NlstViewAttributes"}}},"NlstViewAttributes":{"title":"NlstViewAttributes","description":"A named set of entries that rules read by name, such as the countries a rule applies to. A rule names a list rather than holding its entries, so an edit to the list reaches every rule that names it. A list has one owner, which alone adds and removes its entries, as do the tenants above it. A rule may name the lists of its own owner and of the tenants above it, and no others.","examples":[{"type":"NlstViewAttributes","namedListId":"nlst_9f2Kd8QpLzXw","name":"Ada Lovelace","domain":"example","owner":{"type":"RpolOwnerEnterprise","enterpriseId":"ent_9f2Kd8QpLzXw"},"kind":"example","description":"A short description.","version":1250,"createdAt":"2026-08-19T04:21:07Z","createdBy":"example","updatedAt":"2026-08-19T04:21:07Z","retiredAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","namedListId","name","domain","owner","kind","version","createdAt","createdBy","updatedAt"],"properties":{"type":{"description":"Always `NlstViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["NlstViewAttributes"]},"namedListId":{"$ref":"#/components/schemas/NlstId"},"name":{"description":"The list's name, which is unique among its owner's lists of the same area.","type":"string"},"domain":{"description":"The area the list is for, as `ruleAreaId` names it.","type":"string"},"owner":{"$ref":"#/components/schemas/RpolOwner"},"kind":{"description":"The kind of entry it holds, one of its area's `listKinds`. Each entry is checked to be a member of the kind.","type":"string"},"description":{"type":"string"},"version":{"description":"The current version, which an edit names as `expectedVersion`.","type":"integer","format":"int32"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"},"retiredAt":{"description":"When the list was retired. Absent for one that is not.","type":"string","format":"date-time"}}},"OidcDiscovery":{"title":"OidcDiscovery","description":"OpenID Connect discovery document (RFC 8414).","type":"object","required":["issuer","authorization_endpoint","token_endpoint","userinfo_endpoint","jwks_uri"],"properties":{"issuer":{"type":"string"},"authorization_endpoint":{"type":"string"},"token_endpoint":{"type":"string"},"userinfo_endpoint":{"type":"string"},"jwks_uri":{"type":"string"},"response_types_supported":{"type":"array","items":{"type":"string"}},"subject_types_supported":{"type":"array","items":{"type":"string"}},"id_token_signing_alg_values_supported":{"type":"array","items":{"type":"string"}},"grant_types_supported":{"type":"array","items":{"type":"string"}},"scopes_supported":{"type":"array","items":{"type":"string"}},"claims_supported":{"type":"array","items":{"type":"string"}}}},"OidcJwk":{"title":"OidcJwk","description":"A JSON Web Key (RFC 7517).","type":"object","required":["kty","use","kid","alg","n","e"],"properties":{"kty":{"type":"string"},"use":{"type":"string"},"kid":{"type":"string"},"alg":{"type":"string"},"n":{"type":"string"},"e":{"type":"string"}}},"OidcJwks":{"title":"OidcJwks","description":"JSON Web Key Set, the public keys relying parties verify id_token signatures against.","type":"object","properties":{"keys":{"type":"array","items":{"$ref":"#/components/schemas/OidcJwk"}}}},"OidcSsoLaunchRequest":{"title":"OidcSsoLaunchRequest","description":"The SSO launch form body. Submitted as `application/x-www-form-urlencoded` by a top-level form POST.","type":"object","required":["bearerToken","target"],"properties":{"bearerToken":{"description":"The bearer proving who the user already is. In the body, never the URL, a top-level navigation cannot carry a header.","type":"string"},"target":{"description":"Which downstream application to land in. Validated against a registered allow-list.","type":"string"}}},"OidcTokenRequest":{"title":"OidcTokenRequest","description":"Token request (OpenID Connect Core 1.0, section 3.1.3.1). Sent form-encoded, not as JSON.","type":"object","required":["grant_type"],"properties":{"grant_type":{"type":"string"},"code":{"type":"string"},"redirect_uri":{"type":"string"},"refresh_token":{"type":"string"},"client_id":{"type":"string"}}},"OidcTokenResponse":{"title":"OidcTokenResponse","description":"Token response (OpenID Connect Core 1.0, section 3.1.3.3).","type":"object","required":["access_token","token_type","expires_in","id_token"],"properties":{"access_token":{"type":"string"},"token_type":{"type":"string"},"expires_in":{"type":"integer","format":"int64"},"id_token":{"type":"string"},"refresh_token":{"type":"string"},"scope":{"type":"string"}}},"OidcUserInfo":{"title":"OidcUserInfo","description":"\nThe user information a relying party reads with an access token (OpenID Connect Core 1.0,\nsection 5.3). Claim names are the standard's, `sub`, `email`, `email_verified`, which is\nthe whole reason this surface is declared foreign.\n","type":"object","required":["sub"],"properties":{"sub":{"type":"string"},"email":{"type":"string"},"email_verified":{"type":"boolean"},"name":{"type":"string"}}},"OidcidpCmd":{"oneOf":[{"$ref":"#/components/schemas/OidcidpCmdCreate"}],"discriminator":{"propertyName":"type","mapping":{"OidcidpCmdCreate":"#/components/schemas/OidcidpCmdCreate"}}},"OidcidpCmdCreate":{"title":"OidcidpCmdCreate","description":"Register an external OIDC identity provider.","examples":[{"type":"OidcidpCmdCreate","displayName":"Ada Lovelace","issuer":"example","clientId":"abc123","clientSecretRef":"example","discoveryUri":"https://example.com/callback","scopes":["example"],"status":"Enabled"}],"type":"object","required":["type","displayName","issuer","clientId","clientSecretRef"],"properties":{"type":{"description":"Always `OidcidpCmdCreate`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["OidcidpCmdCreate"]},"displayName":{"type":"string"},"issuer":{"type":"string"},"clientId":{"type":"string"},"clientSecretRef":{"description":"Secret Manager reference to the client secret. The secret itself never travels through this API.","type":"string"},"discoveryUri":{"description":"The provider's OIDC discovery document. Defaults to `{issuer}/.well-known/openid-configuration`.","type":"string"},"scopes":{"description":"Scopes to request in the authorisation request. Defaults to `openid`, `email` and `profile`.","type":"array","items":{"type":"string"}},"status":{"$ref":"#/components/schemas/OidcidpStatus","description":"Register the provider disabled, to be enabled later. Defaults to `Enabled`."}}},"OidcidpColumn":{"title":"OidcidpColumn","type":"string","enum":["OidcProviderId","DisplayName","Issuer","ClientId","ClientSecretRef","DiscoveryUri","Status","CreatedAt","UpdatedAt"]},"OidcidpCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/OidcidpCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"OidcidpCreateRspAttributes":"#/components/schemas/OidcidpCreateRspAttributes"}}},"OidcidpCreateRspAttributes":{"title":"OidcidpCreateRspAttributes","examples":[{"type":"OidcidpCreateRspAttributes","created":{"type":"OidcidpViewAttributes","oidcProviderId":"oidcidp_9f2Kd8QpLzXw","displayName":"Ada Lovelace","issuer":"example","clientId":"abc123","clientSecretRef":"example","discoveryUri":"https://example.com/callback","scopes":["example"],"status":"Enabled","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `OidcidpCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["OidcidpCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/OidcidpView","description":"The resource that was created."}}},"OidcidpId":{"title":"OidcidpId","description":"Identifier of an OIDC provider.","examples":["oidcidp_9f2Kd8QpLzXw"],"type":"string"},"OidcidpPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/OidcidpPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"OidcidpPageAttributes":"#/components/schemas/OidcidpPageAttributes"}}},"OidcidpPageAttributes":{"title":"OidcidpPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"OidcidpPageAttributes","data":[{"type":"OidcidpViewAttributes","oidcProviderId":"oidcidp_9f2Kd8QpLzXw","displayName":"Ada Lovelace","issuer":"example","clientId":"abc123","clientSecretRef":"example","discoveryUri":"https://example.com/callback","scopes":["example"],"status":"Enabled","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `OidcidpPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["OidcidpPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/OidcidpView","description":"An external identity provider sign-in can be federated to."}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"OidcidpSort":{"title":"OidcidpSort","type":"string","enum":["createdAt","-createdAt","updatedAt","-updatedAt"]},"OidcidpStatus":{"title":"OidcidpStatus","type":"string","enum":["Enabled","Disabled","Unknown"]},"OidcidpUpdate":{"description":"Mutable attributes of an OIDC provider. Fields you omit are left unchanged.","oneOf":[{"$ref":"#/components/schemas/OidcidpUpdateAttributes"}],"discriminator":{"propertyName":"type","mapping":{"OidcidpUpdateAttributes":"#/components/schemas/OidcidpUpdateAttributes"}}},"OidcidpUpdateAttributes":{"title":"OidcidpUpdateAttributes","description":"Mutable attributes of an OIDC provider. Fields you omit are left unchanged.","examples":[{"type":"OidcidpUpdateAttributes","displayName":"Ada Lovelace","issuer":"example","clientId":"abc123","clientSecretRef":"example","discoveryUri":"https://example.com/callback","scopes":["example"],"status":"Enabled"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `OidcidpUpdateAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["OidcidpUpdateAttributes"]},"displayName":{"type":"string"},"issuer":{"type":"string"},"clientId":{"type":"string"},"clientSecretRef":{"description":"Secret Manager reference to the client secret. The secret itself never travels through this API.","type":"string"},"discoveryUri":{"type":"string"},"scopes":{"description":"Replaces the requested scopes outright, send the full set you want.","type":"array","items":{"type":"string"}},"status":{"$ref":"#/components/schemas/OidcidpStatus","description":"`Disabled` stops new sign-ins through this provider; existing sessions are unaffected."}}},"OidcidpUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/OidcidpUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"OidcidpUpdateRspAttributes":"#/components/schemas/OidcidpUpdateRspAttributes"}}},"OidcidpUpdateRspAttributes":{"title":"OidcidpUpdateRspAttributes","examples":[{"type":"OidcidpUpdateRspAttributes","updated":{"type":"OidcidpViewAttributes","oidcProviderId":"oidcidp_9f2Kd8QpLzXw","displayName":"Ada Lovelace","issuer":"example","clientId":"abc123","clientSecretRef":"example","discoveryUri":"https://example.com/callback","scopes":["example"],"status":"Enabled","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `OidcidpUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["OidcidpUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/OidcidpView","description":"The resource as it stands after the change."}}},"OidcidpView":{"oneOf":[{"$ref":"#/components/schemas/OidcidpViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"OidcidpViewAttributes":"#/components/schemas/OidcidpViewAttributes"}}},"OidcidpViewAttributes":{"title":"OidcidpViewAttributes","description":"An external identity provider sign-in can be federated to.","examples":[{"type":"OidcidpViewAttributes","oidcProviderId":"oidcidp_9f2Kd8QpLzXw","displayName":"Ada Lovelace","issuer":"example","clientId":"abc123","clientSecretRef":"example","discoveryUri":"https://example.com/callback","scopes":["example"],"status":"Enabled","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","oidcProviderId","displayName","issuer","clientId","clientSecretRef","discoveryUri","status","createdAt","updatedAt"],"properties":{"type":{"description":"Always `OidcidpViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["OidcidpViewAttributes"]},"oidcProviderId":{"$ref":"#/components/schemas/OidcidpId"},"displayName":{"description":"Shown to a user before they are redirected to the provider.","type":"string"},"issuer":{"description":"The OIDC issuer, the `iss` claim.","type":"string"},"clientId":{"description":"Our relying-party client id, registered at the provider.","type":"string"},"clientSecretRef":{"description":"Secret Manager reference to our client secret at the provider. **Never the secret value itself.**","type":"string"},"discoveryUri":{"description":"The provider's OIDC discovery document. Defaults to `{issuer}/.well-known/openid-configuration`.","type":"string"},"scopes":{"description":"Scopes requested in the authorisation request.","type":"array","items":{"type":"string"}},"status":{"$ref":"#/components/schemas/OidcidpStatus"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"OprosBusiness":{"description":"What the business registry said about the business. The registry's own words, passed through.","oneOf":[{"$ref":"#/components/schemas/OprosBusinessAttributes"}],"discriminator":{"propertyName":"type","mapping":{"OprosBusinessAttributes":"#/components/schemas/OprosBusinessAttributes"}}},"OprosBusinessAttributes":{"title":"OprosBusinessAttributes","description":"What the business registry said about the business. The registry's own words, passed through.","examples":[{"type":"OprosBusinessAttributes","businessIdentifier":{"type":"OprosBusinessIdentifierAbn","abn":"example"},"acn":"example","businessName":"Ada Lovelace","status":"Active","dateRegistered":"example","businessType":"example","businessAddress":{"type":"MchtAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"},"owners":[{"type":"PersonAttributes","givenName":"Ada Lovelace","middleName":"Ada Lovelace","familyName":"Ada Lovelace","dateOfBirth":"2026-08-19","address":{"type":"MchtAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"}}],"delegateEmailAddress":"ada@example.com"}],"type":"object","required":["type","businessIdentifier","acn","businessName","status","dateRegistered","businessType","businessAddress","owners","delegateEmailAddress"],"properties":{"type":{"description":"Always `OprosBusinessAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["OprosBusinessAttributes"]},"businessIdentifier":{"$ref":"#/components/schemas/OprosBusinessIdentifier"},"acn":{"description":"Australian Company Number, where the business has one.","type":"string"},"businessName":{"type":"string"},"status":{"description":"The registry's own status string, not an enumeration. Show it; do not branch on it.","type":"string"},"dateRegistered":{"description":"The registry's own date string. Not reliably formatted, providers differ.","type":"string"},"businessType":{"description":"The registry's own business-type string, not an enumeration.","type":"string"},"businessAddress":{"$ref":"#/components/schemas/MchtAddress","description":"A postal address. Supplying one on a patch replaces the whole address, you cannot patch half of one."},"owners":{"description":"Who the registry says beneficially owns the business. Name one of these as the first delegate.","type":"array","minItems":1,"items":{"$ref":"#/components/schemas/Person","description":"A natural person, the three facts every identity check on this platform is made of."}},"delegateEmailAddress":{"description":"Where the delegate invitation will be sent, established by the prospect flow that issued the token.","type":"string"}}},"OprosBusinessIdentifier":{"oneOf":[{"$ref":"#/components/schemas/OprosBusinessIdentifierAbn"}],"discriminator":{"propertyName":"type","mapping":{"OprosBusinessIdentifierAbn":"#/components/schemas/OprosBusinessIdentifierAbn"}}},"OprosBusinessIdentifierAbn":{"title":"OprosBusinessIdentifierAbn","description":"An Australian Business Number.","examples":[{"type":"OprosBusinessIdentifierAbn","abn":"example"}],"type":"object","required":["type","abn"],"properties":{"type":{"description":"Always `OprosBusinessIdentifierAbn`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["OprosBusinessIdentifierAbn"]},"abn":{"type":"string"}}},"OprosCmd":{"oneOf":[{"$ref":"#/components/schemas/OprosCmdAcceptOwner"},{"$ref":"#/components/schemas/OprosCmdCheckBusiness"}],"discriminator":{"propertyName":"type","mapping":{"OprosCmdAcceptOwner":"#/components/schemas/OprosCmdAcceptOwner","OprosCmdCheckBusiness":"#/components/schemas/OprosCmdCheckBusiness"}}},"OprosCmdAcceptOwner":{"title":"OprosCmdAcceptOwner","description":"Create the organisation customer, with one of the business's owners as its first delegate.","examples":[{"type":"OprosCmdAcceptOwner","merchantId":"mcht_9f2Kd8QpLzXw","prospectToken":"tok_9f2Kd8QpLzXwR4mN","ownerIndex":1250}],"type":"object","required":["type","merchantId","prospectToken","ownerIndex"],"properties":{"type":{"description":"Always `OprosCmdAcceptOwner`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["OprosCmdAcceptOwner"]},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"The merchant the prospect is becoming a customer of. Named rather than inferred, see the note on the command."},"prospectToken":{"description":"The token from the check. It is the credential for this step.","type":"string"},"ownerIndex":{"description":"The owner's position in the `owners` list of the check's response, counting from zero.","type":"integer","format":"int64"}}},"OprosCmdCheckBusiness":{"title":"OprosCmdCheckBusiness","description":"Look the business up in the registry and return its beneficial owners, or the customer it already is.","examples":[{"type":"OprosCmdCheckBusiness","merchantId":"mcht_9f2Kd8QpLzXw","prospectToken":"tok_9f2Kd8QpLzXwR4mN","businessIdentifier":{"type":"OprosBusinessIdentifierAbn","abn":"example"}}],"type":"object","required":["type","merchantId","prospectToken","businessIdentifier"],"properties":{"type":{"description":"Always `OprosCmdCheckBusiness`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["OprosCmdCheckBusiness"]},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"The merchant the prospect is becoming a customer of. Named rather than inferred, see the note on the command."},"prospectToken":{"description":"The token from the prospect flow. It is the credential for this step, not just a correlation.","type":"string"},"businessIdentifier":{"$ref":"#/components/schemas/OprosBusinessIdentifier"}}},"OprosRsp":{"oneOf":[{"$ref":"#/components/schemas/OprosRspBusinessFound"},{"$ref":"#/components/schemas/OprosRspCustomerCreated"},{"$ref":"#/components/schemas/OprosRspCustomerExists"}],"discriminator":{"propertyName":"type","mapping":{"OprosRspBusinessFound":"#/components/schemas/OprosRspBusinessFound","OprosRspCustomerCreated":"#/components/schemas/OprosRspCustomerCreated","OprosRspCustomerExists":"#/components/schemas/OprosRspCustomerExists"}}},"OprosRspBusinessFound":{"title":"OprosRspBusinessFound","description":"The business was found and is not yet a customer. Name one of its owners to create it.","examples":[{"type":"OprosRspBusinessFound","business":{"type":"OprosBusinessAttributes","businessIdentifier":{"type":"OprosBusinessIdentifierAbn","abn":"example"},"acn":"example","businessName":"Ada Lovelace","status":"Active","dateRegistered":"example","businessType":"example","businessAddress":{"type":"MchtAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"},"owners":[{"type":"PersonAttributes","givenName":"Ada Lovelace","middleName":"Ada Lovelace","familyName":"Ada Lovelace","dateOfBirth":"2026-08-19","address":{"type":"MchtAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"}}],"delegateEmailAddress":"ada@example.com"},"prospectToken":"tok_9f2Kd8QpLzXwR4mN"}],"type":"object","required":["type","business","prospectToken"],"properties":{"type":{"description":"Always `OprosRspBusinessFound`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["OprosRspBusinessFound"]},"business":{"$ref":"#/components/schemas/OprosBusiness"},"prospectToken":{"description":"Carry this into the next step. It now also holds what the check established.","type":"string"}}},"OprosRspCustomerCreated":{"title":"OprosRspCustomerCreated","description":"The organisation customer and its first delegate now exist.","examples":[{"type":"OprosRspCustomerCreated","customerId":"cust_9f2Kd8QpLzXw","delegateId":"custd_9f2Kd8QpLzXw","delegateSignInToken":"tok_9f2Kd8QpLzXwR4mN"}],"type":"object","required":["type","customerId","delegateId","delegateSignInToken"],"properties":{"type":{"description":"Always `OprosRspCustomerCreated`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["OprosRspCustomerCreated"]},"customerId":{"$ref":"#/components/schemas/CustId","description":"Identifier of a customer."},"delegateId":{"$ref":"#/components/schemas/CustdId"},"delegateSignInToken":{"description":"A sign-in token for the new delegate. Returned once, here, it is how they get into the dashboard the first time.","type":"string"}}},"OprosRspCustomerExists":{"title":"OprosRspCustomerExists","description":"The business already has an organisation customer. There is nothing to create.","examples":[{"type":"OprosRspCustomerExists","customerId":"cust_9f2Kd8QpLzXw","businessName":"Ada Lovelace","prospectToken":"tok_9f2Kd8QpLzXwR4mN"}],"type":"object","required":["type","customerId","businessName","prospectToken"],"properties":{"type":{"description":"Always `OprosRspCustomerExists`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["OprosRspCustomerExists"]},"customerId":{"$ref":"#/components/schemas/CustId","description":"Identifier of a customer."},"businessName":{"type":"string"},"prospectToken":{"type":"string"}}},"OrdrAddress":{"description":"A postal address.","oneOf":[{"$ref":"#/components/schemas/OrdrAddressAttributes"}],"discriminator":{"propertyName":"type","mapping":{"OrdrAddressAttributes":"#/components/schemas/OrdrAddressAttributes"}}},"OrdrAddressAttributes":{"title":"OrdrAddressAttributes","description":"A postal address.","examples":[{"type":"OrdrAddressAttributes","line1":"example","line2":"example","city":"example","state":"example","postalCode":"3000","country":"AU"}],"type":"object","required":["type","line1","city","state","postalCode","country"],"properties":{"type":{"description":"Always `OrdrAddressAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["OrdrAddressAttributes"]},"line1":{"type":"string"},"line2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"postalCode":{"type":"string"},"country":{"$ref":"#/components/schemas/IsoCountry"}}},"OrdrAmounts":{"description":"The amounts on an order. All are in the single currency given here.","oneOf":[{"$ref":"#/components/schemas/OrdrAmountsAttributes"}],"discriminator":{"propertyName":"type","mapping":{"OrdrAmountsAttributes":"#/components/schemas/OrdrAmountsAttributes"}}},"OrdrAmountsAttributes":{"title":"OrdrAmountsAttributes","description":"The amounts on an order. All are in the single currency given here.","examples":[{"type":"OrdrAmountsAttributes","currency":"AUD","total":1250,"tax":1250,"paid":1250,"outstanding":1250,"surcharge":1250,"discount":1250}],"type":"object","required":["type","currency","total","outstanding","surcharge"],"properties":{"type":{"description":"Always `OrdrAmountsAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["OrdrAmountsAttributes"]},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"total":{"$ref":"#/components/schemas/MinorUnits","description":"The order total before any surcharge, what goes on the invoice."},"tax":{"$ref":"#/components/schemas/MinorUnits","description":"Tax within the total, where the order states tax is included."},"paid":{"$ref":"#/components/schemas/MinorUnits","description":"What has actually been paid, surcharge included. Absent until the order is paid."},"outstanding":{"$ref":"#/components/schemas/MinorUnits","description":"Still owing, the total less what has been paid."},"surcharge":{"$ref":"#/components/schemas/MinorUnits","description":"The surcharge the payment method used added, where one was. Zero until the order is paid."},"discount":{"$ref":"#/components/schemas/MinorUnits","description":"A discount applied to the order total."}}},"OrdrBilling":{"oneOf":[{"$ref":"#/components/schemas/OrdrBillingAttributes"}],"discriminator":{"propertyName":"type","mapping":{"OrdrBillingAttributes":"#/components/schemas/OrdrBillingAttributes"}}},"OrdrBillingAttributes":{"title":"OrdrBillingAttributes","description":"Who is paying, and where they are billed.","examples":[{"type":"OrdrBillingAttributes","name":"Ada Lovelace","address":{"type":"OrdrAddressAttributes","line1":"example","line2":"example","city":"example","state":"example","postalCode":"3000","country":"AU"},"phone":"+61400000000"}],"type":"object","required":["type","name","address"],"properties":{"type":{"description":"Always `OrdrBillingAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["OrdrBillingAttributes"]},"name":{"type":"string"},"address":{"$ref":"#/components/schemas/OrdrAddress"},"phone":{"type":"string"}}},"OrdrCmd":{"oneOf":[{"$ref":"#/components/schemas/OrdrCmdCreate"},{"$ref":"#/components/schemas/OrdrCmdCreateInvoice"}],"discriminator":{"propertyName":"type","mapping":{"OrdrCmdCreate":"#/components/schemas/OrdrCmdCreate","OrdrCmdCreateInvoice":"#/components/schemas/OrdrCmdCreateInvoice"}}},"OrdrCmdCreate":{"title":"OrdrCmdCreate","description":"Create an order.","examples":[{"type":"OrdrCmdCreate","order":{"type":"OrdrNewOrderAttributes","merchantId":"mcht_9f2Kd8QpLzXw","customerId":"cust_9f2Kd8QpLzXw","orderType":"Online","referenceOrderId":"your-own-reference","description":"A short description.","amount":1250,"currency":"AUD","billing":{"type":"OrdrBillingAttributes","name":"Ada Lovelace","address":{"type":"OrdrAddressAttributes","line1":"example","line2":"example","city":"example","state":"example","postalCode":"3000","country":"AU"},"phone":"+61400000000"},"emailAddress":"ada@example.com","phoneNumber":"+61400000000","lineItems":[{"type":"OrdrNewLineItemAttributes","description":"A short description.","quantity":12.5,"amount":1250,"sku":"example","imageUrl":"https://example.com/callback"}],"taxIncluded":true,"taxAmount":1250,"discount":1250,"shipping":{"type":"OrdrShippingAttributes","name":"Ada Lovelace","address":{"type":"OrdrAddressAttributes","line1":"example","line2":"example","city":"example","state":"example","postalCode":"3000","country":"AU"},"amount":1250,"carrier":"example","trackingNumber":"example","phone":"+61400000000"},"request3DSOnPayment":true,"emailCustomerReceipt":true,"settlement":"Default","metadata":{"yourKey":{}}}}],"type":"object","required":["type","order"],"properties":{"type":{"description":"Always `OrdrCmdCreate`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["OrdrCmdCreate"]},"order":{"$ref":"#/components/schemas/OrdrNewOrder","description":"The order to create."}}},"OrdrCmdCreateInvoice":{"title":"OrdrCmdCreateInvoice","description":"Create an order and issue a payment link for it, optionally sending the link to the payer.","examples":[{"type":"OrdrCmdCreateInvoice","order":{"type":"OrdrNewOrderAttributes","merchantId":"mcht_9f2Kd8QpLzXw","customerId":"cust_9f2Kd8QpLzXw","orderType":"Online","referenceOrderId":"your-own-reference","description":"A short description.","amount":1250,"currency":"AUD","billing":{"type":"OrdrBillingAttributes","name":"Ada Lovelace","address":{"type":"OrdrAddressAttributes","line1":"example","line2":"example","city":"example","state":"example","postalCode":"3000","country":"AU"},"phone":"+61400000000"},"emailAddress":"ada@example.com","phoneNumber":"+61400000000","lineItems":[{"type":"OrdrNewLineItemAttributes","description":"A short description.","quantity":12.5,"amount":1250,"sku":"example","imageUrl":"https://example.com/callback"}],"taxIncluded":true,"taxAmount":1250,"discount":1250,"shipping":{"type":"OrdrShippingAttributes","name":"Ada Lovelace","address":{"type":"OrdrAddressAttributes","line1":"example","line2":"example","city":"example","state":"example","postalCode":"3000","country":"AU"},"amount":1250,"carrier":"example","trackingNumber":"example","phone":"+61400000000"},"request3DSOnPayment":true,"emailCustomerReceipt":true,"settlement":"Default","metadata":{"yourKey":{}}},"sendBySms":true,"sendByEmail":true}],"type":"object","required":["type","order"],"properties":{"type":{"description":"Always `OrdrCmdCreateInvoice`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["OrdrCmdCreateInvoice"]},"order":{"$ref":"#/components/schemas/OrdrNewOrder","description":"The order to create. `orderType` is normally `Invoice` for a link."},"sendBySms":{"description":"Text the payer a link.","type":"boolean"},"sendByEmail":{"description":"Email the payer a link.","type":"boolean"}}},"OrdrColumn":{"title":"OrdrColumn","type":"string","enum":["OrderId","MerchantId","MarketplaceId","CustomerName","CustomerEmailAddress","CustomerPhoneNumber","Status","OrderType","AmountsCurrency","AmountsTotal","AmountsTax","AmountsPaid","AmountsOutstanding","AmountsSurcharge","AmountsDiscount","Description","ShippingName","ShippingAddressLine1","ShippingAddressLine2","ShippingAddressCity","ShippingAddressState","ShippingAddressPostalCode","ShippingAddressCountry","ShippingAmount","ShippingCarrier","ShippingTrackingNumber","ShippingPhone","BillingName","BillingAddressLine1","BillingAddressLine2","BillingAddressCity","BillingAddressState","BillingAddressPostalCode","BillingAddressCountry","BillingPhone","Settlement","Request3DSOnPayment","EmailCustomerReceipt","ReferenceOrderId","CreatedAt","UpdatedAt"]},"OrdrCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/OrdrCreateRspInvoice"},{"$ref":"#/components/schemas/OrdrCreateRspOrder"}],"discriminator":{"propertyName":"type","mapping":{"OrdrCreateRspInvoice":"#/components/schemas/OrdrCreateRspInvoice","OrdrCreateRspOrder":"#/components/schemas/OrdrCreateRspOrder"}}},"OrdrCreateRspInvoice":{"title":"OrdrCreateRspInvoice","description":"The order was created and a payment link issued for it. The token is here and nowhere else.","examples":[{"type":"OrdrCreateRspInvoice","created":{"type":"OrdrViewAttributes","orderId":"ordr_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","marketplaceId":"mktp_9f2Kd8QpLzXw","customer":{"type":"OrdrCustomerAttributes","name":"Ada Lovelace","emailAddress":"ada@example.com","phoneNumber":"+61400000000"},"status":"Created","orderType":"Online","amounts":{"type":"OrdrAmountsAttributes","currency":"AUD","total":1250,"tax":1250,"paid":1250,"outstanding":1250,"surcharge":1250,"discount":1250},"lineItems":[{"type":"OrdrLineItemInvoice","description":"A short description.","unitCount":12.5,"fee":1250,"tax":1250,"value":1250,"category":"example","notes":"example"}],"description":"A short description.","shipping":{"type":"OrdrShippingAttributes","name":"Ada Lovelace","address":{"type":"OrdrAddressAttributes","line1":"example","line2":"example","city":"example","state":"example","postalCode":"3000","country":"AU"},"amount":1250,"carrier":"example","trackingNumber":"example","phone":"+61400000000"},"billing":{"type":"OrdrBillingAttributes","name":"Ada Lovelace","address":{"type":"OrdrAddressAttributes","line1":"example","line2":"example","city":"example","state":"example","postalCode":"3000","country":"AU"},"phone":"+61400000000"},"settlement":"Default","request3DSOnPayment":true,"emailCustomerReceipt":true,"referenceOrderId":"your-own-reference","metadata":{"yourKey":{}},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"},"paymentLink":{"type":"OrdrPaymentLinkAttributes","token":"tok_9f2Kd8QpLzXwR4mN","url":"https://example.com/callback"}}],"type":"object","required":["type","created","paymentLink"],"properties":{"type":{"description":"Always `OrdrCreateRspInvoice`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["OrdrCreateRspInvoice"]},"created":{"$ref":"#/components/schemas/OrdrView"},"paymentLink":{"$ref":"#/components/schemas/OrdrPaymentLink","description":"A link that lets its bearer pay an order without any other credential."}}},"OrdrCreateRspOrder":{"title":"OrdrCreateRspOrder","description":"The order was created.","examples":[{"type":"OrdrCreateRspOrder","created":{"type":"OrdrViewAttributes","orderId":"ordr_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","marketplaceId":"mktp_9f2Kd8QpLzXw","customer":{"type":"OrdrCustomerAttributes","name":"Ada Lovelace","emailAddress":"ada@example.com","phoneNumber":"+61400000000"},"status":"Created","orderType":"Online","amounts":{"type":"OrdrAmountsAttributes","currency":"AUD","total":1250,"tax":1250,"paid":1250,"outstanding":1250,"surcharge":1250,"discount":1250},"lineItems":[{"type":"OrdrLineItemInvoice","description":"A short description.","unitCount":12.5,"fee":1250,"tax":1250,"value":1250,"category":"example","notes":"example"}],"description":"A short description.","shipping":{"type":"OrdrShippingAttributes","name":"Ada Lovelace","address":{"type":"OrdrAddressAttributes","line1":"example","line2":"example","city":"example","state":"example","postalCode":"3000","country":"AU"},"amount":1250,"carrier":"example","trackingNumber":"example","phone":"+61400000000"},"billing":{"type":"OrdrBillingAttributes","name":"Ada Lovelace","address":{"type":"OrdrAddressAttributes","line1":"example","line2":"example","city":"example","state":"example","postalCode":"3000","country":"AU"},"phone":"+61400000000"},"settlement":"Default","request3DSOnPayment":true,"emailCustomerReceipt":true,"referenceOrderId":"your-own-reference","metadata":{"yourKey":{}},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `OrdrCreateRspOrder`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["OrdrCreateRspOrder"]},"created":{"$ref":"#/components/schemas/OrdrView"}}},"OrdrCustomer":{"description":"Who is paying.","oneOf":[{"$ref":"#/components/schemas/OrdrCustomerAttributes"}],"discriminator":{"propertyName":"type","mapping":{"OrdrCustomerAttributes":"#/components/schemas/OrdrCustomerAttributes"}}},"OrdrCustomerAttributes":{"title":"OrdrCustomerAttributes","description":"Who is paying.","examples":[{"type":"OrdrCustomerAttributes","name":"Ada Lovelace","emailAddress":"ada@example.com","phoneNumber":"+61400000000"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `OrdrCustomerAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["OrdrCustomerAttributes"]},"name":{"description":"The payer's billing name, or their email address where there is no billing name.","type":"string"},"emailAddress":{"description":"Masked unless your credential may read order PII.","type":"string"},"phoneNumber":{"description":"Masked unless your credential may read order PII. E.164.","type":"string"}}},"OrdrId":{"title":"OrdrId","examples":["ordr_9f2Kd8QpLzXw"],"type":"string"},"OrdrLineItem":{"oneOf":[{"$ref":"#/components/schemas/OrdrLineItemInvoice"},{"$ref":"#/components/schemas/OrdrLineItemProduct"}],"discriminator":{"propertyName":"type","mapping":{"OrdrLineItemInvoice":"#/components/schemas/OrdrLineItemInvoice","OrdrLineItemProduct":"#/components/schemas/OrdrLineItemProduct"}}},"OrdrLineItemInvoice":{"title":"OrdrLineItemInvoice","description":"An invoice line, something being billed, with its own tax.","examples":[{"type":"OrdrLineItemInvoice","description":"A short description.","unitCount":12.5,"fee":1250,"tax":1250,"value":1250,"category":"example","notes":"example"}],"type":"object","required":["type","description","unitCount","fee","tax"],"properties":{"type":{"description":"Always `OrdrLineItemInvoice`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["OrdrLineItemInvoice"]},"description":{"description":"What the line is for.","type":"string"},"unitCount":{"description":"How many units, fractional allowed.","type":"number"},"fee":{"$ref":"#/components/schemas/MinorUnits","description":"The fee charged on this line, in the order's currency."},"tax":{"$ref":"#/components/schemas/MinorUnits","description":"Tax charged on this line, in the order's currency."},"value":{"$ref":"#/components/schemas/MinorUnits","description":"The value of what is being billed for, where it differs from the fee."},"category":{"description":"How the line is classified on the invoice.","type":"string"},"notes":{"description":"Free text shown against the line.","type":"string"}}},"OrdrLineItemProduct":{"title":"OrdrLineItemProduct","description":"A product line, something being sold, with a price per unit.","examples":[{"type":"OrdrLineItemProduct","description":"A short description.","quantity":12.5,"amount":1250,"sku":"example","imageUrl":"https://example.com/callback"}],"type":"object","required":["type","description","quantity","amount"],"properties":{"type":{"description":"Always `OrdrLineItemProduct`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["OrdrLineItemProduct"]},"description":{"type":"string"},"quantity":{"description":"How many. Fractional quantities are allowed, because an hour and a half is a quantity.","type":"number"},"amount":{"$ref":"#/components/schemas/MinorUnits","description":"Price of the line, in the order's currency."},"sku":{"description":"Your own stock-keeping code for the item.","type":"string"},"imageUrl":{"description":"An image of the item, to show at checkout.","type":"string"}}},"OrdrNewLineItem":{"description":"A product line on a new order.","oneOf":[{"$ref":"#/components/schemas/OrdrNewLineItemAttributes"}],"discriminator":{"propertyName":"type","mapping":{"OrdrNewLineItemAttributes":"#/components/schemas/OrdrNewLineItemAttributes"}}},"OrdrNewLineItemAttributes":{"title":"OrdrNewLineItemAttributes","description":"A product line on a new order.","examples":[{"type":"OrdrNewLineItemAttributes","description":"A short description.","quantity":12.5,"amount":1250,"sku":"example","imageUrl":"https://example.com/callback"}],"type":"object","required":["type","description","quantity","amount"],"properties":{"type":{"description":"Always `OrdrNewLineItemAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["OrdrNewLineItemAttributes"]},"description":{"type":"string"},"quantity":{"description":"How many. Fractional quantities are allowed.","type":"number"},"amount":{"$ref":"#/components/schemas/MinorUnits","description":"Price of the line, in the order's currency."},"sku":{"description":"Your own stock-keeping code for the item.","type":"string"},"imageUrl":{"description":"An image of the item, to show at checkout.","type":"string"}}},"OrdrNewOrder":{"oneOf":[{"$ref":"#/components/schemas/OrdrNewOrderAttributes"}],"discriminator":{"propertyName":"type","mapping":{"OrdrNewOrderAttributes":"#/components/schemas/OrdrNewOrderAttributes"}}},"OrdrNewOrderAttributes":{"title":"OrdrNewOrderAttributes","description":"The order to create.","examples":[{"type":"OrdrNewOrderAttributes","merchantId":"mcht_9f2Kd8QpLzXw","customerId":"cust_9f2Kd8QpLzXw","orderType":"Online","referenceOrderId":"your-own-reference","description":"A short description.","amount":1250,"currency":"AUD","billing":{"type":"OrdrBillingAttributes","name":"Ada Lovelace","address":{"type":"OrdrAddressAttributes","line1":"example","line2":"example","city":"example","state":"example","postalCode":"3000","country":"AU"},"phone":"+61400000000"},"emailAddress":"ada@example.com","phoneNumber":"+61400000000","lineItems":[{"type":"OrdrNewLineItemAttributes","description":"A short description.","quantity":12.5,"amount":1250,"sku":"example","imageUrl":"https://example.com/callback"}],"taxIncluded":true,"taxAmount":1250,"discount":1250,"shipping":{"type":"OrdrShippingAttributes","name":"Ada Lovelace","address":{"type":"OrdrAddressAttributes","line1":"example","line2":"example","city":"example","state":"example","postalCode":"3000","country":"AU"},"amount":1250,"carrier":"example","trackingNumber":"example","phone":"+61400000000"},"request3DSOnPayment":true,"emailCustomerReceipt":true,"settlement":"Default","metadata":{"yourKey":{}}}],"type":"object","required":["type","merchantId","orderType","referenceOrderId","description","amount","currency","billing"],"properties":{"type":{"description":"Always `OrdrNewOrderAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["OrdrNewOrderAttributes"]},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"Identifier of a merchant."},"customerId":{"$ref":"#/components/schemas/CustId","description":"The customer this order is for, where there is one. Used to authorise the create; the order itself records the payer by name and email."},"orderType":{"$ref":"#/components/schemas/OrdrType"},"referenceOrderId":{"description":"Your own reference for this order.","type":"string"},"description":{"description":"What the order is for. Shown to the payer.","type":"string"},"amount":{"$ref":"#/components/schemas/MinorUnits","description":"The order total before any surcharge."},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"billing":{"$ref":"#/components/schemas/OrdrBilling","description":"Who is paying, and where. Required, the platform will not create an order without it."},"emailAddress":{"description":"The payer's email address.","type":"string"},"phoneNumber":{"description":"The payer's phone number, in E.164.","type":"string"},"lineItems":{"description":"The product lines on the order. Invoice lines are written by the platform when a payment link is issued.","type":"array","items":{"$ref":"#/components/schemas/OrdrNewLineItem"}},"taxIncluded":{"description":"Whether tax is included in `amount`. When it is, the tax is worked out at the merchant country's standard rate unless you override it.","type":"boolean"},"taxAmount":{"$ref":"#/components/schemas/MinorUnits","description":"Override the tax within `amount`, in the order's currency."},"discount":{"$ref":"#/components/schemas/MinorUnits","description":"A discount applied to the order total, in the order's currency."},"shipping":{"$ref":"#/components/schemas/OrdrShipping","description":"Where an order is being shipped, and how."},"request3DSOnPayment":{"description":"Require a 3DS challenge when this order is paid.","type":"boolean"},"emailCustomerReceipt":{"description":"Email the payer a receipt when the order is paid.","type":"boolean"},"settlement":{"$ref":"#/components/schemas/OrdrSettlement"},"metadata":{"$ref":"#/components/schemas/Metadata","description":"Free-form data the platform stores and returns untouched. Values may be nested objects and arrays."}}},"OrdrPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/OrdrPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"OrdrPageAttributes":"#/components/schemas/OrdrPageAttributes"}}},"OrdrPageAttributes":{"title":"OrdrPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"OrdrPageAttributes","data":[{"type":"OrdrViewAttributes","orderId":"ordr_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","marketplaceId":"mktp_9f2Kd8QpLzXw","customer":{"type":"OrdrCustomerAttributes","name":"Ada Lovelace","emailAddress":"ada@example.com","phoneNumber":"+61400000000"},"status":"Created","orderType":"Online","amounts":{"type":"OrdrAmountsAttributes","currency":"AUD","total":1250,"tax":1250,"paid":1250,"outstanding":1250,"surcharge":1250,"discount":1250},"lineItems":[{"type":"OrdrLineItemInvoice","description":"A short description.","unitCount":12.5,"fee":1250,"tax":1250,"value":1250,"category":"example","notes":"example"}],"description":"A short description.","shipping":{"type":"OrdrShippingAttributes","name":"Ada Lovelace","address":{"type":"OrdrAddressAttributes","line1":"example","line2":"example","city":"example","state":"example","postalCode":"3000","country":"AU"},"amount":1250,"carrier":"example","trackingNumber":"example","phone":"+61400000000"},"billing":{"type":"OrdrBillingAttributes","name":"Ada Lovelace","address":{"type":"OrdrAddressAttributes","line1":"example","line2":"example","city":"example","state":"example","postalCode":"3000","country":"AU"},"phone":"+61400000000"},"settlement":"Default","request3DSOnPayment":true,"emailCustomerReceipt":true,"referenceOrderId":"your-own-reference","metadata":{"yourKey":{}},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `OrdrPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["OrdrPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/OrdrView"}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"OrdrPaymentLink":{"oneOf":[{"$ref":"#/components/schemas/OrdrPaymentLinkAttributes"}],"discriminator":{"propertyName":"type","mapping":{"OrdrPaymentLinkAttributes":"#/components/schemas/OrdrPaymentLinkAttributes"}}},"OrdrPaymentLinkAttributes":{"title":"OrdrPaymentLinkAttributes","description":"A link that lets its bearer pay an order without any other credential.","examples":[{"type":"OrdrPaymentLinkAttributes","token":"tok_9f2Kd8QpLzXwR4mN","url":"https://example.com/callback"}],"type":"object","required":["type","token"],"properties":{"type":{"description":"Always `OrdrPaymentLinkAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["OrdrPaymentLinkAttributes"]},"token":{"description":"The token itself. Returned when the link is issued, and never on a read, treat it as a secret.","type":"string"},"url":{"description":"The URL to send the payer, where the platform generated one.","type":"string"}}},"OrdrPaymentLinkChannel":{"title":"OrdrPaymentLinkChannel","type":"string","enum":["Sms","Email","SmsAndEmail"]},"OrdrSettlement":{"title":"OrdrSettlement","description":"Whether payments for this order use real-time settlement.","type":"string","enum":["Default","Standard","RealtimePreferred","RealtimeRequired","Unknown"]},"OrdrShipping":{"oneOf":[{"$ref":"#/components/schemas/OrdrShippingAttributes"}],"discriminator":{"propertyName":"type","mapping":{"OrdrShippingAttributes":"#/components/schemas/OrdrShippingAttributes"}}},"OrdrShippingAttributes":{"title":"OrdrShippingAttributes","description":"Where an order is being shipped, and how.","examples":[{"type":"OrdrShippingAttributes","name":"Ada Lovelace","address":{"type":"OrdrAddressAttributes","line1":"example","line2":"example","city":"example","state":"example","postalCode":"3000","country":"AU"},"amount":1250,"carrier":"example","trackingNumber":"example","phone":"+61400000000"}],"type":"object","required":["type","name","address"],"properties":{"type":{"description":"Always `OrdrShippingAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["OrdrShippingAttributes"]},"name":{"description":"Who the goods are going to.","type":"string"},"address":{"$ref":"#/components/schemas/OrdrAddress"},"amount":{"$ref":"#/components/schemas/MinorUnits","description":"The shipping charge, in the order's currency."},"carrier":{"description":"Who is carrying it.","type":"string"},"trackingNumber":{"description":"The carrier's tracking number.","type":"string"},"phone":{"type":"string"}}},"OrdrSort":{"title":"OrdrSort","type":"string","enum":["createdAt","-createdAt"]},"OrdrStatus":{"title":"OrdrStatus","type":"string","enum":["Created","Accepted","Paid","Cancelled","Fulfilled","Returned","Unknown"]},"OrdrType":{"title":"OrdrType","type":"string","enum":["Online","Manual","Invoice","Unknown"]},"OrdrUpdate":{"oneOf":[{"$ref":"#/components/schemas/OrdrUpdateCancel"},{"$ref":"#/components/schemas/OrdrUpdateDetails"},{"$ref":"#/components/schemas/OrdrUpdateReissuePaymentLink"},{"$ref":"#/components/schemas/OrdrUpdateSendPaymentLink"}],"discriminator":{"propertyName":"type","mapping":{"OrdrUpdateCancel":"#/components/schemas/OrdrUpdateCancel","OrdrUpdateDetails":"#/components/schemas/OrdrUpdateDetails","OrdrUpdateReissuePaymentLink":"#/components/schemas/OrdrUpdateReissuePaymentLink","OrdrUpdateSendPaymentLink":"#/components/schemas/OrdrUpdateSendPaymentLink"}}},"OrdrUpdateCancel":{"title":"OrdrUpdateCancel","description":"Cancel an order that has not been paid. The only transition this endpoint makes.","examples":[{"type":"OrdrUpdateCancel"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `OrdrUpdateCancel`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["OrdrUpdateCancel"]}}},"OrdrUpdateDetails":{"title":"OrdrUpdateDetails","description":"Change the order's own details. At least one field, or there is nothing to change.","examples":[{"type":"OrdrUpdateDetails","settlement":"Default","referenceOrderId":"your-own-reference"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `OrdrUpdateDetails`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["OrdrUpdateDetails"]},"settlement":{"$ref":"#/components/schemas/OrdrSettlement"},"referenceOrderId":{"description":"Your own reference for this order.","type":"string"}}},"OrdrUpdateReissuePaymentLink":{"title":"OrdrUpdateReissuePaymentLink","description":"Issue a new payment link. The previous one stops working, and the new token comes back on this response.","examples":[{"type":"OrdrUpdateReissuePaymentLink"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `OrdrUpdateReissuePaymentLink`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["OrdrUpdateReissuePaymentLink"]}}},"OrdrUpdateRsp":{"description":"The updated order, with a freshly issued payment link where one was asked for.","oneOf":[{"$ref":"#/components/schemas/OrdrUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"OrdrUpdateRspAttributes":"#/components/schemas/OrdrUpdateRspAttributes"}}},"OrdrUpdateRspAttributes":{"title":"OrdrUpdateRspAttributes","description":"The updated order, with a freshly issued payment link where one was asked for.","examples":[{"type":"OrdrUpdateRspAttributes","updated":{"type":"OrdrViewAttributes","orderId":"ordr_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","marketplaceId":"mktp_9f2Kd8QpLzXw","customer":{"type":"OrdrCustomerAttributes","name":"Ada Lovelace","emailAddress":"ada@example.com","phoneNumber":"+61400000000"},"status":"Created","orderType":"Online","amounts":{"type":"OrdrAmountsAttributes","currency":"AUD","total":1250,"tax":1250,"paid":1250,"outstanding":1250,"surcharge":1250,"discount":1250},"lineItems":[{"type":"OrdrLineItemInvoice","description":"A short description.","unitCount":12.5,"fee":1250,"tax":1250,"value":1250,"category":"example","notes":"example"}],"description":"A short description.","shipping":{"type":"OrdrShippingAttributes","name":"Ada Lovelace","address":{"type":"OrdrAddressAttributes","line1":"example","line2":"example","city":"example","state":"example","postalCode":"3000","country":"AU"},"amount":1250,"carrier":"example","trackingNumber":"example","phone":"+61400000000"},"billing":{"type":"OrdrBillingAttributes","name":"Ada Lovelace","address":{"type":"OrdrAddressAttributes","line1":"example","line2":"example","city":"example","state":"example","postalCode":"3000","country":"AU"},"phone":"+61400000000"},"settlement":"Default","request3DSOnPayment":true,"emailCustomerReceipt":true,"referenceOrderId":"your-own-reference","metadata":{"yourKey":{}},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"},"paymentLink":{"type":"OrdrPaymentLinkAttributes","token":"tok_9f2Kd8QpLzXwR4mN","url":"https://example.com/callback"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `OrdrUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["OrdrUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/OrdrView"},"paymentLink":{"$ref":"#/components/schemas/OrdrPaymentLink","description":"Present only where this patch issued a new link. The old link stops working."}}},"OrdrUpdateSendPaymentLink":{"title":"OrdrUpdateSendPaymentLink","description":"Send the existing payment link to the payer. The channel is required, sending on no channel is not a request.","examples":[{"type":"OrdrUpdateSendPaymentLink","channel":"Sms"}],"type":"object","required":["type","channel"],"properties":{"type":{"description":"Always `OrdrUpdateSendPaymentLink`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["OrdrUpdateSendPaymentLink"]},"channel":{"$ref":"#/components/schemas/OrdrPaymentLinkChannel"}}},"OrdrView":{"description":"An order, the commerce record a payment settles.","oneOf":[{"$ref":"#/components/schemas/OrdrViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"OrdrViewAttributes":"#/components/schemas/OrdrViewAttributes"}}},"OrdrViewAttributes":{"title":"OrdrViewAttributes","description":"An order, the commerce record a payment settles.","examples":[{"type":"OrdrViewAttributes","orderId":"ordr_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","marketplaceId":"mktp_9f2Kd8QpLzXw","customer":{"type":"OrdrCustomerAttributes","name":"Ada Lovelace","emailAddress":"ada@example.com","phoneNumber":"+61400000000"},"status":"Created","orderType":"Online","amounts":{"type":"OrdrAmountsAttributes","currency":"AUD","total":1250,"tax":1250,"paid":1250,"outstanding":1250,"surcharge":1250,"discount":1250},"lineItems":[{"type":"OrdrLineItemInvoice","description":"A short description.","unitCount":12.5,"fee":1250,"tax":1250,"value":1250,"category":"example","notes":"example"}],"description":"A short description.","shipping":{"type":"OrdrShippingAttributes","name":"Ada Lovelace","address":{"type":"OrdrAddressAttributes","line1":"example","line2":"example","city":"example","state":"example","postalCode":"3000","country":"AU"},"amount":1250,"carrier":"example","trackingNumber":"example","phone":"+61400000000"},"billing":{"type":"OrdrBillingAttributes","name":"Ada Lovelace","address":{"type":"OrdrAddressAttributes","line1":"example","line2":"example","city":"example","state":"example","postalCode":"3000","country":"AU"},"phone":"+61400000000"},"settlement":"Default","request3DSOnPayment":true,"emailCustomerReceipt":true,"referenceOrderId":"your-own-reference","metadata":{"yourKey":{}},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","orderId","merchantId","customer","status","orderType","amounts","request3DSOnPayment","emailCustomerReceipt","referenceOrderId","createdAt","updatedAt"],"properties":{"type":{"description":"Always `OrdrViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["OrdrViewAttributes"]},"orderId":{"$ref":"#/components/schemas/OrdrId","description":"Identifier of an order."},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"Identifier of a merchant."},"marketplaceId":{"$ref":"#/components/schemas/MktpId","description":"The marketplace the merchant trades under, where it does."},"customer":{"$ref":"#/components/schemas/OrdrCustomer"},"status":{"$ref":"#/components/schemas/OrdrStatus"},"orderType":{"$ref":"#/components/schemas/OrdrType","description":"What kind of order this is."},"amounts":{"$ref":"#/components/schemas/OrdrAmounts"},"lineItems":{"description":"The product lines on the order.","type":"array","items":{"$ref":"#/components/schemas/OrdrLineItem"}},"description":{"type":"string"},"shipping":{"$ref":"#/components/schemas/OrdrShipping","description":"Where the goods go. Absent unless your credential may read order PII."},"billing":{"$ref":"#/components/schemas/OrdrBilling","description":"Who is paying, and where. Absent unless your credential may read order PII."},"settlement":{"$ref":"#/components/schemas/OrdrSettlement"},"request3DSOnPayment":{"description":"Whether a 3DS challenge is required when this order is paid.","type":"boolean"},"emailCustomerReceipt":{"description":"Whether the payer is emailed a receipt.","type":"boolean"},"referenceOrderId":{"description":"Your own reference for this order. Required at creation, so always present.","type":"string"},"metadata":{"$ref":"#/components/schemas/Metadata","description":"Free-form data. Absent unless your credential may read order PII."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"OrgColumn":{"title":"OrgColumn","type":"string","enum":["OrganisationId","RegisteredName","BusinessType","CompanyType","TaxIdentityBusinessRegistrationNumber","TaxIdentityCompanyRegistrationNumber","TaxIdentityTaxRegistrationNumber","Country","RegisteredAddressUnitNumber","RegisteredAddressStreetNumber","RegisteredAddressStreetName","RegisteredAddressStreetType","RegisteredAddressSuburb","RegisteredAddressCity","RegisteredAddressState","RegisteredAddressPostalCode","RegisteredAddressCountry","ContactDetailsEmailAddress","ContactDetailsPhoneNumber","ContactDetailsAddressUnitNumber","ContactDetailsAddressStreetNumber","ContactDetailsAddressStreetName","ContactDetailsAddressStreetType","ContactDetailsAddressSuburb","ContactDetailsAddressCity","ContactDetailsAddressState","ContactDetailsAddressPostalCode","ContactDetailsAddressCountry","CreatedAt","UpdatedAt"]},"OrgContactDetails":{"description":"How a business, or one person's ownership of it, is reached. Every field is optional.","oneOf":[{"$ref":"#/components/schemas/OrgContactDetailsAttributes"}],"discriminator":{"propertyName":"type","mapping":{"OrgContactDetailsAttributes":"#/components/schemas/OrgContactDetailsAttributes"}}},"OrgContactDetailsAttributes":{"title":"OrgContactDetailsAttributes","description":"How a business, or one person's ownership of it, is reached. Every field is optional.","examples":[{"type":"OrgContactDetailsAttributes","emailAddress":"ada@example.com","phoneNumber":"+61400000000","address":{"type":"MchtAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"}}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `OrgContactDetailsAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["OrgContactDetailsAttributes"]},"emailAddress":{"type":"string"},"phoneNumber":{"description":"E.164 format, e.g. +61400000000.","type":"string"},"address":{"$ref":"#/components/schemas/MchtAddress","description":"A postal address. Supplying one on a patch replaces the whole address, you cannot patch half of one."}}},"OrgDocument":{"description":"A constitutional document the organisation is evidenced by, by `fileId` from the files collection.","oneOf":[{"$ref":"#/components/schemas/OrgDocumentAttributes"}],"discriminator":{"propertyName":"type","mapping":{"OrgDocumentAttributes":"#/components/schemas/OrgDocumentAttributes"}}},"OrgDocumentAttributes":{"title":"OrgDocumentAttributes","description":"A constitutional document the organisation is evidenced by, by `fileId` from the files collection.","examples":[{"type":"OrgDocumentAttributes","kind":"TrustDeed","fileId":"lfile_9f2Kd8QpLzXw"}],"type":"object","required":["type","kind","fileId"],"properties":{"type":{"description":"Always `OrgDocumentAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["OrgDocumentAttributes"]},"kind":{"$ref":"#/components/schemas/OrgDocumentKind"},"fileId":{"$ref":"#/components/schemas/LfileId"}}},"OrgDocumentKind":{"title":"OrgDocumentKind","type":"string","enum":["TrustDeed","TrustDeedAmendment","PartnershipAgreement","Unknown"]},"OrgId":{"title":"OrgId","examples":["org_9f2Kd8QpLzXw"],"type":"string"},"OrgOwner":{"oneOf":[{"$ref":"#/components/schemas/OrgOwnerOrganisation"},{"$ref":"#/components/schemas/OrgOwnerPerson"}],"discriminator":{"propertyName":"type","mapping":{"OrgOwnerOrganisation":"#/components/schemas/OrgOwnerOrganisation","OrgOwnerPerson":"#/components/schemas/OrgOwnerPerson"}}},"OrgOwnerOrganisation":{"title":"OrgOwnerOrganisation","description":"Another organisation that owns this one, read at its own `GET /organisations/{organisationId}`.","examples":[{"type":"OrgOwnerOrganisation","organisationId":"org_9f2Kd8QpLzXw"}],"type":"object","required":["type","organisationId"],"properties":{"type":{"description":"Always `OrgOwnerOrganisation`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["OrgOwnerOrganisation"]},"organisationId":{"$ref":"#/components/schemas/OrgId","description":"Identifier of an organisation: a business's legal record, shared by every merchant, customer and owner that is that business."}}},"OrgOwnerPerson":{"title":"OrgOwnerPerson","description":"A person who owns the organisation, with the contact given for this ownership. Read only here: a person has no contact of its own, so this one is the ownership's.","examples":[{"type":"OrgOwnerPerson","personId":"pson_9f2Kd8QpLzXw","contactDetails":{"type":"OrgContactDetailsAttributes","emailAddress":"ada@example.com","phoneNumber":"+61400000000","address":{"type":"MchtAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"}}}],"type":"object","required":["type","personId","contactDetails"],"properties":{"type":{"description":"Always `OrgOwnerPerson`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["OrgOwnerPerson"]},"personId":{"$ref":"#/components/schemas/PsonId","description":"Identifier of a person. A beneficial owner is a person, so it is identified by its person's identifier."},"contactDetails":{"$ref":"#/components/schemas/OrgContactDetails"}}},"OrgPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/OrgPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"OrgPageAttributes":"#/components/schemas/OrgPageAttributes"}}},"OrgPageAttributes":{"title":"OrgPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"OrgPageAttributes","data":[{"type":"OrgViewAttributes","organisationId":"org_9f2Kd8QpLzXw","registeredName":"Ada Lovelace","businessType":"Company","companyType":"example","taxIdentity":{"type":"OrgTaxIdentityAttributes","businessRegistrationNumber":"example","companyRegistrationNumber":"example","taxRegistrationNumber":"example"},"country":"AU","registeredAddress":{"type":"MchtAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"},"contactDetails":{"type":"OrgContactDetailsAttributes","emailAddress":"ada@example.com","phoneNumber":"+61400000000","address":{"type":"MchtAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"}},"owners":[{"type":"OrgOwnerOrganisation","organisationId":"org_9f2Kd8QpLzXw"}],"documents":[{"type":"OrgDocumentAttributes","kind":"TrustDeed","fileId":"lfile_9f2Kd8QpLzXw"}],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `OrgPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["OrgPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/OrgView","description":"A business's legal record: what the business register says about it, how it is reached, who owns it and what it is evidenced by. One record is shared by every merchant, customer and owner in an enterprise that is the same business."}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"OrgSort":{"title":"OrgSort","type":"string","enum":["createdAt","-createdAt"]},"OrgTaxIdentity":{"description":"Its registration with the business register and the tax office. Absent where none was stated, or what was stated could not be read.","oneOf":[{"$ref":"#/components/schemas/OrgTaxIdentityAttributes"}],"discriminator":{"propertyName":"type","mapping":{"OrgTaxIdentityAttributes":"#/components/schemas/OrgTaxIdentityAttributes"}}},"OrgTaxIdentityAttributes":{"title":"OrgTaxIdentityAttributes","description":"A business's registration, as the business register and the tax office record it.","examples":[{"type":"OrgTaxIdentityAttributes","businessRegistrationNumber":"example","companyRegistrationNumber":"example","taxRegistrationNumber":"example"}],"type":"object","required":["type","businessRegistrationNumber"],"properties":{"type":{"description":"Always `OrgTaxIdentityAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["OrgTaxIdentityAttributes"]},"businessRegistrationNumber":{"description":"The business registration number: the ABN in Australia, the NZBN in New Zealand, the national registration elsewhere.","type":"string"},"companyRegistrationNumber":{"description":"The company number, where the register gives one besides: the ACN of an Australian company.","type":"string"},"taxRegistrationNumber":{"description":"The tax registration number, where it differs from the business's: the IRD number in New Zealand.","type":"string"}}},"OrgUpdate":{"oneOf":[{"$ref":"#/components/schemas/OrgUpdateContactDetails"}],"discriminator":{"propertyName":"type","mapping":{"OrgUpdateContactDetails":"#/components/schemas/OrgUpdateContactDetails"}}},"OrgUpdateContactDetails":{"title":"OrgUpdateContactDetails","description":"Replace the organisation's contact. It is replaced whole: a field left out is cleared, so send every field you want to keep. A person owner's contact is the ownership's, and is not changed here.","examples":[{"type":"OrgUpdateContactDetails","contactDetails":{"type":"OrgContactDetailsAttributes","emailAddress":"ada@example.com","phoneNumber":"+61400000000","address":{"type":"MchtAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"}}}],"type":"object","required":["type","contactDetails"],"properties":{"type":{"description":"Always `OrgUpdateContactDetails`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["OrgUpdateContactDetails"]},"contactDetails":{"$ref":"#/components/schemas/OrgContactDetails"}}},"OrgUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/OrgUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"OrgUpdateRspAttributes":"#/components/schemas/OrgUpdateRspAttributes"}}},"OrgUpdateRspAttributes":{"title":"OrgUpdateRspAttributes","examples":[{"type":"OrgUpdateRspAttributes","updated":{"type":"OrgViewAttributes","organisationId":"org_9f2Kd8QpLzXw","registeredName":"Ada Lovelace","businessType":"Company","companyType":"example","taxIdentity":{"type":"OrgTaxIdentityAttributes","businessRegistrationNumber":"example","companyRegistrationNumber":"example","taxRegistrationNumber":"example"},"country":"AU","registeredAddress":{"type":"MchtAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"},"contactDetails":{"type":"OrgContactDetailsAttributes","emailAddress":"ada@example.com","phoneNumber":"+61400000000","address":{"type":"MchtAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"}},"owners":[{"type":"OrgOwnerOrganisation","organisationId":"org_9f2Kd8QpLzXw"}],"documents":[{"type":"OrgDocumentAttributes","kind":"TrustDeed","fileId":"lfile_9f2Kd8QpLzXw"}],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `OrgUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["OrgUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/OrgView","description":"The resource as it stands after the change."}}},"OrgView":{"oneOf":[{"$ref":"#/components/schemas/OrgViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"OrgViewAttributes":"#/components/schemas/OrgViewAttributes"}}},"OrgViewAttributes":{"title":"OrgViewAttributes","description":"A business's legal record: what the business register says about it, how it is reached, who owns it and what it is evidenced by. One record is shared by every merchant, customer and owner in an enterprise that is the same business.","examples":[{"type":"OrgViewAttributes","organisationId":"org_9f2Kd8QpLzXw","registeredName":"Ada Lovelace","businessType":"Company","companyType":"example","taxIdentity":{"type":"OrgTaxIdentityAttributes","businessRegistrationNumber":"example","companyRegistrationNumber":"example","taxRegistrationNumber":"example"},"country":"AU","registeredAddress":{"type":"MchtAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"},"contactDetails":{"type":"OrgContactDetailsAttributes","emailAddress":"ada@example.com","phoneNumber":"+61400000000","address":{"type":"MchtAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"}},"owners":[{"type":"OrgOwnerOrganisation","organisationId":"org_9f2Kd8QpLzXw"}],"documents":[{"type":"OrgDocumentAttributes","kind":"TrustDeed","fileId":"lfile_9f2Kd8QpLzXw"}],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","organisationId","country","contactDetails","createdAt","updatedAt"],"properties":{"type":{"description":"Always `OrgViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["OrgViewAttributes"]},"organisationId":{"$ref":"#/components/schemas/OrgId","description":"Identifier of an organisation: a business's legal record, shared by every merchant, customer and owner that is that business."},"registeredName":{"description":"Its name on the business register. Absent where none was ever stated.","type":"string"},"businessType":{"$ref":"#/components/schemas/MchtBusinessType"},"companyType":{"description":"`Private` or `Public`, where the business is a company and it was stated.","type":"string"},"taxIdentity":{"$ref":"#/components/schemas/OrgTaxIdentity"},"country":{"description":"ISO 3166-1 alpha-2. The country it is registered in: its tax identity's, where it has one.","type":"string"},"registeredAddress":{"$ref":"#/components/schemas/MchtAddress","description":"The registered office, as the business register records it. It is not the contact address."},"contactDetails":{"$ref":"#/components/schemas/OrgContactDetails"},"owners":{"description":"Who owns it: persons, each with the contact given for that ownership, and other organisations.","type":"array","items":{"$ref":"#/components/schemas/OrgOwner"}},"documents":{"description":"The documents a trust or a partnership is evidenced by.","type":"array","items":{"$ref":"#/components/schemas/OrgDocument"}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"PayPlanFeeEntry":{"description":"Fees for one pay-plan variant and one customer type.","oneOf":[{"$ref":"#/components/schemas/PayPlanFeeEntryAttributes"}],"discriminator":{"propertyName":"type","mapping":{"PayPlanFeeEntryAttributes":"#/components/schemas/PayPlanFeeEntryAttributes"}}},"PayPlanFeeEntryAttributes":{"title":"PayPlanFeeEntryAttributes","description":"Fees for one pay-plan variant and one customer type.","examples":[{"type":"PayPlanFeeEntryAttributes","payPlanVariant":"FourFortnightlyQuarters","customerType":"Consumer","feeTable":{"type":"FeeTableAttributes","domestic":{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]},"international":{"type":"FeeAttributes","rate":0.9412,"fixed":1250,"cards":[{"type":"CardFeeAttributes","cardFunding":"Credit","cardBrand":"Visa","rate":0.9412,"fixed":1250}]}}}],"type":"object","required":["type","payPlanVariant","customerType","feeTable"],"properties":{"type":{"description":"Always `PayPlanFeeEntryAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PayPlanFeeEntryAttributes"]},"payPlanVariant":{"$ref":"#/components/schemas/SrchqPayPlanVariant"},"customerType":{"$ref":"#/components/schemas/SrchqCustomerType"},"feeTable":{"$ref":"#/components/schemas/FeeTable","description":"Domestic and international fees. Which applies is decided by the card's issuing country, not the payer's address."}}},"PayoutAmounts":{"description":"What the payout moved, and the merchant's balance either side of it. All in the single currency given here.","oneOf":[{"$ref":"#/components/schemas/PayoutAmountsAttributes"}],"discriminator":{"propertyName":"type","mapping":{"PayoutAmountsAttributes":"#/components/schemas/PayoutAmountsAttributes"}}},"PayoutAmountsAttributes":{"title":"PayoutAmountsAttributes","description":"What the payout moved, and the merchant's balance either side of it. All in the single currency given here.","examples":[{"type":"PayoutAmountsAttributes","currency":"AUD","amount":1250,"openingBalance":1250,"closingBalance":1250}],"type":"object","required":["type","currency","amount","openingBalance","closingBalance"],"properties":{"type":{"description":"Always `PayoutAmountsAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PayoutAmountsAttributes"]},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"amount":{"$ref":"#/components/schemas/MinorUnits","description":"What was paid out. May be negative where the payout is a reversal."},"openingBalance":{"$ref":"#/components/schemas/MinorUnits","description":"The merchant's balance before this payout."},"closingBalance":{"$ref":"#/components/schemas/MinorUnits","description":"The merchant's balance after it."}}},"PayoutAttempt":{"oneOf":[{"$ref":"#/components/schemas/PayoutAttemptCleared"},{"$ref":"#/components/schemas/PayoutAttemptFailed"},{"$ref":"#/components/schemas/PayoutAttemptInitiated"},{"$ref":"#/components/schemas/PayoutAttemptReversed"}],"discriminator":{"propertyName":"type","mapping":{"PayoutAttemptCleared":"#/components/schemas/PayoutAttemptCleared","PayoutAttemptFailed":"#/components/schemas/PayoutAttemptFailed","PayoutAttemptInitiated":"#/components/schemas/PayoutAttemptInitiated","PayoutAttemptReversed":"#/components/schemas/PayoutAttemptReversed"}}},"PayoutAttemptCleared":{"title":"PayoutAttemptCleared","description":"The destination bank acknowledged the funds.","examples":[{"type":"PayoutAttemptCleared","disbursementId":"disb_9f2Kd8QpLzXw","at":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","disbursementId","at"],"properties":{"type":{"description":"Always `PayoutAttemptCleared`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PayoutAttemptCleared"]},"disbursementId":{"$ref":"#/components/schemas/PayoutDisbId","description":"Identifier of a disbursement, the payment instruction carrying a payout."},"at":{"type":"string","format":"date-time"}}},"PayoutAttemptFailed":{"title":"PayoutAttemptFailed","description":"The payment failed. The reason says whether the account can be used again.","examples":[{"type":"PayoutAttemptFailed","disbursementId":"disb_9f2Kd8QpLzXw","gateway":"StripeConnectAu","priority":10,"externalAccountId":"xacc_9f2Kd8QpLzXw","reason":{"type":"PayoutFailureAccountClosed","detail":"example","permanent":true},"at":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","disbursementId","priority","reason","at"],"properties":{"type":{"description":"Always `PayoutAttemptFailed`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PayoutAttemptFailed"]},"disbursementId":{"$ref":"#/components/schemas/PayoutDisbId","description":"Identifier of a disbursement, the payment instruction carrying a payout."},"gateway":{"$ref":"#/components/schemas/PayoutGateway","description":"Which provider it failed on."},"priority":{"description":"The priority it was attempted at.","type":"integer","format":"int32"},"externalAccountId":{"$ref":"#/components/schemas/XaccId","description":"The account it was attempted to."},"reason":{"$ref":"#/components/schemas/PayoutFailure"},"at":{"type":"string","format":"date-time"}}},"PayoutAttemptInitiated":{"title":"PayoutAttemptInitiated","description":"A payment instruction was issued.","examples":[{"type":"PayoutAttemptInitiated","disbursementId":"disb_9f2Kd8QpLzXw","at":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","disbursementId","at"],"properties":{"type":{"description":"Always `PayoutAttemptInitiated`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PayoutAttemptInitiated"]},"disbursementId":{"$ref":"#/components/schemas/PayoutDisbId","description":"Identifier of a disbursement, the payment instruction carrying a payout."},"at":{"type":"string","format":"date-time"}}},"PayoutAttemptReversed":{"title":"PayoutAttemptReversed","description":"A cleared payment was pulled back.","examples":[{"type":"PayoutAttemptReversed","at":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","at"],"properties":{"type":{"description":"Always `PayoutAttemptReversed`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PayoutAttemptReversed"]},"at":{"type":"string","format":"date-time"}}},"PayoutChannel":{"title":"PayoutChannel","type":"string","enum":["DirectEntry","Npp","Unknown"]},"PayoutCmd":{"oneOf":[{"$ref":"#/components/schemas/PayoutCmdCreateManual"}],"discriminator":{"propertyName":"type","mapping":{"PayoutCmdCreateManual":"#/components/schemas/PayoutCmdCreateManual"}}},"PayoutCmdCreateManual":{"title":"PayoutCmdCreateManual","description":"Pay out an amount now, rather than waiting for the schedule. The merchant is the credential's own.","examples":[{"type":"PayoutCmdCreateManual","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"statementDescriptor":"ADA COFFEE","paymentChannels":["DirectEntry"],"externalAccountId":"xacc_9f2Kd8QpLzXw","feePayingMerchantId":"mcht_9f2Kd8QpLzXw"}],"type":"object","required":["type","amount","statementDescriptor"],"properties":{"type":{"description":"Always `PayoutCmdCreateManual`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PayoutCmdCreateManual"]},"amount":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"How much to pay out. Must be in a currency the merchant keeps books in."},"statementDescriptor":{"description":"What the recipient sees on their bank statement.","type":"string"},"paymentChannels":{"description":"Which channels are acceptable, in preference order. NPP is near-instant and costs more.","type":"array","items":{"$ref":"#/components/schemas/PayoutChannel"}},"externalAccountId":{"$ref":"#/components/schemas/XaccId","description":"Which account to pay into. Defaults to the merchant's primary; a `400` if neither is set."},"feePayingMerchantId":{"$ref":"#/components/schemas/MchtId","description":"Which merchant bears the payout fees. Defaults to the merchant being paid; naming another requires financials-update on it too."}}},"PayoutColumn":{"title":"PayoutColumn","type":"string","enum":["PayoutId","Reference","MerchantId","MarketplaceId","EnterpriseId","Status","AmountsCurrency","AmountsAmount","AmountsOpeningBalance","AmountsClosingBalance","EntryCount","SettlementSettlementType","SettlementFacilitation","SettlementSettlementDate","SettlementArrivedAt","DisbursementDisbursementId","DisbursementGateway","DisbursementPriority","DisbursementChannel","DisbursementRequired","ExternalAccountId","LedgerClearanceSystemLedgerId","LedgerClearanceFirstSequence","LedgerClearanceLastSequence","StatementDescriptor","Narrative","CompositionCurrency","CreatedAt","UpdatedAt"]},"PayoutComposition":{"description":"What the payout is made of, by entry type. Present on a by-id read; a page of payouts is not rolled up.","oneOf":[{"$ref":"#/components/schemas/PayoutCompositionAttributes"}],"discriminator":{"propertyName":"type","mapping":{"PayoutCompositionAttributes":"#/components/schemas/PayoutCompositionAttributes"}}},"PayoutCompositionAttributes":{"title":"PayoutCompositionAttributes","description":"What the payout is made of, by entry type. All in the single currency given here.","examples":[{"type":"PayoutCompositionAttributes","currency":"AUD","journalEntries":[{"type":"PayoutEntrySummaryAttributes","entryType":"example","count":42,"amount":1250}],"ledgerEntries":[{"type":"PayoutEntrySummaryAttributes","entryType":"example","count":42,"amount":1250}]}],"type":"object","required":["type","currency"],"properties":{"type":{"description":"Always `PayoutCompositionAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PayoutCompositionAttributes"]},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"journalEntries":{"description":"Entries that cleared out of the merchant's journal into this payout.","type":"array","items":{"$ref":"#/components/schemas/PayoutEntrySummary"}},"ledgerEntries":{"description":"Entries added straight to the ledger, reversals and manual transfers, which never pass through a journal.","type":"array","items":{"$ref":"#/components/schemas/PayoutEntrySummary"}}}},"PayoutCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/PayoutCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"PayoutCreateRspAttributes":"#/components/schemas/PayoutCreateRspAttributes"}}},"PayoutCreateRspAttributes":{"title":"PayoutCreateRspAttributes","examples":[{"type":"PayoutCreateRspAttributes","created":{"type":"PayoutViewAttributes","payoutId":"payout_9f2Kd8QpLzXw","reference":"your-own-reference","merchantId":"mcht_9f2Kd8QpLzXw","marketplaceId":"mktp_9f2Kd8QpLzXw","enterpriseId":"ent_9f2Kd8QpLzXw","status":"Created","amounts":{"type":"PayoutAmountsAttributes","currency":"AUD","amount":1250,"openingBalance":1250,"closingBalance":1250},"entryCount":42,"settlement":{"type":"PayoutSettlementAttributes","settlementType":"Net","facilitation":"Abacus","settlementDate":"2026-08-19","arrivedAt":"2026-08-19T04:21:07Z"},"origin":{"type":"PayoutOriginManual","issuedBy":"example"},"disbursement":{"type":"PayoutDisbursementAttributes","disbursementId":"disb_9f2Kd8QpLzXw","gateway":"StripeConnectAu","priority":10,"channel":"DirectEntry","requestedChannels":["DirectEntry"],"required":true,"attempts":[{"type":"PayoutAttemptCleared","disbursementId":"disb_9f2Kd8QpLzXw","at":"2026-08-19T04:21:07Z"}]},"externalAccountId":"xacc_9f2Kd8QpLzXw","ledgerClearance":{"type":"PayoutLedgerClearanceAttributes","systemLedgerId":"abc123","firstSequence":1250,"lastSequence":1250},"statementDescriptor":"ADA COFFEE","narrative":"example","composition":{"type":"PayoutCompositionAttributes","currency":"AUD","journalEntries":[{"type":"PayoutEntrySummaryAttributes","entryType":"example","count":42,"amount":1250}],"ledgerEntries":[{"type":"PayoutEntrySummaryAttributes","entryType":"example","count":42,"amount":1250}]},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `PayoutCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PayoutCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/PayoutView","description":"The resource that was created."}}},"PayoutDisbId":{"title":"PayoutDisbId","examples":["disb_9f2Kd8QpLzXw"],"type":"string"},"PayoutDisbursement":{"description":"How the payment carrying this payout is going, or went.","oneOf":[{"$ref":"#/components/schemas/PayoutDisbursementAttributes"}],"discriminator":{"propertyName":"type","mapping":{"PayoutDisbursementAttributes":"#/components/schemas/PayoutDisbursementAttributes"}}},"PayoutDisbursementAttributes":{"title":"PayoutDisbursementAttributes","description":"How the payment carrying this payout is going, or went.","examples":[{"type":"PayoutDisbursementAttributes","disbursementId":"disb_9f2Kd8QpLzXw","gateway":"StripeConnectAu","priority":10,"channel":"DirectEntry","requestedChannels":["DirectEntry"],"required":true,"attempts":[{"type":"PayoutAttemptCleared","disbursementId":"disb_9f2Kd8QpLzXw","at":"2026-08-19T04:21:07Z"}]}],"type":"object","required":["type","required"],"properties":{"type":{"description":"Always `PayoutDisbursementAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PayoutDisbursementAttributes"]},"disbursementId":{"$ref":"#/components/schemas/PayoutDisbId","description":"The payment instruction the destination bank knows this payout by. Absent until one is issued."},"gateway":{"$ref":"#/components/schemas/PayoutGateway","description":"Which provider is carrying it."},"priority":{"description":"Higher goes first when the platform batches. Set for scheduled payouts only.","type":"integer","format":"int32"},"channel":{"$ref":"#/components/schemas/PayoutChannel","description":"The channel actually used, once chosen."},"requestedChannels":{"description":"The channels the payout was raised asking for, in preference order.","type":"array","items":{"$ref":"#/components/schemas/PayoutChannel"}},"required":{"description":"Whether the platform issues the payment. `false` means the money moves outside the platform, so no instruction is ever issued.","type":"boolean"},"attempts":{"description":"Every attempt, in order. Empty until the first is made.","type":"array","items":{"$ref":"#/components/schemas/PayoutAttempt"}}}},"PayoutDocumentPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/PayoutDocumentPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"PayoutDocumentPageAttributes":"#/components/schemas/PayoutDocumentPageAttributes"}}},"PayoutDocumentPageAttributes":{"title":"PayoutDocumentPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"PayoutDocumentPageAttributes","data":[{"type":"SdocViewAttributes","statementDocumentId":"sdoc_9f2Kd8QpLzXw","format":"Csv","status":"Pending","fileName":"Ada Lovelace","sizeBytes":1250,"expiresAt":"2026-08-19T04:21:07Z","errorMessage":"example","attempts":1250,"email":{"type":"SdocDeliveryAttributes","status":"Pending","attempts":1250,"sentAt":"2026-08-19T04:21:07Z","error":"example"},"readyNotice":{"type":"SdocDeliveryAttributes","status":"Pending","attempts":1250,"sentAt":"2026-08-19T04:21:07Z","error":"example"},"origin":"Generated","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `PayoutDocumentPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PayoutDocumentPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/SdocView"}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"PayoutEntrySummary":{"description":"One entry type's contribution to a payout.","oneOf":[{"$ref":"#/components/schemas/PayoutEntrySummaryAttributes"}],"discriminator":{"propertyName":"type","mapping":{"PayoutEntrySummaryAttributes":"#/components/schemas/PayoutEntrySummaryAttributes"}}},"PayoutEntrySummaryAttributes":{"title":"PayoutEntrySummaryAttributes","description":"One entry type's contribution to a payout.","examples":[{"type":"PayoutEntrySummaryAttributes","entryType":"example","count":42,"amount":1250}],"type":"object","required":["type","entryType","count","amount"],"properties":{"type":{"description":"Always `PayoutEntrySummaryAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PayoutEntrySummaryAttributes"]},"entryType":{"description":"What kind of movement, the platform's own vocabulary, which grows.","type":"string"},"count":{"description":"How many entries of this kind.","type":"integer","format":"int64"},"amount":{"$ref":"#/components/schemas/MinorUnits","description":"Their net contribution, credits less debits, in the composition's currency. Negative for fees and deductions."}}},"PayoutFacilitation":{"title":"PayoutFacilitation","description":"Who facilitates the payment, the platform's own funds flow, or a connected gateway account.","type":"string","enum":["Abacus","StripeConnect","Unknown"]},"PayoutFailure":{"oneOf":[{"$ref":"#/components/schemas/PayoutFailureAccountClosed"},{"$ref":"#/components/schemas/PayoutFailureAccountNotFound"},{"$ref":"#/components/schemas/PayoutFailureInsufficientFunds"},{"$ref":"#/components/schemas/PayoutFailureInvalidBsb"},{"$ref":"#/components/schemas/PayoutFailureOther"}],"discriminator":{"propertyName":"type","mapping":{"PayoutFailureAccountClosed":"#/components/schemas/PayoutFailureAccountClosed","PayoutFailureAccountNotFound":"#/components/schemas/PayoutFailureAccountNotFound","PayoutFailureInsufficientFunds":"#/components/schemas/PayoutFailureInsufficientFunds","PayoutFailureInvalidBsb":"#/components/schemas/PayoutFailureInvalidBsb","PayoutFailureOther":"#/components/schemas/PayoutFailureOther"}}},"PayoutFailureAccountClosed":{"title":"PayoutFailureAccountClosed","description":"The destination account has been closed.","examples":[{"type":"PayoutFailureAccountClosed","detail":"example","permanent":true}],"type":"object","required":["type","detail","permanent"],"properties":{"type":{"description":"Always `PayoutFailureAccountClosed`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PayoutFailureAccountClosed"]},"detail":{"type":"string"},"permanent":{"type":"boolean"}}},"PayoutFailureAccountNotFound":{"title":"PayoutFailureAccountNotFound","description":"The destination account does not exist.","examples":[{"type":"PayoutFailureAccountNotFound","detail":"example","permanent":true}],"type":"object","required":["type","detail","permanent"],"properties":{"type":{"description":"Always `PayoutFailureAccountNotFound`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PayoutFailureAccountNotFound"]},"detail":{"type":"string"},"permanent":{"type":"boolean"}}},"PayoutFailureInsufficientFunds":{"title":"PayoutFailureInsufficientFunds","description":"The source account did not have the funds. Worth retrying.","examples":[{"type":"PayoutFailureInsufficientFunds","detail":"example","permanent":true}],"type":"object","required":["type","detail","permanent"],"properties":{"type":{"description":"Always `PayoutFailureInsufficientFunds`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PayoutFailureInsufficientFunds"]},"detail":{"type":"string"},"permanent":{"type":"boolean"}}},"PayoutFailureInvalidBsb":{"title":"PayoutFailureInvalidBsb","description":"The BSB is not a valid one.","examples":[{"type":"PayoutFailureInvalidBsb","detail":"example","permanent":true}],"type":"object","required":["type","detail","permanent"],"properties":{"type":{"description":"Always `PayoutFailureInvalidBsb`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PayoutFailureInvalidBsb"]},"detail":{"type":"string"},"permanent":{"type":"boolean"}}},"PayoutFailureOther":{"title":"PayoutFailureOther","description":"The provider gave a reason the platform does not recognise. `code` and `title` are its own words.","examples":[{"type":"PayoutFailureOther","code":"example","title":"example","detail":"example","permanent":true}],"type":"object","required":["type","detail","permanent"],"properties":{"type":{"description":"Always `PayoutFailureOther`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PayoutFailureOther"]},"code":{"type":"string"},"title":{"type":"string"},"detail":{"type":"string"},"permanent":{"type":"boolean"}}},"PayoutGateway":{"title":"PayoutGateway","type":"string","enum":["StripeConnectAu","StripeConnectNz","BnzSftp","Zepto","Westpac","Manual","Unknown"]},"PayoutId":{"title":"PayoutId","examples":["payout_9f2Kd8QpLzXw"],"type":"string"},"PayoutLedgerClearance":{"description":"Which stretch of the merchant's ledger this payout cleared. This is what makes a payout reproducible from the books.","oneOf":[{"$ref":"#/components/schemas/PayoutLedgerClearanceAttributes"}],"discriminator":{"propertyName":"type","mapping":{"PayoutLedgerClearanceAttributes":"#/components/schemas/PayoutLedgerClearanceAttributes"}}},"PayoutLedgerClearanceAttributes":{"title":"PayoutLedgerClearanceAttributes","description":"Which stretch of the merchant's ledger this payout cleared.","examples":[{"type":"PayoutLedgerClearanceAttributes","systemLedgerId":"abc123","firstSequence":1250,"lastSequence":1250}],"type":"object","required":["type","systemLedgerId","firstSequence","lastSequence"],"properties":{"type":{"description":"Always `PayoutLedgerClearanceAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PayoutLedgerClearanceAttributes"]},"systemLedgerId":{"description":"The ledger that was cleared to produce this payout.","type":"string"},"firstSequence":{"description":"Sequence of the first ledger entry included.","type":"integer","format":"int64"},"lastSequence":{"description":"Sequence of the last ledger entry included.","type":"integer","format":"int64"}}},"PayoutOrigin":{"description":"Whether the platform raised this payout on a schedule or someone asked for it.","oneOf":[{"$ref":"#/components/schemas/PayoutOriginManual"},{"$ref":"#/components/schemas/PayoutOriginScheduled"}],"discriminator":{"propertyName":"type","mapping":{"PayoutOriginManual":"#/components/schemas/PayoutOriginManual","PayoutOriginScheduled":"#/components/schemas/PayoutOriginScheduled"}}},"PayoutOriginManual":{"title":"PayoutOriginManual","description":"Someone asked for this payout.","examples":[{"type":"PayoutOriginManual","issuedBy":"example"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `PayoutOriginManual`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PayoutOriginManual"]},"issuedBy":{"description":"Who asked, as the platform recorded it.","type":"string"}}},"PayoutOriginScheduled":{"title":"PayoutOriginScheduled","description":"The platform raised this payout on the merchant's schedule.","examples":[{"type":"PayoutOriginScheduled","sequence":1250}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `PayoutOriginScheduled`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PayoutOriginScheduled"]},"sequence":{"description":"The merchant's payout number, counting up. Absent on the very first payouts of a migrated merchant.","type":"integer","format":"int64"}}},"PayoutPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/PayoutPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"PayoutPageAttributes":"#/components/schemas/PayoutPageAttributes"}}},"PayoutPageAttributes":{"title":"PayoutPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"PayoutPageAttributes","data":[{"type":"PayoutViewAttributes","payoutId":"payout_9f2Kd8QpLzXw","reference":"your-own-reference","merchantId":"mcht_9f2Kd8QpLzXw","marketplaceId":"mktp_9f2Kd8QpLzXw","enterpriseId":"ent_9f2Kd8QpLzXw","status":"Created","amounts":{"type":"PayoutAmountsAttributes","currency":"AUD","amount":1250,"openingBalance":1250,"closingBalance":1250},"entryCount":42,"settlement":{"type":"PayoutSettlementAttributes","settlementType":"Net","facilitation":"Abacus","settlementDate":"2026-08-19","arrivedAt":"2026-08-19T04:21:07Z"},"origin":{"type":"PayoutOriginManual","issuedBy":"example"},"disbursement":{"type":"PayoutDisbursementAttributes","disbursementId":"disb_9f2Kd8QpLzXw","gateway":"StripeConnectAu","priority":10,"channel":"DirectEntry","requestedChannels":["DirectEntry"],"required":true,"attempts":[{"type":"PayoutAttemptCleared","disbursementId":"disb_9f2Kd8QpLzXw","at":"2026-08-19T04:21:07Z"}]},"externalAccountId":"xacc_9f2Kd8QpLzXw","ledgerClearance":{"type":"PayoutLedgerClearanceAttributes","systemLedgerId":"abc123","firstSequence":1250,"lastSequence":1250},"statementDescriptor":"ADA COFFEE","narrative":"example","composition":{"type":"PayoutCompositionAttributes","currency":"AUD","journalEntries":[{"type":"PayoutEntrySummaryAttributes","entryType":"example","count":42,"amount":1250}],"ledgerEntries":[{"type":"PayoutEntrySummaryAttributes","entryType":"example","count":42,"amount":1250}]},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `PayoutPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PayoutPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/PayoutView","description":"A payout, money the platform sent to a merchant's bank account."}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"PayoutSettlement":{"description":"When and how the payout settles.","oneOf":[{"$ref":"#/components/schemas/PayoutSettlementAttributes"}],"discriminator":{"propertyName":"type","mapping":{"PayoutSettlementAttributes":"#/components/schemas/PayoutSettlementAttributes"}}},"PayoutSettlementAttributes":{"title":"PayoutSettlementAttributes","description":"When and how the payout settles.","examples":[{"type":"PayoutSettlementAttributes","settlementType":"Net","facilitation":"Abacus","settlementDate":"2026-08-19","arrivedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","settlementType","facilitation"],"properties":{"type":{"description":"Always `PayoutSettlementAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PayoutSettlementAttributes"]},"settlementType":{"$ref":"#/components/schemas/MchtSettlementType","description":"Whether platform fees are netted off each payout or invoiced separately."},"facilitation":{"$ref":"#/components/schemas/PayoutFacilitation"},"settlementDate":{"description":"The date the platform marked this payout ready to disburse. Not the same as a clearance date.","type":"string","format":"date"},"arrivedAt":{"description":"When the destination bank acknowledged the funds. Absent until the payout clears.","type":"string","format":"date-time"}}},"PayoutSort":{"title":"PayoutSort","type":"string","enum":["createdAt","-createdAt","updatedAt","-updatedAt"]},"PayoutStatementFormat":{"title":"PayoutStatementFormat","type":"string","enum":["Csv","Pdf","Xml","Unknown"]},"PayoutStatus":{"title":"PayoutStatus","type":"string","enum":["Created","Pending","InTransit","Paid","Canceled","Failed","Reversed","Suspended","Unknown"]},"PayoutUpdate":{"oneOf":[{"$ref":"#/components/schemas/PayoutUpdateProcess"},{"$ref":"#/components/schemas/PayoutUpdateRecordManualPayment"},{"$ref":"#/components/schemas/PayoutUpdateRegenerateStatement"},{"$ref":"#/components/schemas/PayoutUpdateResendStatement"},{"$ref":"#/components/schemas/PayoutUpdateReverse"},{"$ref":"#/components/schemas/PayoutUpdateUnsuspend"}],"discriminator":{"propertyName":"type","mapping":{"PayoutUpdateProcess":"#/components/schemas/PayoutUpdateProcess","PayoutUpdateRecordManualPayment":"#/components/schemas/PayoutUpdateRecordManualPayment","PayoutUpdateRegenerateStatement":"#/components/schemas/PayoutUpdateRegenerateStatement","PayoutUpdateResendStatement":"#/components/schemas/PayoutUpdateResendStatement","PayoutUpdateReverse":"#/components/schemas/PayoutUpdateReverse","PayoutUpdateUnsuspend":"#/components/schemas/PayoutUpdateUnsuspend"}}},"PayoutUpdateProcess":{"title":"PayoutUpdateProcess","description":"Push this payout through a disbursement run now. Test contexts only, a `400` anywhere else.","examples":[{"type":"PayoutUpdateProcess"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `PayoutUpdateProcess`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PayoutUpdateProcess"]}}},"PayoutUpdateRecordManualPayment":{"title":"PayoutUpdateRecordManualPayment","description":"Record that this payout was settled out of band. The platform stores the date it cleared and nothing else.","examples":[{"type":"PayoutUpdateRecordManualPayment","arrivedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `PayoutUpdateRecordManualPayment`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PayoutUpdateRecordManualPayment"]},"arrivedAt":{"description":"When the funds reached the destination. Omit for now.","type":"string","format":"date-time"}}},"PayoutUpdateRegenerateStatement":{"title":"PayoutUpdateRegenerateStatement","description":"Have this payout's statement documents made again, by the sweep that makes them.","examples":[{"type":"PayoutUpdateRegenerateStatement"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `PayoutUpdateRegenerateStatement`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PayoutUpdateRegenerateStatement"]}}},"PayoutUpdateResendStatement":{"title":"PayoutUpdateResendStatement","description":"Have this payout's statement mailed to the merchant again.","examples":[{"type":"PayoutUpdateResendStatement"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `PayoutUpdateResendStatement`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PayoutUpdateResendStatement"]}}},"PayoutUpdateReverse":{"title":"PayoutUpdateReverse","description":"Pull a cleared payout back. The amount returns to the merchant's balance.","examples":[{"type":"PayoutUpdateReverse"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `PayoutUpdateReverse`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PayoutUpdateReverse"]}}},"PayoutUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/PayoutUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"PayoutUpdateRspAttributes":"#/components/schemas/PayoutUpdateRspAttributes"}}},"PayoutUpdateRspAttributes":{"title":"PayoutUpdateRspAttributes","examples":[{"type":"PayoutUpdateRspAttributes","updated":{"type":"PayoutViewAttributes","payoutId":"payout_9f2Kd8QpLzXw","reference":"your-own-reference","merchantId":"mcht_9f2Kd8QpLzXw","marketplaceId":"mktp_9f2Kd8QpLzXw","enterpriseId":"ent_9f2Kd8QpLzXw","status":"Created","amounts":{"type":"PayoutAmountsAttributes","currency":"AUD","amount":1250,"openingBalance":1250,"closingBalance":1250},"entryCount":42,"settlement":{"type":"PayoutSettlementAttributes","settlementType":"Net","facilitation":"Abacus","settlementDate":"2026-08-19","arrivedAt":"2026-08-19T04:21:07Z"},"origin":{"type":"PayoutOriginManual","issuedBy":"example"},"disbursement":{"type":"PayoutDisbursementAttributes","disbursementId":"disb_9f2Kd8QpLzXw","gateway":"StripeConnectAu","priority":10,"channel":"DirectEntry","requestedChannels":["DirectEntry"],"required":true,"attempts":[{"type":"PayoutAttemptCleared","disbursementId":"disb_9f2Kd8QpLzXw","at":"2026-08-19T04:21:07Z"}]},"externalAccountId":"xacc_9f2Kd8QpLzXw","ledgerClearance":{"type":"PayoutLedgerClearanceAttributes","systemLedgerId":"abc123","firstSequence":1250,"lastSequence":1250},"statementDescriptor":"ADA COFFEE","narrative":"example","composition":{"type":"PayoutCompositionAttributes","currency":"AUD","journalEntries":[{"type":"PayoutEntrySummaryAttributes","entryType":"example","count":42,"amount":1250}],"ledgerEntries":[{"type":"PayoutEntrySummaryAttributes","entryType":"example","count":42,"amount":1250}]},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `PayoutUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PayoutUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/PayoutView","description":"The resource as it stands after the change."}}},"PayoutUpdateUnsuspend":{"title":"PayoutUpdateUnsuspend","description":"Release a payout the platform suspended, so it disburses on the next run.","examples":[{"type":"PayoutUpdateUnsuspend"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `PayoutUpdateUnsuspend`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PayoutUpdateUnsuspend"]}}},"PayoutView":{"oneOf":[{"$ref":"#/components/schemas/PayoutViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"PayoutViewAttributes":"#/components/schemas/PayoutViewAttributes"}}},"PayoutViewAttributes":{"title":"PayoutViewAttributes","description":"A payout, money the platform sent to a merchant's bank account.","examples":[{"type":"PayoutViewAttributes","payoutId":"payout_9f2Kd8QpLzXw","reference":"your-own-reference","merchantId":"mcht_9f2Kd8QpLzXw","marketplaceId":"mktp_9f2Kd8QpLzXw","enterpriseId":"ent_9f2Kd8QpLzXw","status":"Created","amounts":{"type":"PayoutAmountsAttributes","currency":"AUD","amount":1250,"openingBalance":1250,"closingBalance":1250},"entryCount":42,"settlement":{"type":"PayoutSettlementAttributes","settlementType":"Net","facilitation":"Abacus","settlementDate":"2026-08-19","arrivedAt":"2026-08-19T04:21:07Z"},"origin":{"type":"PayoutOriginManual","issuedBy":"example"},"disbursement":{"type":"PayoutDisbursementAttributes","disbursementId":"disb_9f2Kd8QpLzXw","gateway":"StripeConnectAu","priority":10,"channel":"DirectEntry","requestedChannels":["DirectEntry"],"required":true,"attempts":[{"type":"PayoutAttemptCleared","disbursementId":"disb_9f2Kd8QpLzXw","at":"2026-08-19T04:21:07Z"}]},"externalAccountId":"xacc_9f2Kd8QpLzXw","ledgerClearance":{"type":"PayoutLedgerClearanceAttributes","systemLedgerId":"abc123","firstSequence":1250,"lastSequence":1250},"statementDescriptor":"ADA COFFEE","narrative":"example","composition":{"type":"PayoutCompositionAttributes","currency":"AUD","journalEntries":[{"type":"PayoutEntrySummaryAttributes","entryType":"example","count":42,"amount":1250}],"ledgerEntries":[{"type":"PayoutEntrySummaryAttributes","entryType":"example","count":42,"amount":1250}]},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","payoutId","merchantId","enterpriseId","status","amounts","entryCount","settlement","origin","disbursement","createdAt","updatedAt"],"properties":{"type":{"description":"Always `PayoutViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PayoutViewAttributes"]},"payoutId":{"$ref":"#/components/schemas/PayoutId","description":"Identifier of a payout."},"reference":{"description":"The reference the merchant sees, and the one that appears against the deposit. Set once the payout is raised.","type":"string"},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"Identifier of a merchant."},"marketplaceId":{"$ref":"#/components/schemas/MktpId","description":"The marketplace that merchant trades under, where it does."},"enterpriseId":{"$ref":"#/components/schemas/EntId","description":"Identifier of an enterprise."},"status":{"$ref":"#/components/schemas/PayoutStatus","description":"Where the payout is up to. This is the external status: a payout being retried reads as `InTransit`, not `Pending`."},"amounts":{"$ref":"#/components/schemas/PayoutAmounts"},"entryCount":{"description":"How many journal entries were rolled into this payout, excluding the payout entry itself.","type":"integer","format":"int64"},"settlement":{"$ref":"#/components/schemas/PayoutSettlement"},"origin":{"$ref":"#/components/schemas/PayoutOrigin"},"disbursement":{"$ref":"#/components/schemas/PayoutDisbursement"},"externalAccountId":{"$ref":"#/components/schemas/XaccId","description":"The bank account the payout was sent to. Absent where the payout is not disbursed by the platform."},"ledgerClearance":{"$ref":"#/components/schemas/PayoutLedgerClearance"},"statementDescriptor":{"description":"What the merchant asked to appear on the recipient's bank statement.","type":"string"},"narrative":{"description":"Internal notes on what the payout contains. Operational, not merchant-facing.","type":"string"},"composition":{"$ref":"#/components/schemas/PayoutComposition"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"PermissionAction":{"title":"PermissionAction","type":"string","enum":["Create","Read","Update","Delete","ReadPii","ReadAll","CreateBillingPaymentSource","ReadBillingPaymentSource","UpdateBillingPaymentSource","DeleteBillingPaymentSource","CreateFinancials","ReadFinancials","SearchFinancials","UpdateFinancials","DeleteFinancials","CreateKyb","ReadKyb","UpdateKyb","DeleteKyb","CreatePaymentProfiles","ReadPaymentProfiles","UpdatePaymentProfiles","DeletePaymentProfiles","CreatePermissions","ReadPermissions","UpdatePermissions","DeletePermissions","CreateState","ReadState","UpdateState","DeleteState","Activate","ActivatePaymentProfile","Apply","CreateUatp","Impersonate","Link","Orchestrate","Pay","Search","Simulate","SpecifySurcharge","Transfer","Upsert","UpsertMinimal","UpsertPlugin","Verify","Unknown"]},"PermissionResource":{"title":"PermissionResource","type":"string","enum":["BlockedCard","CustomerDelegates","Disputes","Enterprises","FxRates","LoanFacilities","LoanProducts","LoanTransactions","LoanMasterAgreements","Loans","LoanStatements","CreditCards","Files","Queues","Reports","Simulations","Marketplaces","MarketplaceUsers","Merchants","MerchantCustomers","Orders","CustomerPaymentSources","TemporaryPaymentSources","PaymentTokens","PayPlanOffers","PayCards","PayPlans","PayToAgreements","Refunds","MerchantServiceTokens","MarketplaceServiceTokens","EnterpriseServiceTokens","SourceVerifications","SystemJournals","SystemJournalEntries","SystemLedgers","SystemLedgerEntries","Transactions","IssuerTransactions","IssuerTransactionDiscrepancies","WebhookMerchantSubscriptions","WebhookMarketplaceSubscriptions","WebhookSubscriptions","Sessions","ServiceTokens","ReferenceData","Users","Roles","OidcIdps","ReportsAcquiring","ReportsLending","ReportsIssuing","ReportsCustomers","ReportsOperations","ReportsOversight","Organisations","Persons","Suppliers","Rules","MerchantStatementPasswords","MerchantTravelData","Unknown"]},"Person":{"oneOf":[{"$ref":"#/components/schemas/PersonAttributes"}],"discriminator":{"propertyName":"type","mapping":{"PersonAttributes":"#/components/schemas/PersonAttributes"}}},"PersonAttributes":{"title":"PersonAttributes","description":"A natural person, the three facts every identity check on this platform is made of.","examples":[{"type":"PersonAttributes","givenName":"Ada Lovelace","middleName":"Ada Lovelace","familyName":"Ada Lovelace","dateOfBirth":"2026-08-19","address":{"type":"MchtAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"}}],"type":"object","required":["type","familyName","dateOfBirth","address"],"properties":{"type":{"description":"Always `PersonAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PersonAttributes"]},"givenName":{"type":"string"},"middleName":{"type":"string"},"familyName":{"type":"string"},"dateOfBirth":{"type":"string","format":"date"},"address":{"$ref":"#/components/schemas/MchtAddress","description":"A postal address. Supplying one on a patch replaces the whole address, you cannot patch half of one."}}},"PrsnColumn":{"title":"PrsnColumn","type":"string","enum":["PersonId","GivenName","MiddleName","FamilyName","DateOfBirth","CreatedAt","UpdatedAt"]},"PrsnPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/PrsnPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"PrsnPageAttributes":"#/components/schemas/PrsnPageAttributes"}}},"PrsnPageAttributes":{"title":"PrsnPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"PrsnPageAttributes","data":[{"type":"PrsnViewAttributes","personId":"pson_9f2Kd8QpLzXw","givenName":"Ada Lovelace","middleName":"Ada Lovelace","familyName":"Ada Lovelace","dateOfBirth":"2026-08-19","identityDocuments":[{"type":"PsonDocumentDriverLicence","number":"example","issuingCountry":"AU","issuingRegion":"example","documentNumber":"example","versionNumber":"example"}],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `PrsnPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PrsnPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/PrsnView"}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"PrsnSort":{"title":"PrsnSort","type":"string","enum":["createdAt","-createdAt"]},"PrsnView":{"description":"A natural person: who a merchant's beneficial owner, a consumer customer or an owner of a business is, apart from any relationship they are in. A person has no contact of its own: each relationship carries the contact given for it.","oneOf":[{"$ref":"#/components/schemas/PrsnViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"PrsnViewAttributes":"#/components/schemas/PrsnViewAttributes"}}},"PrsnViewAttributes":{"title":"PrsnViewAttributes","description":"A natural person: who a merchant's beneficial owner, a consumer customer or an owner of a business is, apart from any relationship they are in. A person has no contact of its own: each relationship carries the contact given for it.","examples":[{"type":"PrsnViewAttributes","personId":"pson_9f2Kd8QpLzXw","givenName":"Ada Lovelace","middleName":"Ada Lovelace","familyName":"Ada Lovelace","dateOfBirth":"2026-08-19","identityDocuments":[{"type":"PsonDocumentDriverLicence","number":"example","issuingCountry":"AU","issuingRegion":"example","documentNumber":"example","versionNumber":"example"}],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","personId","familyName","createdAt","updatedAt"],"properties":{"type":{"description":"Always `PrsnViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PrsnViewAttributes"]},"personId":{"$ref":"#/components/schemas/PsonId","description":"Identifier of a person. A beneficial owner is a person, so it is identified by its person's identifier."},"givenName":{"type":"string"},"middleName":{"type":"string"},"familyName":{"type":"string"},"dateOfBirth":{"description":"Date of birth, ISO 8601. Absent where none is held, and from a caller without `Persons` view PII.","type":"string","format":"date"},"identityDocuments":{"description":"The passport and the driver licence held for this person, at most one of each. Absent where there are none, and from a caller without `Persons` view PII.","type":"array","minItems":1,"items":{"$ref":"#/components/schemas/PsonDocument"}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"PsonAddress":{"description":"A postal address.","oneOf":[{"$ref":"#/components/schemas/PsonAddressAttributes"}],"discriminator":{"propertyName":"type","mapping":{"PsonAddressAttributes":"#/components/schemas/PsonAddressAttributes"}}},"PsonAddressAttributes":{"title":"PsonAddressAttributes","description":"A postal address.","examples":[{"type":"PsonAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"}],"type":"object","required":["type","streetNumber","streetName","postalCode","country"],"properties":{"type":{"description":"Always `PsonAddressAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PsonAddressAttributes"]},"unitNumber":{"description":"Unit, shop or level, as written on the building. Free text, `12`, `Shop 4`, `Level 3`. Omit where there is none.","type":"string"},"streetNumber":{"description":"Street number, including any range or letter, `34`, `34A`, `34-36`.","type":"string"},"streetName":{"description":"Street name, without the type, `Smith`, not `Smith Street`.","type":"string"},"streetType":{"description":"`Street`, `Road`, `Avenue`. Optional because not every address has one.","type":"string"},"suburb":{"description":"Suburb. This is where Australia and South Africa keep what other countries call the city.","type":"string"},"city":{"description":"City. **Required in New Zealand.** In Australia and South Africa send `suburb` instead, the platform moves whichever you send to where that country keeps it.","type":"string"},"state":{"description":"State, province or territory. **Required in Australia.**","type":"string"},"postalCode":{"type":"string"},"country":{"description":"ISO 3166-1 alpha-2.","type":"string"}}},"PsonCmd":{"oneOf":[{"$ref":"#/components/schemas/PsonCmdCreate"}],"discriminator":{"propertyName":"type","mapping":{"PsonCmdCreate":"#/components/schemas/PsonCmdCreate"}}},"PsonCmdCreate":{"title":"PsonCmdCreate","description":"Add a beneficial owner to a merchant.","examples":[{"type":"PsonCmdCreate","merchantId":"mcht_9f2Kd8QpLzXw","profile":{"type":"PsonProfileAttributes","title":"example","roles":["Director"],"givenName":"Ada Lovelace","middleName":"Ada Lovelace","familyName":"Ada Lovelace","dateOfBirth":"2026-08-19","address":{"type":"PsonAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"},"emailAddress":"ada@example.com","phoneNumber":"+61400000000","identityDocuments":[{"type":"PsonDocumentDriverLicence","number":"example","issuingCountry":"AU","issuingRegion":"example","documentNumber":"example","versionNumber":"example"}],"verificationDocument":{"type":"PsonVerificationDocAttributes","idType":"Passport","frontFileId":"lfile_9f2Kd8QpLzXw","backFileId":"lfile_9f2Kd8QpLzXw"}}}],"type":"object","required":["type","merchantId","profile"],"properties":{"type":{"description":"Always `PsonCmdCreate`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PsonCmdCreate"]},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"Identifier of a merchant."},"profile":{"$ref":"#/components/schemas/PsonProfile"}}},"PsonColumn":{"title":"PsonColumn","type":"string","enum":["BeneficialOwnerId","MerchantId","ProfileTitle","ProfileGivenName","ProfileMiddleName","ProfileFamilyName","ProfileDateOfBirth","ProfileAddressUnitNumber","ProfileAddressStreetNumber","ProfileAddressStreetName","ProfileAddressStreetType","ProfileAddressSuburb","ProfileAddressCity","ProfileAddressState","ProfileAddressPostalCode","ProfileAddressCountry","ProfileEmailAddress","ProfilePhoneNumber","ProfileVerificationDocumentIdType","ProfileVerificationDocumentFrontFileId","ProfileVerificationDocumentBackFileId","VerificationStatus","Deletable"]},"PsonCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/PsonCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"PsonCreateRspAttributes":"#/components/schemas/PsonCreateRspAttributes"}}},"PsonCreateRspAttributes":{"title":"PsonCreateRspAttributes","examples":[{"type":"PsonCreateRspAttributes","created":{"type":"PsonViewAttributes","beneficialOwnerId":"pson_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","profile":{"type":"PsonProfileAttributes","title":"example","roles":["Director"],"givenName":"Ada Lovelace","middleName":"Ada Lovelace","familyName":"Ada Lovelace","dateOfBirth":"2026-08-19","address":{"type":"PsonAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"},"emailAddress":"ada@example.com","phoneNumber":"+61400000000","identityDocuments":[{"type":"PsonDocumentDriverLicence","number":"example","issuingCountry":"AU","issuingRegion":"example","documentNumber":"example","versionNumber":"example"}],"verificationDocument":{"type":"PsonVerificationDocAttributes","idType":"Passport","frontFileId":"lfile_9f2Kd8QpLzXw","backFileId":"lfile_9f2Kd8QpLzXw"}},"verification":{"type":"PsonVerificationAttributes","status":"Pending","errorCodes":["example"],"details":["example"]},"deletable":true}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `PsonCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PsonCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/PsonView","description":"The resource that was created."}}},"PsonDocument":{"oneOf":[{"$ref":"#/components/schemas/PsonDocumentDriverLicence"},{"$ref":"#/components/schemas/PsonDocumentPassport"}],"discriminator":{"propertyName":"type","mapping":{"PsonDocumentDriverLicence":"#/components/schemas/PsonDocumentDriverLicence","PsonDocumentPassport":"#/components/schemas/PsonDocumentPassport"}}},"PsonDocumentDriverLicence":{"title":"PsonDocumentDriverLicence","description":"A driver licence. Which extra number is required follows from the issuing country.","examples":[{"type":"PsonDocumentDriverLicence","number":"example","issuingCountry":"AU","issuingRegion":"example","documentNumber":"example","versionNumber":"example"}],"type":"object","required":["type","number","issuingCountry"],"properties":{"type":{"description":"Always `PsonDocumentDriverLicence`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PsonDocumentDriverLicence"]},"number":{"type":"string"},"issuingCountry":{"description":"ISO 3166-1 alpha-2 country that issued it.","type":"string"},"issuingRegion":{"description":"State or territory that issued it. Required in Australia.","type":"string"},"documentNumber":{"description":"The card's document number. Required for an Australian licence.","type":"string"},"versionNumber":{"description":"The licence's version number. Required for a New Zealand licence.","type":"string"}}},"PsonDocumentPassport":{"title":"PsonDocumentPassport","description":"A passport. The expiry is checked, an expired one fails verification.","examples":[{"type":"PsonDocumentPassport","number":"example","issuingCountry":"AU","expiresOn":"2026-08-19"}],"type":"object","required":["type","number","issuingCountry","expiresOn"],"properties":{"type":{"description":"Always `PsonDocumentPassport`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PsonDocumentPassport"]},"number":{"type":"string"},"issuingCountry":{"description":"ISO 3166-1 alpha-2 country that issued it.","type":"string"},"expiresOn":{"description":"When it expires. The platform refuses an expired passport.","type":"string","format":"date"}}},"PsonDocumentType":{"title":"PsonDocumentType","description":"Which document was scanned. A driver licence needs both sides; a passport needs only the front.","type":"string","enum":["Passport","DriverLicence","Unknown"]},"PsonId":{"title":"PsonId","examples":["pson_9f2Kd8QpLzXw"],"type":"string"},"PsonPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/PsonPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"PsonPageAttributes":"#/components/schemas/PsonPageAttributes"}}},"PsonPageAttributes":{"title":"PsonPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"PsonPageAttributes","data":[{"type":"PsonViewAttributes","beneficialOwnerId":"pson_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","profile":{"type":"PsonProfileAttributes","title":"example","roles":["Director"],"givenName":"Ada Lovelace","middleName":"Ada Lovelace","familyName":"Ada Lovelace","dateOfBirth":"2026-08-19","address":{"type":"PsonAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"},"emailAddress":"ada@example.com","phoneNumber":"+61400000000","identityDocuments":[{"type":"PsonDocumentDriverLicence","number":"example","issuingCountry":"AU","issuingRegion":"example","documentNumber":"example","versionNumber":"example"}],"verificationDocument":{"type":"PsonVerificationDocAttributes","idType":"Passport","frontFileId":"lfile_9f2Kd8QpLzXw","backFileId":"lfile_9f2Kd8QpLzXw"}},"verification":{"type":"PsonVerificationAttributes","status":"Pending","errorCodes":["example"],"details":["example"]},"deletable":true}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `PsonPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PsonPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/PsonView","description":"A person who owns or controls a merchant, and the outcome of verifying them."}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"PsonProfile":{"description":"What is known about a beneficial owner.","oneOf":[{"$ref":"#/components/schemas/PsonProfileAttributes"}],"discriminator":{"propertyName":"type","mapping":{"PsonProfileAttributes":"#/components/schemas/PsonProfileAttributes"}}},"PsonProfileAttributes":{"title":"PsonProfileAttributes","description":"What is known about a beneficial owner.","examples":[{"type":"PsonProfileAttributes","title":"example","roles":["Director"],"givenName":"Ada Lovelace","middleName":"Ada Lovelace","familyName":"Ada Lovelace","dateOfBirth":"2026-08-19","address":{"type":"PsonAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"},"emailAddress":"ada@example.com","phoneNumber":"+61400000000","identityDocuments":[{"type":"PsonDocumentDriverLicence","number":"example","issuingCountry":"AU","issuingRegion":"example","documentNumber":"example","versionNumber":"example"}],"verificationDocument":{"type":"PsonVerificationDocAttributes","idType":"Passport","frontFileId":"lfile_9f2Kd8QpLzXw","backFileId":"lfile_9f2Kd8QpLzXw"}}],"type":"object","required":["type","title","givenName","familyName","dateOfBirth","address","emailAddress","phoneNumber"],"properties":{"type":{"description":"Always `PsonProfileAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PsonProfileAttributes"]},"title":{"description":"Their title in relation to the business, `Director`, `Secretary`.","type":"string"},"roles":{"description":"What they are to the business. At least one.","type":"array","items":{"$ref":"#/components/schemas/PsonRole"}},"givenName":{"type":"string"},"middleName":{"type":"string"},"familyName":{"type":"string"},"dateOfBirth":{"description":"Date of birth, ISO 8601.","type":"string","format":"date"},"address":{"$ref":"#/components/schemas/PsonAddress"},"emailAddress":{"type":"string"},"phoneNumber":{"description":"Phone number in E.164 format, such as `+61400000000`.","type":"string"},"identityDocuments":{"description":"Documents offered as evidence of identity. The platform holds at most one of each kind, so this is one, or a passport and a licence. Omit where there are none.","type":"array","minItems":1,"items":{"$ref":"#/components/schemas/PsonDocument"}},"verificationDocument":{"$ref":"#/components/schemas/PsonVerificationDoc"}}},"PsonReplace":{"description":"Replace everything known about a beneficial owner.","oneOf":[{"$ref":"#/components/schemas/PsonReplaceProfile"}],"discriminator":{"propertyName":"type","mapping":{"PsonReplaceProfile":"#/components/schemas/PsonReplaceProfile"}}},"PsonReplaceProfile":{"title":"PsonReplaceProfile","description":"Replace everything known about a beneficial owner.","examples":[{"type":"PsonReplaceProfile","merchantId":"mcht_9f2Kd8QpLzXw","profile":{"type":"PsonProfileAttributes","title":"example","roles":["Director"],"givenName":"Ada Lovelace","middleName":"Ada Lovelace","familyName":"Ada Lovelace","dateOfBirth":"2026-08-19","address":{"type":"PsonAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"},"emailAddress":"ada@example.com","phoneNumber":"+61400000000","identityDocuments":[{"type":"PsonDocumentDriverLicence","number":"example","issuingCountry":"AU","issuingRegion":"example","documentNumber":"example","versionNumber":"example"}],"verificationDocument":{"type":"PsonVerificationDocAttributes","idType":"Passport","frontFileId":"lfile_9f2Kd8QpLzXw","backFileId":"lfile_9f2Kd8QpLzXw"}}}],"type":"object","required":["type","merchantId","profile"],"properties":{"type":{"description":"Always `PsonReplaceProfile`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PsonReplaceProfile"]},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"Whose owner this is. Required, the platform cannot resolve an owner without its merchant."},"profile":{"$ref":"#/components/schemas/PsonProfile"}}},"PsonRole":{"title":"PsonRole","type":"string","enum":["Director","Owner","Executive","Unknown"]},"PsonVerification":{"description":"The outcome of verifying a beneficial owner.","oneOf":[{"$ref":"#/components/schemas/PsonVerificationAttributes"}],"discriminator":{"propertyName":"type","mapping":{"PsonVerificationAttributes":"#/components/schemas/PsonVerificationAttributes"}}},"PsonVerificationAttributes":{"title":"PsonVerificationAttributes","description":"The outcome of verifying a beneficial owner.","examples":[{"type":"PsonVerificationAttributes","status":"Pending","errorCodes":["example"],"details":["example"]}],"type":"object","required":["type","status"],"properties":{"type":{"description":"Always `PsonVerificationAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PsonVerificationAttributes"]},"status":{"$ref":"#/components/schemas/PsonVerificationStatus"},"errorCodes":{"description":"Why verification has not completed, as codes, `InvalidPersonAge`, `InvalidContactEmail`. Branch on these.","type":"array","items":{"type":"string"}},"details":{"description":"The same thing in words, for showing a person. Not always populated even when `errorCodes` is.","type":"array","items":{"type":"string"}}}},"PsonVerificationDoc":{"description":"The scan of an identity document, by `fileId` from the files collection. Absent until one is uploaded.","oneOf":[{"$ref":"#/components/schemas/PsonVerificationDocAttributes"}],"discriminator":{"propertyName":"type","mapping":{"PsonVerificationDocAttributes":"#/components/schemas/PsonVerificationDocAttributes"}}},"PsonVerificationDocAttributes":{"title":"PsonVerificationDocAttributes","description":"A scanned identity document.","examples":[{"type":"PsonVerificationDocAttributes","idType":"Passport","frontFileId":"lfile_9f2Kd8QpLzXw","backFileId":"lfile_9f2Kd8QpLzXw"}],"type":"object","required":["type","idType","frontFileId"],"properties":{"type":{"description":"Always `PsonVerificationDocAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PsonVerificationDocAttributes"]},"idType":{"$ref":"#/components/schemas/PsonDocumentType"},"frontFileId":{"description":"The front of the document, by `fileId`.","type":"string"},"backFileId":{"description":"The back of the document, by `fileId`. Required for a driver licence.","type":"string"}}},"PsonVerificationStatus":{"title":"PsonVerificationStatus","type":"string","enum":["Pending","Verified","Unknown"]},"PsonView":{"oneOf":[{"$ref":"#/components/schemas/PsonViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"PsonViewAttributes":"#/components/schemas/PsonViewAttributes"}}},"PsonViewAttributes":{"title":"PsonViewAttributes","description":"A person who owns or controls a merchant, and the outcome of verifying them.","examples":[{"type":"PsonViewAttributes","beneficialOwnerId":"pson_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","profile":{"type":"PsonProfileAttributes","title":"example","roles":["Director"],"givenName":"Ada Lovelace","middleName":"Ada Lovelace","familyName":"Ada Lovelace","dateOfBirth":"2026-08-19","address":{"type":"PsonAddressAttributes","unitNumber":"example","streetNumber":"example","streetName":"Ada Lovelace","streetType":"example","suburb":"example","city":"example","state":"example","postalCode":"3000","country":"AU"},"emailAddress":"ada@example.com","phoneNumber":"+61400000000","identityDocuments":[{"type":"PsonDocumentDriverLicence","number":"example","issuingCountry":"AU","issuingRegion":"example","documentNumber":"example","versionNumber":"example"}],"verificationDocument":{"type":"PsonVerificationDocAttributes","idType":"Passport","frontFileId":"lfile_9f2Kd8QpLzXw","backFileId":"lfile_9f2Kd8QpLzXw"}},"verification":{"type":"PsonVerificationAttributes","status":"Pending","errorCodes":["example"],"details":["example"]},"deletable":true}],"type":"object","required":["type","beneficialOwnerId","merchantId","profile","verification","deletable"],"properties":{"type":{"description":"Always `PsonViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PsonViewAttributes"]},"beneficialOwnerId":{"$ref":"#/components/schemas/PsonId","description":"Identifier of a person. A beneficial owner is a person, so it is identified by its person's identifier."},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"Whose owner this is. Not on `PersonInfo`, the read already knows, because it was asked for one merchant."},"profile":{"$ref":"#/components/schemas/PsonProfile"},"verification":{"$ref":"#/components/schemas/PsonVerification"},"deletable":{"description":"Whether this owner can be removed. The platform decides; the last owner of a verified merchant cannot.","type":"boolean"}}},"PsrcBankAccount":{"oneOf":[{"$ref":"#/components/schemas/PsrcBankAccountAu"},{"$ref":"#/components/schemas/PsrcBankAccountHk"},{"$ref":"#/components/schemas/PsrcBankAccountHkUsd"},{"$ref":"#/components/schemas/PsrcBankAccountNz"},{"$ref":"#/components/schemas/PsrcBankAccountSg"}],"discriminator":{"propertyName":"type","mapping":{"PsrcBankAccountAu":"#/components/schemas/PsrcBankAccountAu","PsrcBankAccountHk":"#/components/schemas/PsrcBankAccountHk","PsrcBankAccountHkUsd":"#/components/schemas/PsrcBankAccountHkUsd","PsrcBankAccountNz":"#/components/schemas/PsrcBankAccountNz","PsrcBankAccountSg":"#/components/schemas/PsrcBankAccountSg"}}},"PsrcBankAccountAu":{"title":"PsrcBankAccountAu","description":"An Australian account in Australian dollars (AUD): BSB plus account number.","examples":[{"type":"PsrcBankAccountAu","bsb":"example","accountNumber":"example"}],"type":"object","required":["type","bsb","accountNumber"],"properties":{"type":{"description":"Always `PsrcBankAccountAu`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PsrcBankAccountAu"]},"bsb":{"description":"Bank-state-branch, six digits.","type":"string","pattern":"^[0-9]{6}$"},"accountNumber":{"type":"string"}}},"PsrcBankAccountHk":{"title":"PsrcBankAccountHk","description":"A Hong Kong account in Hong Kong dollars (HKD).","examples":[{"type":"PsrcBankAccountHk","accountNumber":"example"}],"type":"object","required":["type","accountNumber"],"properties":{"type":{"description":"Always `PsrcBankAccountHk`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PsrcBankAccountHk"]},"accountNumber":{"type":"string"}}},"PsrcBankAccountHkUsd":{"title":"PsrcBankAccountHkUsd","description":"A Hong Kong account in US dollars (USD). The platform holds these separately because they clear differently.","examples":[{"type":"PsrcBankAccountHkUsd","accountNumber":"example"}],"type":"object","required":["type","accountNumber"],"properties":{"type":{"description":"Always `PsrcBankAccountHkUsd`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PsrcBankAccountHkUsd"]},"accountNumber":{"type":"string"}}},"PsrcBankAccountKind":{"title":"PsrcBankAccountKind","type":"string","enum":["Au","Nz","Sg","Hk","HkUsd","Unknown"]},"PsrcBankAccountNz":{"title":"PsrcBankAccountNz","description":"A New Zealand account in New Zealand dollars (NZD): the full sixteen-digit number.","examples":[{"type":"PsrcBankAccountNz","accountNumber":"example"}],"type":"object","required":["type","accountNumber"],"properties":{"type":{"description":"Always `PsrcBankAccountNz`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PsrcBankAccountNz"]},"accountNumber":{"type":"string"}}},"PsrcBankAccountSg":{"title":"PsrcBankAccountSg","description":"A Singapore account in Singapore dollars (SGD).","examples":[{"type":"PsrcBankAccountSg","accountNumber":"example"}],"type":"object","required":["type","accountNumber"],"properties":{"type":{"description":"Always `PsrcBankAccountSg`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PsrcBankAccountSg"]},"accountNumber":{"type":"string"}}},"PsrcCardEntry":{"oneOf":[{"$ref":"#/components/schemas/PsrcCardEntryAttributes"}],"discriminator":{"propertyName":"type","mapping":{"PsrcCardEntryAttributes":"#/components/schemas/PsrcCardEntryAttributes"}}},"PsrcCardEntryAttributes":{"title":"PsrcCardEntryAttributes","examples":[{"type":"PsrcCardEntryAttributes","cardNumber":"example","cvc":"example","expiryMonth":6,"expiryYear":2029,"cardHolderName":"Ada Lovelace"}],"type":"object","required":["type","cardNumber","expiryMonth","expiryYear"],"properties":{"type":{"description":"Always `PsrcCardEntryAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PsrcCardEntryAttributes"]},"cardNumber":{"description":"The card number. Tokenised by the vault before it reaches the API.","type":"string"},"cvc":{"description":"The card verification code. Tokenised by the vault before it reaches the API.","type":"string"},"expiryMonth":{"description":"Expiry month, 1-12.","type":"integer","format":"int32"},"expiryYear":{"description":"Expiry year, four digits.","type":"integer","format":"int32"},"cardHolderName":{"type":"string"}}},"PsrcCmd":{"oneOf":[{"$ref":"#/components/schemas/PsrcCmdCreateBillingCard"},{"$ref":"#/components/schemas/PsrcCmdCreateBillingDirectDebit"},{"$ref":"#/components/schemas/PsrcCmdCreateCard"},{"$ref":"#/components/schemas/PsrcCmdCreateDirectDebit"},{"$ref":"#/components/schemas/PsrcCmdCreatePayTo"},{"$ref":"#/components/schemas/PsrcCmdCreateTemporaryCard"}],"discriminator":{"propertyName":"type","mapping":{"PsrcCmdCreateBillingCard":"#/components/schemas/PsrcCmdCreateBillingCard","PsrcCmdCreateBillingDirectDebit":"#/components/schemas/PsrcCmdCreateBillingDirectDebit","PsrcCmdCreateCard":"#/components/schemas/PsrcCmdCreateCard","PsrcCmdCreateDirectDebit":"#/components/schemas/PsrcCmdCreateDirectDebit","PsrcCmdCreatePayTo":"#/components/schemas/PsrcCmdCreatePayTo","PsrcCmdCreateTemporaryCard":"#/components/schemas/PsrcCmdCreateTemporaryCard"}}},"PsrcCmdCreateBillingCard":{"title":"PsrcCmdCreateBillingCard","description":"Store a card to pay this merchant's own platform fees. Owned by the merchant, not by a customer.","examples":[{"type":"PsrcCmdCreateBillingCard","card":{"type":"PsrcCardEntryAttributes","cardNumber":"example","cvc":"example","expiryMonth":6,"expiryYear":2029,"cardHolderName":"Ada Lovelace"}}],"type":"object","required":["type","card"],"properties":{"type":{"description":"Always `PsrcCmdCreateBillingCard`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PsrcCmdCreateBillingCard"]},"card":{"$ref":"#/components/schemas/PsrcCardEntry"}}},"PsrcCmdCreateBillingDirectDebit":{"title":"PsrcCmdCreateBillingDirectDebit","description":"Store a bank account to pay this merchant's own platform fees by direct debit. The account's country decides its currency.","examples":[{"type":"PsrcCmdCreateBillingDirectDebit","accountName":"Ada Lovelace","account":{"type":"PsrcBankAccountAu","bsb":"example","accountNumber":"example"},"agreementAccepted":true}],"type":"object","required":["type","accountName","account","agreementAccepted"],"properties":{"type":{"description":"Always `PsrcCmdCreateBillingDirectDebit`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PsrcCmdCreateBillingDirectDebit"]},"accountName":{"type":"string"},"account":{"$ref":"#/components/schemas/PsrcBankAccount"},"agreementAccepted":{"description":"The merchant has accepted the direct-debit agreement. Required, the platform refuses the create without it.","type":"boolean"}}},"PsrcCmdCreateCard":{"title":"PsrcCmdCreateCard","description":"Store a card against a customer.","examples":[{"type":"PsrcCmdCreateCard","customerId":"cust_9f2Kd8QpLzXw","card":{"type":"PsrcCardEntryAttributes","cardNumber":"example","cvc":"example","expiryMonth":6,"expiryYear":2029,"cardHolderName":"Ada Lovelace"},"scope":"Organisation"}],"type":"object","required":["type","customerId","card"],"properties":{"type":{"description":"Always `PsrcCmdCreateCard`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PsrcCmdCreateCard"]},"customerId":{"$ref":"#/components/schemas/CustId","description":"Identifier of a customer."},"card":{"$ref":"#/components/schemas/PsrcCardEntry"},"scope":{"$ref":"#/components/schemas/PsrcScope","description":"Who owns the card, where the customer is an organisation. Omit for a consumer's own card."}}},"PsrcCmdCreateDirectDebit":{"title":"PsrcCmdCreateDirectDebit","description":"Store a bank account for direct debit. The account's country decides its currency.","examples":[{"type":"PsrcCmdCreateDirectDebit","customerId":"cust_9f2Kd8QpLzXw","accountName":"Ada Lovelace","account":{"type":"PsrcBankAccountAu","bsb":"example","accountNumber":"example"},"agreementAccepted":true,"scope":"Organisation"}],"type":"object","required":["type","customerId","accountName","account","agreementAccepted"],"properties":{"type":{"description":"Always `PsrcCmdCreateDirectDebit`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PsrcCmdCreateDirectDebit"]},"customerId":{"$ref":"#/components/schemas/CustId","description":"Identifier of a customer."},"accountName":{"type":"string"},"account":{"$ref":"#/components/schemas/PsrcBankAccount"},"agreementAccepted":{"description":"The payer has accepted the direct-debit agreement. Required, the platform refuses the create without it.","type":"boolean"},"scope":{"$ref":"#/components/schemas/PsrcScope","description":"Who owns the source, where the customer is an organisation."}}},"PsrcCmdCreatePayTo":{"title":"PsrcCmdCreatePayTo","description":"Store a PayTo agreement as a payment source.","examples":[{"type":"PsrcCmdCreatePayTo","customerId":"cust_9f2Kd8QpLzXw","agreementToken":"tok_9f2Kd8QpLzXwR4mN","billingPayerMerchantId":"mcht_9f2Kd8QpLzXw","scope":"Organisation"}],"type":"object","required":["type","customerId","agreementToken"],"properties":{"type":{"description":"Always `PsrcCmdCreatePayTo`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PsrcCmdCreatePayTo"]},"customerId":{"$ref":"#/components/schemas/CustId","description":"Identifier of a customer."},"agreementToken":{"description":"The agreement token the platform issued when the payer authorised the agreement.","type":"string"},"billingPayerMerchantId":{"$ref":"#/components/schemas/MchtId","description":"The merchant whose secret the token was encrypted with, when this source is being stored to pay that merchant's platform fees. Omit otherwise."},"scope":{"$ref":"#/components/schemas/PsrcScope","description":"Who owns the source, where the customer is an organisation."}}},"PsrcCmdCreateTemporaryCard":{"title":"PsrcCmdCreateTemporaryCard","description":"Store a card for a single payment. Owned by the merchant, and expires rather than being saved.","examples":[{"type":"PsrcCmdCreateTemporaryCard","card":{"type":"PsrcCardEntryAttributes","cardNumber":"example","cvc":"example","expiryMonth":6,"expiryYear":2029,"cardHolderName":"Ada Lovelace"}}],"type":"object","required":["type","card"],"properties":{"type":{"description":"Always `PsrcCmdCreateTemporaryCard`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PsrcCmdCreateTemporaryCard"]},"card":{"$ref":"#/components/schemas/PsrcCardEntry"}}},"PsrcColumn":{"title":"PsrcColumn","type":"string"},"PsrcCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/PsrcCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"PsrcCreateRspAttributes":"#/components/schemas/PsrcCreateRspAttributes"}}},"PsrcCreateRspAttributes":{"title":"PsrcCreateRspAttributes","examples":[{"type":"PsrcCreateRspAttributes","created":{"type":"PsrcViewCard","sourceId":"psrc_9f2Kd8QpLzXw","customerId":"cust_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","status":"Active","last4":"4242","bin":"424242","brand":"Visa","funding":"Credit","expiryMonth":6,"expiryYear":2029,"issuerCountry":"AU","currency":"AUD","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `PsrcCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PsrcCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/PsrcView","description":"The resource that was created."}}},"PsrcId":{"title":"PsrcId","examples":["psrc_9f2Kd8QpLzXw"],"type":"string"},"PsrcPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/PsrcPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"PsrcPageAttributes":"#/components/schemas/PsrcPageAttributes"}}},"PsrcPageAttributes":{"title":"PsrcPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"PsrcPageAttributes","data":[{"type":"PsrcViewCard","sourceId":"psrc_9f2Kd8QpLzXw","customerId":"cust_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","status":"Active","last4":"4242","bin":"424242","brand":"Visa","funding":"Credit","expiryMonth":6,"expiryYear":2029,"issuerCountry":"AU","currency":"AUD","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `PsrcPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PsrcPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/PsrcView"}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"PsrcScope":{"title":"PsrcScope","type":"string","enum":["Organisation","Delegate","Billing"]},"PsrcSort":{"title":"PsrcSort","type":"string","enum":["createdAt","-createdAt","updatedAt","-updatedAt"]},"PsrcStatus":{"title":"PsrcStatus","type":"string","enum":["Active","Removed","Unknown"]},"PsrcUpdate":{"oneOf":[{"$ref":"#/components/schemas/PsrcUpdateCvc"},{"$ref":"#/components/schemas/PsrcUpdateRemoveBlock"}],"discriminator":{"propertyName":"type","mapping":{"PsrcUpdateCvc":"#/components/schemas/PsrcUpdateCvc","PsrcUpdateRemoveBlock":"#/components/schemas/PsrcUpdateRemoveBlock"}}},"PsrcUpdateCvc":{"title":"PsrcUpdateCvc","description":"Attach a fresh card verification code, where the issuer has begun asking for one again.","examples":[{"type":"PsrcUpdateCvc","cvc":"example"}],"type":"object","required":["type","cvc"],"properties":{"type":{"description":"Always `PsrcUpdateCvc`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PsrcUpdateCvc"]},"cvc":{"description":"Write-only, tokenised by the vault, and never stored in the clear.","type":"string"}}},"PsrcUpdateRemoveBlock":{"title":"PsrcUpdateRemoveBlock","description":"Lift a block the platform placed on this card. Platform-level: a merchant cannot unblock its own payer's card.","examples":[{"type":"PsrcUpdateRemoveBlock"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `PsrcUpdateRemoveBlock`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PsrcUpdateRemoveBlock"]}}},"PsrcUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/PsrcUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"PsrcUpdateRspAttributes":"#/components/schemas/PsrcUpdateRspAttributes"}}},"PsrcUpdateRspAttributes":{"title":"PsrcUpdateRspAttributes","examples":[{"type":"PsrcUpdateRspAttributes","updated":{"type":"PsrcViewCard","sourceId":"psrc_9f2Kd8QpLzXw","customerId":"cust_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","status":"Active","last4":"4242","bin":"424242","brand":"Visa","funding":"Credit","expiryMonth":6,"expiryYear":2029,"issuerCountry":"AU","currency":"AUD","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `PsrcUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PsrcUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/PsrcView","description":"The resource as it stands after the change."}}},"PsrcView":{"oneOf":[{"$ref":"#/components/schemas/PsrcViewCard"},{"$ref":"#/components/schemas/PsrcViewDirectDebit"},{"$ref":"#/components/schemas/PsrcViewPayTo"}],"discriminator":{"propertyName":"type","mapping":{"PsrcViewCard":"#/components/schemas/PsrcViewCard","PsrcViewDirectDebit":"#/components/schemas/PsrcViewDirectDebit","PsrcViewPayTo":"#/components/schemas/PsrcViewPayTo"}}},"PsrcViewCard":{"title":"PsrcViewCard","description":"A stored card.","examples":[{"type":"PsrcViewCard","sourceId":"psrc_9f2Kd8QpLzXw","customerId":"cust_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","status":"Active","last4":"4242","bin":"424242","brand":"Visa","funding":"Credit","expiryMonth":6,"expiryYear":2029,"issuerCountry":"AU","currency":"AUD","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","sourceId","status","last4","bin","brand","funding","expiryMonth","expiryYear","issuerCountry","currency","createdAt","updatedAt"],"properties":{"type":{"description":"Always `PsrcViewCard`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PsrcViewCard"]},"sourceId":{"$ref":"#/components/schemas/PsrcId","description":"Identifier of a payment source."},"customerId":{"$ref":"#/components/schemas/CustId","description":"The customer the card is stored against. Absent on a temporary card, which the merchant owns."},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"The merchant that owns the card. Present on a temporary card."},"status":{"$ref":"#/components/schemas/PsrcStatus"},"last4":{"description":"Last four digits of the card number.","type":"string"},"bin":{"description":"Issuer identification number, the leading digits of the card number.","type":"string"},"brand":{"$ref":"#/components/schemas/CardBrand"},"funding":{"$ref":"#/components/schemas/CardFunding"},"expiryMonth":{"type":"integer","format":"int32"},"expiryYear":{"type":"integer","format":"int32"},"issuerCountry":{"$ref":"#/components/schemas/IsoCountry","description":"Where the card was issued."},"currency":{"$ref":"#/components/schemas/IsoCurrency","description":"The currency the card is denominated in."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"PsrcViewDirectDebit":{"title":"PsrcViewDirectDebit","description":"A stored bank account used for direct debit.","examples":[{"type":"PsrcViewDirectDebit","sourceId":"psrc_9f2Kd8QpLzXw","customerId":"cust_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","status":"Active","last4":"4242","accountName":"Ada Lovelace","accountKind":"Au","routingNumber":"example","currency":"AUD","agreementAcceptedAt":"2026-08-19T04:21:07Z","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","sourceId","status","last4","accountName","accountKind","currency","agreementAcceptedAt","createdAt","updatedAt"],"properties":{"type":{"description":"Always `PsrcViewDirectDebit`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PsrcViewDirectDebit"]},"sourceId":{"$ref":"#/components/schemas/PsrcId","description":"Identifier of a payment source."},"customerId":{"$ref":"#/components/schemas/CustId","description":"Identifier of a customer."},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"Identifier of a merchant."},"status":{"$ref":"#/components/schemas/PsrcStatus"},"last4":{"description":"Last four digits of the account number.","type":"string"},"accountName":{"type":"string"},"accountKind":{"$ref":"#/components/schemas/PsrcBankAccountKind","description":"Which kind of bank account it is, which decides the currency it is held in."},"routingNumber":{"description":"Bank-state-branch number, for Australian accounts. Absent where the country does not use one.","type":"string"},"currency":{"$ref":"#/components/schemas/IsoCurrency","description":"The currency the source was stored with."},"agreementAcceptedAt":{"description":"When the payer accepted the direct-debit agreement. The debit is not lawful without it.","type":"string","format":"date-time"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"PsrcViewPayTo":{"title":"PsrcViewPayTo","description":"A PayTo agreement authorising debits from the payer's account.","examples":[{"type":"PsrcViewPayTo","sourceId":"psrc_9f2Kd8QpLzXw","customerId":"cust_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","status":"Active","accountHint":"example","accountName":"Ada Lovelace","agreementReference":"your-own-reference","expiresAt":"2026-08-19T04:21:07Z","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","sourceId","status","accountHint","accountName","agreementReference","expiresAt","createdAt","updatedAt"],"properties":{"type":{"description":"Always `PsrcViewPayTo`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PsrcViewPayTo"]},"sourceId":{"$ref":"#/components/schemas/PsrcId","description":"Identifier of a payment source."},"customerId":{"$ref":"#/components/schemas/CustId","description":"Identifier of a customer."},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"Identifier of a merchant."},"status":{"$ref":"#/components/schemas/PsrcStatus"},"accountHint":{"description":"The account or PayID the agreement is against, as much of it as may be shown.","type":"string"},"accountName":{"type":"string"},"agreementReference":{"description":"The agreement's identifier in the New Payments Platform.","type":"string"},"expiresAt":{"description":"When the agreement lapses.","type":"string","format":"date-time"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"PsrcverCmd":{"oneOf":[{"$ref":"#/components/schemas/PsrcverCmdCreate"}],"discriminator":{"propertyName":"type","mapping":{"PsrcverCmdCreate":"#/components/schemas/PsrcverCmdCreate"}}},"PsrcverCmdCreate":{"title":"PsrcverCmdCreate","description":"Run a verification against the payment source used by a transaction.","examples":[{"type":"PsrcverCmdCreate","transactionId":"tran_9f2Kd8QpLzXw"}],"type":"object","required":["type","transactionId"],"properties":{"type":{"description":"Always `PsrcverCmdCreate`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PsrcverCmdCreate"]},"transactionId":{"$ref":"#/components/schemas/TranId","description":"Identifier of a transaction."}}},"PsrcverColumn":{"title":"PsrcverColumn","type":"string","enum":["SourceVerificationId","SourceReference","Status","ChargedAmountMinorCurrencyUnits","ChargedAmountCurrency","CreatedAt","UpdatedAt"]},"PsrcverCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/PsrcverCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"PsrcverCreateRspAttributes":"#/components/schemas/PsrcverCreateRspAttributes"}}},"PsrcverCreateRspAttributes":{"title":"PsrcverCreateRspAttributes","examples":[{"type":"PsrcverCreateRspAttributes","created":{"type":"PsrcverViewAttributes","sourceVerificationId":"psrcver_9f2Kd8QpLzXw","sourceReference":"your-own-reference","status":"Pending","chargedAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `PsrcverCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PsrcverCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/PsrcverView","description":"The resource that was created."}}},"PsrcverId":{"title":"PsrcverId","description":"Identifier of a source verification.","examples":["psrcver_9f2Kd8QpLzXw"],"type":"string"},"PsrcverPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/PsrcverPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"PsrcverPageAttributes":"#/components/schemas/PsrcverPageAttributes"}}},"PsrcverPageAttributes":{"title":"PsrcverPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"PsrcverPageAttributes","data":[{"type":"PsrcverViewAttributes","sourceVerificationId":"psrcver_9f2Kd8QpLzXw","sourceReference":"your-own-reference","status":"Pending","chargedAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `PsrcverPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PsrcverPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/PsrcverView","description":"A verification run against the payment source used by a transaction."}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"PsrcverStatus":{"title":"PsrcverStatus","type":"string","enum":["Pending","Passed","Failed","Expired","Unknown"]},"PsrcverUpdate":{"description":"Override a verification's outcome.","oneOf":[{"$ref":"#/components/schemas/PsrcverUpdateAttributes"}],"discriminator":{"propertyName":"type","mapping":{"PsrcverUpdateAttributes":"#/components/schemas/PsrcverUpdateAttributes"}}},"PsrcverUpdateAttributes":{"title":"PsrcverUpdateAttributes","description":"Override a verification's outcome.","examples":[{"type":"PsrcverUpdateAttributes","status":"Pending"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `PsrcverUpdateAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PsrcverUpdateAttributes"]},"status":{"$ref":"#/components/schemas/PsrcverStatus","description":"`Passed` passes the check, `Failed` fails it, `Pending` resets it to be confirmed again."}}},"PsrcverUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/PsrcverUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"PsrcverUpdateRspAttributes":"#/components/schemas/PsrcverUpdateRspAttributes"}}},"PsrcverUpdateRspAttributes":{"title":"PsrcverUpdateRspAttributes","examples":[{"type":"PsrcverUpdateRspAttributes","updated":{"type":"PsrcverViewAttributes","sourceVerificationId":"psrcver_9f2Kd8QpLzXw","sourceReference":"your-own-reference","status":"Pending","chargedAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `PsrcverUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PsrcverUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/PsrcverView","description":"The resource as it stands after the change."}}},"PsrcverView":{"oneOf":[{"$ref":"#/components/schemas/PsrcverViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"PsrcverViewAttributes":"#/components/schemas/PsrcverViewAttributes"}}},"PsrcverViewAttributes":{"title":"PsrcverViewAttributes","description":"A verification run against the payment source used by a transaction.","examples":[{"type":"PsrcverViewAttributes","sourceVerificationId":"psrcver_9f2Kd8QpLzXw","sourceReference":"your-own-reference","status":"Pending","chargedAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","sourceVerificationId","sourceReference","status","chargedAmount","createdAt","updatedAt"],"properties":{"type":{"description":"Always `PsrcverViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PsrcverViewAttributes"]},"sourceVerificationId":{"$ref":"#/components/schemas/PsrcverId"},"sourceReference":{"description":"The platform's reference for the source that was charged.","type":"string"},"status":{"$ref":"#/components/schemas/PsrcverStatus"},"chargedAmount":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"The amount debited for the payer to confirm."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"PtagAccount":{"oneOf":[{"$ref":"#/components/schemas/PtagAccountAlias"},{"$ref":"#/components/schemas/PtagAccountNumber"}],"discriminator":{"propertyName":"type","mapping":{"PtagAccountAlias":"#/components/schemas/PtagAccountAlias","PtagAccountNumber":"#/components/schemas/PtagAccountNumber"}}},"PtagAccountAlias":{"title":"PtagAccountAlias","description":"A PayID. Resolve it first so you can send the account name the bank holds.","examples":[{"type":"PtagAccountAlias","aliasType":"Phone","alias":"example"}],"type":"object","required":["type","aliasType","alias"],"properties":{"type":{"description":"Always `PtagAccountAlias`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PtagAccountAlias"]},"aliasType":{"$ref":"#/components/schemas/PtalType"},"alias":{"type":"string"}}},"PtagAccountNumber":{"title":"PtagAccountNumber","description":"A BSB and account number, joined by a hyphen, `062000-12345678`.","examples":[{"type":"PtagAccountNumber","bban":"example"}],"type":"object","required":["type","bban"],"properties":{"type":{"description":"Always `PtagAccountNumber`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PtagAccountNumber"]},"bban":{"type":"string"}}},"PtagCmd":{"oneOf":[{"$ref":"#/components/schemas/PtagCmdAsk"}],"discriminator":{"propertyName":"type","mapping":{"PtagCmdAsk":"#/components/schemas/PtagCmdAsk"}}},"PtagCmdAsk":{"title":"PtagCmdAsk","description":"Ask a payer for a standing authority to debit their account.","examples":[{"type":"PtagCmdAsk","merchantId":"mcht_9f2Kd8QpLzXw","customerId":"cust_9f2Kd8QpLzXw","customerAccountName":"Ada Lovelace","account":{"type":"PtagAccountAlias","aliasType":"Phone","alias":"example"},"terms":{"type":"PtagTermsOneOff","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"}},"purpose":"Mortgage"}],"type":"object","required":["type","merchantId","customerAccountName","account","terms"],"properties":{"type":{"description":"Always `PtagCmdAsk`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PtagCmdAsk"]},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"Identifier of a merchant."},"customerId":{"$ref":"#/components/schemas/CustId","description":"The customer this is for. Supplying it narrows the authorisation to that customer."},"customerAccountName":{"description":"The account name as the payer's bank holds it. A mismatch is a declined agreement, resolve it with `/pay-to-aliases` first.","type":"string"},"account":{"$ref":"#/components/schemas/PtagAccount"},"terms":{"$ref":"#/components/schemas/PtagTerms"},"purpose":{"$ref":"#/components/schemas/PtagPurpose"}}},"PtagCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/PtagCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"PtagCreateRspAttributes":"#/components/schemas/PtagCreateRspAttributes"}}},"PtagCreateRspAttributes":{"title":"PtagCreateRspAttributes","examples":[{"type":"PtagCreateRspAttributes","created":{"type":"PtagViewAttributes","token":"tok_9f2Kd8QpLzXwR4mN","merchantId":"mcht_9f2Kd8QpLzXw","customerId":"cust_9f2Kd8QpLzXw","status":"Pending"}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `PtagCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PtagCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/PtagView","description":"The resource that was created."}}},"PtagPurpose":{"title":"PtagPurpose","description":"What the debits are for. The payer's bank is told, and the payer sees it when they approve.","type":"string","enum":["Mortgage","Utility","Loan","DependantSupport","Gambling","Retail","Salary","Personal","Government","Pension","Unknown"]},"PtagStatus":{"title":"PtagStatus","type":"string","enum":["Pending","Created","Active","Suspended","Cancelled","Declined","Expired","Failed","Unknown"]},"PtagTerms":{"oneOf":[{"$ref":"#/components/schemas/PtagTermsOneOff"},{"$ref":"#/components/schemas/PtagTermsOpen"}],"discriminator":{"propertyName":"type","mapping":{"PtagTermsOneOff":"#/components/schemas/PtagTermsOneOff","PtagTermsOpen":"#/components/schemas/PtagTermsOpen"}}},"PtagTermsOneOff":{"title":"PtagTermsOneOff","description":"A single debit of exactly this amount. The payer's bank will refuse anything else.","examples":[{"type":"PtagTermsOneOff","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"}}],"type":"object","required":["type","amount"],"properties":{"type":{"description":"Always `PtagTermsOneOff`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PtagTermsOneOff"]},"amount":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"An amount in minor current units of a given currency."}}},"PtagTermsOpen":{"title":"PtagTermsOpen","description":"Debits of whatever the merchant bills, until the payer cancels. Say so plainly when you ask for one.","examples":[{"type":"PtagTermsOpen"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `PtagTermsOpen`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PtagTermsOpen"]}}},"PtagView":{"oneOf":[{"$ref":"#/components/schemas/PtagViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"PtagViewAttributes":"#/components/schemas/PtagViewAttributes"}}},"PtagViewAttributes":{"title":"PtagViewAttributes","description":"A standing authority a payer gives to be debited, addressed by its token.","examples":[{"type":"PtagViewAttributes","token":"tok_9f2Kd8QpLzXwR4mN","merchantId":"mcht_9f2Kd8QpLzXw","customerId":"cust_9f2Kd8QpLzXw","status":"Pending"}],"type":"object","required":["type","token","merchantId","status"],"properties":{"type":{"description":"Always `PtagViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PtagViewAttributes"]},"token":{"description":"The token that addresses this agreement. Carries the merchant, the customer and the account; treat it as a credential.","type":"string"},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"Identifier of a merchant."},"customerId":{"$ref":"#/components/schemas/CustId","description":"The customer the agreement is for, where one was named."},"status":{"$ref":"#/components/schemas/PtagStatus"}}},"PtalCmd":{"oneOf":[{"$ref":"#/components/schemas/PtalCmdLookup"}],"discriminator":{"propertyName":"type","mapping":{"PtalCmdLookup":"#/components/schemas/PtalCmdLookup"}}},"PtalCmdLookup":{"title":"PtalCmdLookup","description":"Resolve a PayID to the account name behind it.","examples":[{"type":"PtalCmdLookup","merchantId":"mcht_9f2Kd8QpLzXw","aliasType":"Phone","alias":"example"}],"type":"object","required":["type","merchantId","aliasType","alias"],"properties":{"type":{"description":"Always `PtalCmdLookup`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PtalCmdLookup"]},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"Identifier of a merchant."},"aliasType":{"$ref":"#/components/schemas/PtalType"},"alias":{"description":"The PayID to resolve. A phone number must be in E.164 form.","type":"string"}}},"PtalCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/PtalCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"PtalCreateRspAttributes":"#/components/schemas/PtalCreateRspAttributes"}}},"PtalCreateRspAttributes":{"title":"PtalCreateRspAttributes","examples":[{"type":"PtalCreateRspAttributes","created":{"type":"PtalViewAttributes","merchantId":"mcht_9f2Kd8QpLzXw","aliasType":"Phone","alias":"example","accountName":"Ada Lovelace"}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `PtalCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PtalCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/PtalView"}}},"PtalType":{"title":"PtalType","type":"string","enum":["Phone","Email","Abn","OrganisationIdentifier","Unknown"]},"PtalView":{"description":"The resource that was created.","oneOf":[{"$ref":"#/components/schemas/PtalViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"PtalViewAttributes":"#/components/schemas/PtalViewAttributes"}}},"PtalViewAttributes":{"title":"PtalViewAttributes","description":"The account name the New Payments Platform holds for a PayID.","examples":[{"type":"PtalViewAttributes","merchantId":"mcht_9f2Kd8QpLzXw","aliasType":"Phone","alias":"example","accountName":"Ada Lovelace"}],"type":"object","required":["type","merchantId","aliasType","alias","accountName"],"properties":{"type":{"description":"Always `PtalViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PtalViewAttributes"]},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"Identifier of a merchant."},"aliasType":{"$ref":"#/components/schemas/PtalType","description":"What kind of PayID was resolved."},"alias":{"description":"The PayID as it was given.","type":"string"},"accountName":{"description":"The account name the platform holds. Show this to the payer to confirm the account is theirs.","type":"string"}}},"PtknAmounts":{"description":"What a payment token charges. Both are in the single currency given here.","oneOf":[{"$ref":"#/components/schemas/PtknAmountsAttributes"}],"discriminator":{"propertyName":"type","mapping":{"PtknAmountsAttributes":"#/components/schemas/PtknAmountsAttributes"}}},"PtknAmountsAttributes":{"title":"PtknAmountsAttributes","description":"What a payment token charges. Both are in the single currency given here.","examples":[{"type":"PtknAmountsAttributes","currency":"AUD","amount":1250,"surcharge":1250}],"type":"object","required":["type","currency","amount","surcharge"],"properties":{"type":{"description":"Always `PtknAmountsAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PtknAmountsAttributes"]},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"amount":{"$ref":"#/components/schemas/MinorUnits","description":"The total the payer will be charged."},"surcharge":{"$ref":"#/components/schemas/MinorUnits","description":"Surcharge included in `amount`. Zero where the merchant does not surcharge this method."}}},"PtknCmd":{"oneOf":[{"$ref":"#/components/schemas/PtknCmdCreateFromApplePay"},{"$ref":"#/components/schemas/PtknCmdCreateFromBankAccount"},{"$ref":"#/components/schemas/PtknCmdCreateFromCard"},{"$ref":"#/components/schemas/PtknCmdCreateFromGooglePay"},{"$ref":"#/components/schemas/PtknCmdCreateFromPayTo"},{"$ref":"#/components/schemas/PtknCmdCreateFromSavedSource"}],"discriminator":{"propertyName":"type","mapping":{"PtknCmdCreateFromApplePay":"#/components/schemas/PtknCmdCreateFromApplePay","PtknCmdCreateFromBankAccount":"#/components/schemas/PtknCmdCreateFromBankAccount","PtknCmdCreateFromCard":"#/components/schemas/PtknCmdCreateFromCard","PtknCmdCreateFromGooglePay":"#/components/schemas/PtknCmdCreateFromGooglePay","PtknCmdCreateFromPayTo":"#/components/schemas/PtknCmdCreateFromPayTo","PtknCmdCreateFromSavedSource":"#/components/schemas/PtknCmdCreateFromSavedSource"}}},"PtknCmdCreateFromApplePay":{"title":"PtknCmdCreateFromApplePay","description":"Pay with Apple Pay.","examples":[{"type":"PtknCmdCreateFromApplePay","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"applePayPayload":"example","applePayMethod":"example","surcharge":{"type":"PtknSurchargeNone"}}],"type":"object","required":["type","amount","applePayPayload","applePayMethod"],"properties":{"type":{"description":"Always `PtknCmdCreateFromApplePay`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PtknCmdCreateFromApplePay"]},"amount":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"An amount in minor current units of a given currency."},"applePayPayload":{"description":"The `paymentData` object Apple returns to your page, passed through unchanged.","type":"string"},"applePayMethod":{"description":"The `paymentMethod` object Apple returns beside it, passed through unchanged.","type":"string"},"surcharge":{"$ref":"#/components/schemas/PtknSurcharge"}}},"PtknCmdCreateFromBankAccount":{"title":"PtknCmdCreateFromBankAccount","description":"Pay by direct debit from a bank account.","examples":[{"type":"PtknCmdCreateFromBankAccount","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"accountName":"Ada Lovelace","account":{"type":"PsrcBankAccountAu","bsb":"example","accountNumber":"example"},"emailAddress":"ada@example.com","agreementAccepted":true,"surcharge":{"type":"PtknSurchargeNone"}}],"type":"object","required":["type","amount","accountName","account","emailAddress","agreementAccepted"],"properties":{"type":{"description":"Always `PtknCmdCreateFromBankAccount`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PtknCmdCreateFromBankAccount"]},"amount":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"An amount in minor current units of a given currency."},"accountName":{"type":"string"},"account":{"$ref":"#/components/schemas/PsrcBankAccount","description":"The account, identified the way its country identifies one."},"emailAddress":{"description":"The payer's email, for the direct-debit agreement.","type":"string"},"agreementAccepted":{"description":"The payer has accepted the direct-debit agreement. Required, the platform refuses the create without it.","type":"boolean"},"surcharge":{"$ref":"#/components/schemas/PtknSurcharge"}}},"PtknCmdCreateFromCard":{"title":"PtknCmdCreateFromCard","description":"Pay with a card entered now. The number is tokenised by the vault before it reaches the API.","examples":[{"type":"PtknCmdCreateFromCard","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"cardNumber":"example","cvc":"example","expiryMonth":6,"expiryYear":2029,"cardHolderName":"Ada Lovelace","threeDsSessionId":"sess_9f2Kd8QpLzXw","surcharge":{"type":"PtknSurchargeNone"}}],"type":"object","required":["type","amount","cardNumber","expiryMonth","expiryYear"],"properties":{"type":{"description":"Always `PtknCmdCreateFromCard`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PtknCmdCreateFromCard"]},"amount":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"An amount in minor current units of a given currency."},"cardNumber":{"description":"The card number.","type":"string"},"cvc":{"description":"The card verification code.","type":"string"},"expiryMonth":{"description":"Expiry month, 1-12.","type":"integer","format":"int32"},"expiryYear":{"description":"Expiry year, four digits.","type":"integer","format":"int32"},"cardHolderName":{"type":"string"},"threeDsSessionId":{"type":"string"},"surcharge":{"$ref":"#/components/schemas/PtknSurcharge"}}},"PtknCmdCreateFromGooglePay":{"title":"PtknCmdCreateFromGooglePay","description":"Pay with Google Pay.","examples":[{"type":"PtknCmdCreateFromGooglePay","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"googlePayPayload":"example","googlePayMethod":"example","surcharge":{"type":"PtknSurchargeNone"}}],"type":"object","required":["type","amount","googlePayPayload","googlePayMethod"],"properties":{"type":{"description":"Always `PtknCmdCreateFromGooglePay`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PtknCmdCreateFromGooglePay"]},"amount":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"An amount in minor current units of a given currency."},"googlePayPayload":{"description":"The `paymentMethodData` object Google returns to your page, passed through unchanged.","type":"string"},"googlePayMethod":{"description":"The `paymentMethod` object Google returns beside it, passed through unchanged.","type":"string"},"surcharge":{"$ref":"#/components/schemas/PtknSurcharge"}}},"PtknCmdCreateFromPayTo":{"title":"PtknCmdCreateFromPayTo","description":"Pay under an existing PayTo agreement.","examples":[{"type":"PtknCmdCreateFromPayTo","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"agreementToken":"tok_9f2Kd8QpLzXwR4mN","surcharge":{"type":"PtknSurchargeNone"}}],"type":"object","required":["type","amount","agreementToken"],"properties":{"type":{"description":"Always `PtknCmdCreateFromPayTo`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PtknCmdCreateFromPayTo"]},"amount":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"An amount in minor current units of a given currency."},"agreementToken":{"description":"The agreement authorising this debit.","type":"string"},"surcharge":{"$ref":"#/components/schemas/PtknSurcharge"}}},"PtknCmdCreateFromSavedSource":{"title":"PtknCmdCreateFromSavedSource","description":"Pay with a payment source already stored against the customer.","examples":[{"type":"PtknCmdCreateFromSavedSource","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"sourceId":"psrc_9f2Kd8QpLzXw","cvc":"example","threeDsSessionId":"sess_9f2Kd8QpLzXw","surcharge":{"type":"PtknSurchargeNone"}}],"type":"object","required":["type","amount","sourceId"],"properties":{"type":{"description":"Always `PtknCmdCreateFromSavedSource`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PtknCmdCreateFromSavedSource"]},"amount":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"An amount in minor current units of a given currency."},"sourceId":{"$ref":"#/components/schemas/PsrcId","description":"Identifier of a payment source."},"cvc":{"description":"Required where the stored source is a card and the merchant asks for the code again. Tokenised by the vault.","type":"string"},"threeDsSessionId":{"description":"Links this token to a 3DS session already begun in the browser.","type":"string"},"surcharge":{"$ref":"#/components/schemas/PtknSurcharge"}}},"PtknCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/PtknCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"PtknCreateRspAttributes":"#/components/schemas/PtknCreateRspAttributes"}}},"PtknCreateRspAttributes":{"title":"PtknCreateRspAttributes","examples":[{"type":"PtknCreateRspAttributes","created":{"type":"PtknViewAttributes","paymentTokenId":"ptkn_9f2Kd8QpLzXw","sourceId":"psrc_9f2Kd8QpLzXw","amounts":{"type":"PtknAmountsAttributes","currency":"AUD","amount":1250,"surcharge":1250},"paymentType":{"type":"PtknTypePayInFull"},"method":{"type":"PtknMethodBankTransfer","reference":"your-own-reference"}}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `PtknCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PtknCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/PtknView","description":"The resource that was created."}}},"PtknId":{"title":"PtknId","examples":["ptkn_9f2Kd8QpLzXw"],"type":"string"},"PtknMethod":{"description":"What this token pays with. Decision 2: the method lives here and nowhere else, so everything downstream can refer to the token.","oneOf":[{"$ref":"#/components/schemas/PtknMethodBankTransfer"},{"$ref":"#/components/schemas/PtknMethodCard"},{"$ref":"#/components/schemas/PtknMethodDirectDebit"},{"$ref":"#/components/schemas/PtknMethodNetworkToken"},{"$ref":"#/components/schemas/PtknMethodPayTo"}],"discriminator":{"propertyName":"type","mapping":{"PtknMethodBankTransfer":"#/components/schemas/PtknMethodBankTransfer","PtknMethodCard":"#/components/schemas/PtknMethodCard","PtknMethodDirectDebit":"#/components/schemas/PtknMethodDirectDebit","PtknMethodNetworkToken":"#/components/schemas/PtknMethodNetworkToken","PtknMethodPayTo":"#/components/schemas/PtknMethodPayTo"}}},"PtknMethodBankTransfer":{"title":"PtknMethodBankTransfer","description":"A bank transfer the payer makes themselves, quoting this reference.","examples":[{"type":"PtknMethodBankTransfer","reference":"your-own-reference"}],"type":"object","required":["type","reference"],"properties":{"type":{"description":"Always `PtknMethodBankTransfer`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PtknMethodBankTransfer"]},"reference":{"description":"The reference the payer must quote, which is how the transfer is matched to this payment.","type":"string"}}},"PtknMethodCard":{"title":"PtknMethodCard","description":"A card, entered now or stored.","examples":[{"type":"PtknMethodCard","bin":"424242","last4":"4242","expiryMonth":6,"expiryYear":2029,"brand":"Visa","country":"AU","funding":"Credit"}],"type":"object","required":["type","bin","last4","expiryMonth","expiryYear","brand","country","funding"],"properties":{"type":{"description":"Always `PtknMethodCard`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PtknMethodCard"]},"bin":{"description":"First six to eight digits, identifying the issuer.","type":"string"},"last4":{"description":"Last four digits of the card number.","type":"string"},"expiryMonth":{"type":"integer","format":"int32"},"expiryYear":{"type":"integer","format":"int32"},"brand":{"$ref":"#/components/schemas/CardBrand"},"country":{"$ref":"#/components/schemas/IsoCountry","description":"The country the card was issued in."},"funding":{"$ref":"#/components/schemas/CardFunding"}}},"PtknMethodDirectDebit":{"title":"PtknMethodDirectDebit","description":"A bank account, paid by direct debit.","examples":[{"type":"PtknMethodDirectDebit","account":{"type":"PsrcBankAccountAu","bsb":"example","accountNumber":"example"}}],"type":"object","required":["type","account"],"properties":{"type":{"description":"Always `PtknMethodDirectDebit`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PtknMethodDirectDebit"]},"account":{"$ref":"#/components/schemas/PsrcBankAccount","description":"The account, identified the way its country identifies one."}}},"PtknMethodNetworkToken":{"title":"PtknMethodNetworkToken","description":"A network token, a scheme-provisioned credential, which is what a wallet payment becomes.","examples":[{"type":"PtknMethodNetworkToken","networkType":"Visa","brand":"Visa","country":"AU","funding":"Credit"}],"type":"object","required":["type","networkType","brand"],"properties":{"type":{"description":"Always `PtknMethodNetworkToken`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PtknMethodNetworkToken"]},"networkType":{"$ref":"#/components/schemas/PtknNetworkType"},"brand":{"$ref":"#/components/schemas/CardBrand"},"country":{"$ref":"#/components/schemas/IsoCountry","description":"The country the underlying card was issued in, where the scheme says."},"funding":{"$ref":"#/components/schemas/CardFunding"}}},"PtknMethodPayTo":{"title":"PtknMethodPayTo","description":"A PayTo agreement the payer has accepted.","examples":[{"type":"PtknMethodPayTo","accountHint":"example","agreementUid":"abc123"}],"type":"object","required":["type","accountHint","agreementUid"],"properties":{"type":{"description":"Always `PtknMethodPayTo`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PtknMethodPayTo"]},"accountHint":{"description":"Enough of the payer's account to show them which one it is.","type":"string"},"agreementUid":{"description":"The agreement authorising the debit.","type":"string"}}},"PtknNetworkType":{"title":"PtknNetworkType","description":"Whose scheme provisioned the token.","type":"string","enum":["Visa","MasterCard","Unknown"]},"PtknSurcharge":{"oneOf":[{"$ref":"#/components/schemas/PtknSurchargeNone"},{"$ref":"#/components/schemas/PtknSurchargeQuoted"},{"$ref":"#/components/schemas/PtknSurchargeSpecified"}],"discriminator":{"propertyName":"type","mapping":{"PtknSurchargeNone":"#/components/schemas/PtknSurchargeNone","PtknSurchargeQuoted":"#/components/schemas/PtknSurchargeQuoted","PtknSurchargeSpecified":"#/components/schemas/PtknSurchargeSpecified"}}},"PtknSurchargeNone":{"title":"PtknSurchargeNone","description":"Do not surcharge this payment.","examples":[{"type":"PtknSurchargeNone"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `PtknSurchargeNone`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PtknSurchargeNone"]}}},"PtknSurchargeQuoted":{"title":"PtknSurchargeQuoted","description":"Honour a quote the payer has already been shown.","examples":[{"type":"PtknSurchargeQuoted","quote":{"type":"SrchqViewAttributes","surchargeQuoteId":"srchq_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","amounts":{"type":"SrchqAmountsAttributes","currency":"AUD","amount":1250,"surcharge":1250,"total":1250},"summary":"example","method":{"type":"SrchqMethodApplePay","card":{"type":"SrchqCardAttributesAttributes","currency":"AUD","country":"AU","brand":"Visa","funding":"Credit","prepaid":true,"issuer":"example","bin":"424242","productType":"Consumer","schemeProduct":"MasterCardCrPer"}}}}],"type":"object","required":["type","quote"],"properties":{"type":{"description":"Always `PtknSurchargeQuoted`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PtknSurchargeQuoted"]},"quote":{"$ref":"#/components/schemas/SrchqView","description":"The quote, exactly as `POST /surcharge-quotes` returned it."}}},"PtknSurchargeSpecified":{"title":"PtknSurchargeSpecified","description":"Apply this surcharge. Only open to calls authenticated with a secret key, a browser cannot name its own surcharge.","examples":[{"type":"PtknSurchargeSpecified","amount":1250}],"type":"object","required":["type","amount"],"properties":{"type":{"description":"Always `PtknSurchargeSpecified`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PtknSurchargeSpecified"]},"amount":{"$ref":"#/components/schemas/MinorUnits","description":"The surcharge to apply, in the payment's own currency. Unbounded, a negative value is a discount to the payer, which the platform allows deliberately."}}},"PtknType":{"description":"Whether this token pays in full or funds a plan, and which plan.","oneOf":[{"$ref":"#/components/schemas/PtknTypePayInFull"},{"$ref":"#/components/schemas/PtknTypePayPlan"}],"discriminator":{"propertyName":"type","mapping":{"PtknTypePayInFull":"#/components/schemas/PtknTypePayInFull","PtknTypePayPlan":"#/components/schemas/PtknTypePayPlan"}}},"PtknTypePayInFull":{"title":"PtknTypePayInFull","description":"Pays the whole amount at once.","examples":[{"type":"PtknTypePayInFull"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `PtknTypePayInFull`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PtknTypePayInFull"]}}},"PtknTypePayPlan":{"title":"PtknTypePayPlan","description":"Funds a payment plan. The variant is the schedule.","examples":[{"type":"PtknTypePayPlan","variant":"FourFortnightlyQuarters"}],"type":"object","required":["type","variant"],"properties":{"type":{"description":"Always `PtknTypePayPlan`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PtknTypePayPlan"]},"variant":{"$ref":"#/components/schemas/SrchqPayPlanVariant"}}},"PtknView":{"oneOf":[{"$ref":"#/components/schemas/PtknViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"PtknViewAttributes":"#/components/schemas/PtknViewAttributes"}}},"PtknViewAttributes":{"title":"PtknViewAttributes","description":"A single-use token authorising one payment of a stated amount.","examples":[{"type":"PtknViewAttributes","paymentTokenId":"ptkn_9f2Kd8QpLzXw","sourceId":"psrc_9f2Kd8QpLzXw","amounts":{"type":"PtknAmountsAttributes","currency":"AUD","amount":1250,"surcharge":1250},"paymentType":{"type":"PtknTypePayInFull"},"method":{"type":"PtknMethodBankTransfer","reference":"your-own-reference"}}],"type":"object","required":["type","paymentTokenId","amounts","paymentType","method"],"properties":{"type":{"description":"Always `PtknViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["PtknViewAttributes"]},"paymentTokenId":{"$ref":"#/components/schemas/PtknId","description":"Identifier of a payment token."},"sourceId":{"$ref":"#/components/schemas/PsrcId","description":"The stored source this token was made from. Absent for a bank transfer and for a network token, which have no stored source."},"amounts":{"$ref":"#/components/schemas/PtknAmounts"},"paymentType":{"$ref":"#/components/schemas/PtknType"},"method":{"$ref":"#/components/schemas/PtknMethod"}}},"Queue":{"oneOf":[{"$ref":"#/components/schemas/QueueAttributes"}],"discriminator":{"propertyName":"type","mapping":{"QueueAttributes":"#/components/schemas/QueueAttributes"}}},"QueueAttributes":{"title":"QueueAttributes","description":"A queue the platform drains internally, and every consumer group draining it.","examples":[{"type":"QueueAttributes","queue":"example","tickerLagSeconds":1250,"eventsPerSecond":12.5,"consumers":[{"type":"QueueConsumerAttributes","consumer":"example","backlog":1250,"lagSeconds":1250,"members":1250,"silentMembers":1250}]}],"type":"object","required":["type","queue","tickerLagSeconds","eventsPerSecond"],"properties":{"type":{"description":"Always `QueueAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["QueueAttributes"]},"queue":{"description":"The queue's name, which is also its id.","type":"string"},"tickerLagSeconds":{"description":"Seconds since the queue last ticked. Ticking is driven by the consumers' own polling, so a large value means nobody is draining rather than that nothing is being published.","type":"integer","format":"int64"},"eventsPerSecond":{"description":"Events published per second, as the queue measures it.","type":"number","format":"double"},"consumers":{"description":"Every consumer group with a cursor on this queue. Empty means nothing is reading it.","type":"array","items":{"$ref":"#/components/schemas/QueueConsumer"}}}},"QueueColumn":{"title":"QueueColumn","type":"string","enum":["Queue","TickerLagSeconds","EventsPerSecond"]},"QueueConsumer":{"description":"One consumer group's position on a queue.","oneOf":[{"$ref":"#/components/schemas/QueueConsumerAttributes"}],"discriminator":{"propertyName":"type","mapping":{"QueueConsumerAttributes":"#/components/schemas/QueueConsumerAttributes"}}},"QueueConsumerAttributes":{"title":"QueueConsumerAttributes","description":"One consumer group's position on a queue.","examples":[{"type":"QueueConsumerAttributes","consumer":"example","backlog":1250,"lagSeconds":1250,"members":1250,"silentMembers":1250}],"type":"object","required":["type","consumer","backlog","lagSeconds","members","silentMembers"],"properties":{"type":{"description":"Always `QueueConsumerAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["QueueConsumerAttributes"]},"consumer":{"description":"The group's name. Its members are the processes drawing from it, one per running pod.","type":"string"},"backlog":{"description":"Events published and not yet drawn by this group. Zero means it is up to date.","type":"integer","format":"int64"},"lagSeconds":{"description":"Seconds since the events being handled were published. The number that says whether the group is keeping up: zero on an idle queue as much as on a fast one, and climbing when it is behind.","type":"integer","format":"int64"},"members":{"description":"Registered members of the group.","type":"integer","format":"int32"},"silentMembers":{"description":"Members that have stopped reporting in. A registration is only removed when something asks, so a member whose process is gone stays here until it is swept, and this is how much of `members` is residue.","type":"integer","format":"int32"}}},"QueueDeadLetter":{"oneOf":[{"$ref":"#/components/schemas/QueueDeadLetterAttributes"}],"discriminator":{"propertyName":"type","mapping":{"QueueDeadLetterAttributes":"#/components/schemas/QueueDeadLetterAttributes"}}},"QueueDeadLetterAttributes":{"title":"QueueDeadLetterAttributes","description":"A message a consumer group could not handle, kept exactly as it was published.","examples":[{"type":"QueueDeadLetterAttributes","queueDeadLetterId":"abc123","queue":"example","consumer":"example","diedAt":"2026-08-19T04:21:07Z","reason":"Requested by the customer.","eventId":1250,"publishedAt":"2026-08-19T04:21:07Z","message":{"type":"QueueMessageAttributes","eventType":"example","data":"example","extra1":"example","extra2":"example","extra3":"example","extra4":"example"}}],"type":"object","required":["type","queueDeadLetterId","queue","consumer","diedAt","eventId","publishedAt","message"],"properties":{"type":{"description":"Always `QueueDeadLetterAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["QueueDeadLetterAttributes"]},"queueDeadLetterId":{"type":"string"},"queue":{"description":"The queue it was published to.","type":"string"},"consumer":{"description":"The group that could not handle it. Never a single member: members come and go, the group does not.","type":"string"},"diedAt":{"description":"When it was given up on.","type":"string","format":"date-time"},"reason":{"description":"Why, as the consumer reported it. Absent when nothing said.","type":"string"},"eventId":{"description":"The queue's own id for the message, as it was when published.","type":"integer","format":"int64"},"publishedAt":{"description":"When it was published, which with `diedAt` is how long it survived.","type":"string","format":"date-time"},"message":{"$ref":"#/components/schemas/QueueMessage"}}},"QueueDlqPatch":{"oneOf":[{"$ref":"#/components/schemas/QueueDlqReplay"}],"discriminator":{"propertyName":"type","mapping":{"QueueDlqReplay":"#/components/schemas/QueueDlqReplay"}}},"QueueDlqReplay":{"title":"QueueDlqReplay","description":"Publish the message again, unchanged, so whoever is draining the queue is offered it afresh.","examples":[{"type":"QueueDlqReplay"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `QueueDlqReplay`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["QueueDlqReplay"]}}},"QueueDlqReplayOutcome":{"title":"QueueDlqReplayOutcome","type":"string","enum":["Replayed","NotFound","Failed","Unknown"]},"QueueDlqReplayResult":{"description":"What became of one dead letter in a batch replay.","oneOf":[{"$ref":"#/components/schemas/QueueDlqReplayResultAttributes"}],"discriminator":{"propertyName":"type","mapping":{"QueueDlqReplayResultAttributes":"#/components/schemas/QueueDlqReplayResultAttributes"}}},"QueueDlqReplayResultAttributes":{"title":"QueueDlqReplayResultAttributes","description":"What became of one dead letter in a batch replay.","examples":[{"type":"QueueDlqReplayResultAttributes","queueDeadLetterId":"abc123","outcome":"Replayed","error":"example"}],"type":"object","required":["type","queueDeadLetterId","outcome"],"properties":{"type":{"description":"Always `QueueDlqReplayResultAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["QueueDlqReplayResultAttributes"]},"queueDeadLetterId":{"type":"string"},"outcome":{"$ref":"#/components/schemas/QueueDlqReplayOutcome"},"error":{"description":"Why it could not be replayed, when `outcome` is `Failed`.","type":"string"}}},"QueueDlqReplays":{"description":"What a batch replay did, one result per dead letter named, in the order they were named.","oneOf":[{"$ref":"#/components/schemas/QueueDlqReplaysAttributes"}],"discriminator":{"propertyName":"type","mapping":{"QueueDlqReplaysAttributes":"#/components/schemas/QueueDlqReplaysAttributes"}}},"QueueDlqReplaysAttributes":{"title":"QueueDlqReplaysAttributes","description":"What a batch replay did, one result per dead letter named, in the order they were named.","examples":[{"type":"QueueDlqReplaysAttributes","queue":{"type":"QueueAttributes","queue":"example","tickerLagSeconds":1250,"eventsPerSecond":12.5,"consumers":[{"type":"QueueConsumerAttributes","consumer":"example","backlog":1250,"lagSeconds":1250,"members":1250,"silentMembers":1250}]},"results":[{"type":"QueueDlqReplayResultAttributes","queueDeadLetterId":"abc123","outcome":"Replayed","error":"example"}]}],"type":"object","required":["type","queue"],"properties":{"type":{"description":"Always `QueueDlqReplaysAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["QueueDlqReplaysAttributes"]},"queue":{"$ref":"#/components/schemas/Queue","description":"The queue as it reads after the replay, so its backlog counts the messages put back."},"results":{"description":"Every distinct id named, with what became of it.","type":"array","items":{"$ref":"#/components/schemas/QueueDlqReplayResult"}}}},"QueueMessage":{"description":"The message as published. Opaque here on purpose: what these fields mean belongs to whatever wrote them.","oneOf":[{"$ref":"#/components/schemas/QueueMessageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"QueueMessageAttributes":"#/components/schemas/QueueMessageAttributes"}}},"QueueMessageAttributes":{"title":"QueueMessageAttributes","description":"A queue message's fields, verbatim.","examples":[{"type":"QueueMessageAttributes","eventType":"example","data":"example","extra1":"example","extra2":"example","extra3":"example","extra4":"example"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `QueueMessageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["QueueMessageAttributes"]},"eventType":{"type":"string"},"data":{"type":"string"},"extra1":{"type":"string"},"extra2":{"type":"string"},"extra3":{"type":"string"},"extra4":{"type":"string"}}},"QueuePage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/QueuePageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"QueuePageAttributes":"#/components/schemas/QueuePageAttributes"}}},"QueuePageAttributes":{"title":"QueuePageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"QueuePageAttributes","data":[{"type":"QueueAttributes","queue":"example","tickerLagSeconds":1250,"eventsPerSecond":12.5,"consumers":[{"type":"QueueConsumerAttributes","consumer":"example","backlog":1250,"lagSeconds":1250,"members":1250,"silentMembers":1250}]}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `QueuePageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["QueuePageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/Queue","description":"A queue the platform drains internally, and every consumer group draining it."}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"QueueUpdate":{"description":"Replay several of this queue's dead letters in one request, each published again unchanged. One that cannot be replayed does not stop the rest, and the answer says what became of every id.","oneOf":[{"$ref":"#/components/schemas/QueueUpdateReplayDeadLetters"}],"discriminator":{"propertyName":"type","mapping":{"QueueUpdateReplayDeadLetters":"#/components/schemas/QueueUpdateReplayDeadLetters"}}},"QueueUpdateReplayDeadLetters":{"title":"QueueUpdateReplayDeadLetters","description":"Replay several of this queue's dead letters in one request, each published again unchanged. One that cannot be replayed does not stop the rest, and the answer says what became of every id.","examples":[{"type":"QueueUpdateReplayDeadLetters","queueDeadLetterIds":["abc123"]}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `QueueUpdateReplayDeadLetters`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["QueueUpdateReplayDeadLetters"]},"queueDeadLetterIds":{"description":"The dead letters to replay, by `queueDeadLetterId`: 1 to 100 of them. An id named twice is replayed once.","type":"array","items":{"type":"string"}}}},"QueuedlqPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/QueuedlqPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"QueuedlqPageAttributes":"#/components/schemas/QueuedlqPageAttributes"}}},"QueuedlqPageAttributes":{"title":"QueuedlqPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"QueuedlqPageAttributes","data":[{"type":"QueueDeadLetterAttributes","queueDeadLetterId":"abc123","queue":"example","consumer":"example","diedAt":"2026-08-19T04:21:07Z","reason":"Requested by the customer.","eventId":1250,"publishedAt":"2026-08-19T04:21:07Z","message":{"type":"QueueMessageAttributes","eventType":"example","data":"example","extra1":"example","extra2":"example","extra3":"example","extra4":"example"}}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `QueuedlqPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["QueuedlqPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/QueueDeadLetter","description":"A message a consumer group could not handle, kept exactly as it was published."}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"QueuedlqUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/QueuedlqUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"QueuedlqUpdateRspAttributes":"#/components/schemas/QueuedlqUpdateRspAttributes"}}},"QueuedlqUpdateRspAttributes":{"title":"QueuedlqUpdateRspAttributes","examples":[{"type":"QueuedlqUpdateRspAttributes","updated":{"type":"QueueDeadLetterAttributes","queueDeadLetterId":"abc123","queue":"example","consumer":"example","diedAt":"2026-08-19T04:21:07Z","reason":"Requested by the customer.","eventId":1250,"publishedAt":"2026-08-19T04:21:07Z","message":{"type":"QueueMessageAttributes","eventType":"example","data":"example","extra1":"example","extra2":"example","extra3":"example","extra4":"example"}}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `QueuedlqUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["QueuedlqUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/QueueDeadLetter","description":"The resource as it stands after the change."}}},"RareaAction":{"description":"An action a rule of the area takes when it matches, and what can be configured on it.","oneOf":[{"$ref":"#/components/schemas/RareaActionAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RareaActionAttributes":"#/components/schemas/RareaActionAttributes"}}},"RareaActionAttributes":{"title":"RareaActionAttributes","description":"An action a rule of the area takes when it matches, and what can be configured on it.","examples":[{"type":"RareaActionAttributes","name":"Ada Lovelace","label":"example","parameters":[{"type":"RareaActionParameterAttributes","parameterId":"abc123","label":"example","valueType":"example","options":["example"],"required":true,"default":{"type":"RpolValueAmount","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"}}}]}],"type":"object","required":["type","name","label"],"properties":{"type":{"description":"Always `RareaActionAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RareaActionAttributes"]},"name":{"type":"string"},"label":{"type":"string"},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/RareaActionParameter"}}}},"RareaActionParameter":{"description":"A setting of an action a rule takes when it matches.","oneOf":[{"$ref":"#/components/schemas/RareaActionParameterAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RareaActionParameterAttributes":"#/components/schemas/RareaActionParameterAttributes"}}},"RareaActionParameterAttributes":{"title":"RareaActionParameterAttributes","description":"A setting of an action a rule takes when it matches.","examples":[{"type":"RareaActionParameterAttributes","parameterId":"abc123","label":"example","valueType":"example","options":["example"],"required":true,"default":{"type":"RpolValueAmount","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"}}}],"type":"object","required":["type","parameterId","label","valueType","required"],"properties":{"type":{"description":"Always `RareaActionParameterAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RareaActionParameterAttributes"]},"parameterId":{"type":"string"},"label":{"type":"string"},"valueType":{"description":"The kind of value it takes, as the engine names it.","type":"string"},"options":{"description":"The values it may take, for a setting that is a choice. Empty for one that is not.","type":"array","items":{"type":"string"}},"required":{"type":"boolean"},"default":{"$ref":"#/components/schemas/RpolValue","description":"What it takes when none is given. Absent when it has no default, or its default is a kind of value the API does not carry."}}},"RareaBound":{"oneOf":[{"$ref":"#/components/schemas/RareaBoundAtLeast"},{"$ref":"#/components/schemas/RareaBoundAtMost"},{"$ref":"#/components/schemas/RareaBoundInCurrency"},{"$ref":"#/components/schemas/RareaBoundOneOf"}],"discriminator":{"propertyName":"type","mapping":{"RareaBoundAtLeast":"#/components/schemas/RareaBoundAtLeast","RareaBoundAtMost":"#/components/schemas/RareaBoundAtMost","RareaBoundInCurrency":"#/components/schemas/RareaBoundInCurrency","RareaBoundOneOf":"#/components/schemas/RareaBoundOneOf"}}},"RareaBoundAtLeast":{"title":"RareaBoundAtLeast","description":"A number, percentage or amount no less than this.","examples":[{"type":"RareaBoundAtLeast","min":12.5}],"type":"object","required":["type","min"],"properties":{"type":{"description":"Always `RareaBoundAtLeast`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RareaBoundAtLeast"]},"min":{"type":"number"}}},"RareaBoundAtMost":{"title":"RareaBoundAtMost","description":"A number, percentage or amount no more than this.","examples":[{"type":"RareaBoundAtMost","max":12.5}],"type":"object","required":["type","max"],"properties":{"type":{"description":"Always `RareaBoundAtMost`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RareaBoundAtMost"]},"max":{"type":"number"}}},"RareaBoundInCurrency":{"title":"RareaBoundInCurrency","description":"An amount in this currency, so a threshold never compares with money in another.","examples":[{"type":"RareaBoundInCurrency","currency":"AUD"}],"type":"object","required":["type","currency"],"properties":{"type":{"description":"Always `RareaBoundInCurrency`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RareaBoundInCurrency"]},"currency":{"type":"string"}}},"RareaBoundOneOf":{"title":"RareaBoundOneOf","description":"Text, or a choice, among these.","examples":[{"type":"RareaBoundOneOf","values":["example"]}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `RareaBoundOneOf`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RareaBoundOneOf"]},"values":{"type":"array","items":{"type":"string"}}}},"RareaColumn":{"title":"RareaColumn","type":"string","enum":["RuleAreaId"]},"RareaField":{"description":"A field a rule of the area reads.","oneOf":[{"$ref":"#/components/schemas/RareaFieldAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RareaFieldAttributes":"#/components/schemas/RareaFieldAttributes"}}},"RareaFieldAttributes":{"title":"RareaFieldAttributes","description":"A field a rule of the area reads.","examples":[{"type":"RareaFieldAttributes","name":"Ada Lovelace","valueType":"example","operators":[{"type":"RareaOperatorAttributes","name":"Ada Lovelace","symbol":"example","description":"A short description."}],"sensitivity":"Plain"}],"type":"object","required":["type","name","valueType","sensitivity"],"properties":{"type":{"description":"Always `RareaFieldAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RareaFieldAttributes"]},"name":{"description":"The field's name, which a template compares.","type":"string"},"valueType":{"description":"The kind of value it holds, as the engine names it.","type":"string"},"operators":{"description":"The ways a rule may compare it.","type":"array","items":{"$ref":"#/components/schemas/RareaOperator"}},"sensitivity":{"$ref":"#/components/schemas/RareaSensitivity"}}},"RareaOperator":{"description":"One way of comparing a field.","oneOf":[{"$ref":"#/components/schemas/RareaOperatorAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RareaOperatorAttributes":"#/components/schemas/RareaOperatorAttributes"}}},"RareaOperatorAttributes":{"title":"RareaOperatorAttributes","description":"One way of comparing a field.","examples":[{"type":"RareaOperatorAttributes","name":"Ada Lovelace","symbol":"example","description":"A short description."}],"type":"object","required":["type","name","symbol","description"],"properties":{"type":{"description":"Always `RareaOperatorAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RareaOperatorAttributes"]},"name":{"description":"The operator's name.","type":"string"},"symbol":{"description":"How a rule's narrative writes it.","type":"string"},"description":{"type":"string"}}},"RareaPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/RareaPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RareaPageAttributes":"#/components/schemas/RareaPageAttributes"}}},"RareaPageAttributes":{"title":"RareaPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"RareaPageAttributes","data":[{"type":"RareaViewAttributes","ruleAreaId":"abc123","templates":[{"type":"RareaTemplateAttributes","templateId":"abc123","templateVersion":1250,"name":"Ada Lovelace","description":"A short description.","parameters":[{"type":"RareaParameterAttributes","parameterId":"abc123","label":"example","valueType":"example","required":true,"default":{"type":"RpolValueAmount","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"}},"bounds":[{"type":"RareaBoundAtLeast","min":12.5}],"listKind":"example"}],"presets":[{"type":"RareaPresetAttributes","name":"Ada Lovelace","arguments":[{"type":"RpolArgumentAttributes","parameterId":"abc123","value":{"type":"RpolValueAmount","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"}}}]}],"actions":["example"]}],"fields":[{"type":"RareaFieldAttributes","name":"Ada Lovelace","valueType":"example","operators":[{"type":"RareaOperatorAttributes","name":"Ada Lovelace","symbol":"example","description":"A short description."}],"sensitivity":"Plain"}],"actions":[{"type":"RareaActionAttributes","name":"Ada Lovelace","label":"example","parameters":[{"type":"RareaActionParameterAttributes","parameterId":"abc123","label":"example","valueType":"example","options":["example"],"required":true,"default":{"type":"RpolValueAmount","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"}}}]}],"listKinds":["example"]}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `RareaPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RareaPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/RareaView"}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"RareaParameter":{"description":"One parameter of a template: what it is called, the kind of value it takes, and what it may be.","oneOf":[{"$ref":"#/components/schemas/RareaParameterAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RareaParameterAttributes":"#/components/schemas/RareaParameterAttributes"}}},"RareaParameterAttributes":{"title":"RareaParameterAttributes","description":"One parameter of a template: what it is called, the kind of value it takes, and what it may be.","examples":[{"type":"RareaParameterAttributes","parameterId":"abc123","label":"example","valueType":"example","required":true,"default":{"type":"RpolValueAmount","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"}},"bounds":[{"type":"RareaBoundAtLeast","min":12.5}],"listKind":"example"}],"type":"object","required":["type","parameterId","label","valueType","required"],"properties":{"type":{"description":"Always `RareaParameterAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RareaParameterAttributes"]},"parameterId":{"description":"The id a rule names the parameter by.","type":"string"},"label":{"type":"string"},"valueType":{"description":"The kind of value it takes, as the engine names it: `Number`, `Percent`, `Money`, `String`, `Boolean`, `DynamicDateRange`, `List` or `ListReference`. A rule states it as the matching `RpolValue`.","type":"string"},"required":{"description":"Whether a rule must give it a value. One that is not required and has a default takes the default.","type":"boolean"},"default":{"$ref":"#/components/schemas/RpolValue","description":"What it takes when a rule gives it none. Absent when it has no default, or its default is a kind of value the API does not carry."},"bounds":{"description":"What its value must keep to.","type":"array","items":{"$ref":"#/components/schemas/RareaBound"}},"listKind":{"description":"For a parameter that names lists: the kind of list it takes, which is one of the area's `listKinds`.","type":"string"}}},"RareaPreset":{"description":"A pre-canned rule of a template: a name and the values it gives.","oneOf":[{"$ref":"#/components/schemas/RareaPresetAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RareaPresetAttributes":"#/components/schemas/RareaPresetAttributes"}}},"RareaPresetAttributes":{"title":"RareaPresetAttributes","description":"A pre-canned rule of a template: a name and the values it gives.","examples":[{"type":"RareaPresetAttributes","name":"Ada Lovelace","arguments":[{"type":"RpolArgumentAttributes","parameterId":"abc123","value":{"type":"RpolValueAmount","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"}}}]}],"type":"object","required":["type","name"],"properties":{"type":{"description":"Always `RareaPresetAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RareaPresetAttributes"]},"name":{"type":"string"},"arguments":{"type":"array","items":{"$ref":"#/components/schemas/RpolArgument"}}}},"RareaSensitivity":{"title":"RareaSensitivity","type":"string","enum":["Plain","Personal","Card","Credential","Unknown"]},"RareaTemplate":{"description":"A kind of rule the area offers: one template, filled in with a value for each parameter.","oneOf":[{"$ref":"#/components/schemas/RareaTemplateAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RareaTemplateAttributes":"#/components/schemas/RareaTemplateAttributes"}}},"RareaTemplateAttributes":{"title":"RareaTemplateAttributes","description":"A kind of rule the area offers: one template, filled in with a value for each parameter.","examples":[{"type":"RareaTemplateAttributes","templateId":"abc123","templateVersion":1250,"name":"Ada Lovelace","description":"A short description.","parameters":[{"type":"RareaParameterAttributes","parameterId":"abc123","label":"example","valueType":"example","required":true,"default":{"type":"RpolValueAmount","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"}},"bounds":[{"type":"RareaBoundAtLeast","min":12.5}],"listKind":"example"}],"presets":[{"type":"RareaPresetAttributes","name":"Ada Lovelace","arguments":[{"type":"RpolArgumentAttributes","parameterId":"abc123","value":{"type":"RpolValueAmount","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"}}}]}],"actions":["example"]}],"type":"object","required":["type","templateId","templateVersion","name","description"],"properties":{"type":{"description":"Always `RareaTemplateAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RareaTemplateAttributes"]},"templateId":{"description":"The id a rule names the template by.","type":"string"},"templateVersion":{"description":"The template's version, which a policy keeps for as long as it holds the rule it was made with.","type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/RareaParameter"}},"presets":{"type":"array","items":{"$ref":"#/components/schemas/RareaPreset"}},"actions":{"description":"The actions a rule of the template may take, each one of the area's `actions`.","type":"array","items":{"type":"string"}}}},"RareaView":{"description":"What a rule area offers: the kinds of rule a caller can make from its templates, the fields they read and how they compare them, the actions they take, and the kinds of entry its named lists hold. All of it is read from the area, so a caller can draw a form for any area, and check a rule against it, without knowing the area.","oneOf":[{"$ref":"#/components/schemas/RareaViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RareaViewAttributes":"#/components/schemas/RareaViewAttributes"}}},"RareaViewAttributes":{"title":"RareaViewAttributes","description":"What a rule area offers: the kinds of rule a caller can make from its templates, the fields they read and how they compare them, the actions they take, and the kinds of entry its named lists hold. All of it is read from the area, so a caller can draw a form for any area, and check a rule against it, without knowing the area.","examples":[{"type":"RareaViewAttributes","ruleAreaId":"abc123","templates":[{"type":"RareaTemplateAttributes","templateId":"abc123","templateVersion":1250,"name":"Ada Lovelace","description":"A short description.","parameters":[{"type":"RareaParameterAttributes","parameterId":"abc123","label":"example","valueType":"example","required":true,"default":{"type":"RpolValueAmount","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"}},"bounds":[{"type":"RareaBoundAtLeast","min":12.5}],"listKind":"example"}],"presets":[{"type":"RareaPresetAttributes","name":"Ada Lovelace","arguments":[{"type":"RpolArgumentAttributes","parameterId":"abc123","value":{"type":"RpolValueAmount","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"}}}]}],"actions":["example"]}],"fields":[{"type":"RareaFieldAttributes","name":"Ada Lovelace","valueType":"example","operators":[{"type":"RareaOperatorAttributes","name":"Ada Lovelace","symbol":"example","description":"A short description."}],"sensitivity":"Plain"}],"actions":[{"type":"RareaActionAttributes","name":"Ada Lovelace","label":"example","parameters":[{"type":"RareaActionParameterAttributes","parameterId":"abc123","label":"example","valueType":"example","options":["example"],"required":true,"default":{"type":"RpolValueAmount","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"}}}]}],"listKinds":["example"]}],"type":"object","required":["type","ruleAreaId"],"properties":{"type":{"description":"Always `RareaViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RareaViewAttributes"]},"ruleAreaId":{"description":"The area's domain, which names it and is the `domain` of its policies and named lists.","type":"string"},"templates":{"type":"array","items":{"$ref":"#/components/schemas/RareaTemplate"}},"fields":{"type":"array","items":{"$ref":"#/components/schemas/RareaField"}},"actions":{"type":"array","items":{"$ref":"#/components/schemas/RareaAction"}},"listKinds":{"description":"The kinds of entry a named list of this area may hold.","type":"array","items":{"type":"string"}}}},"RaskChartType":{"title":"RaskChartType","type":"string","enum":["auto","line","area","column","bar","stacked","number","table","pie"]},"RaskCmd":{"title":"RaskCmd","description":"A question about the caller's reporting, in words.","examples":[{"prompt":"example","context":{"dashboardId":"abc123","tab":"example","proposal":{}}}],"type":"object","required":["prompt"],"properties":{"prompt":{"description":"The question, at most 2000 characters.","type":"string"},"context":{"$ref":"#/components/schemas/RaskContext"}}},"RaskContext":{"title":"RaskContext","description":"Where the person is asking from.","examples":[{"dashboardId":"abc123","tab":"example","proposal":{}}],"type":"object","properties":{"dashboardId":{"description":"The dashboard open in the widget, by id (`rdsh_...`).","type":"string"},"tab":{"description":"The tab of that dashboard the person is on.","type":"string"},"proposal":{"description":"A proposal this question refines (\"make it weekly\"), as an earlier `proposal` event gave it."}}},"RaskEvent":{"description":"One server-sent event of a single Ask: `progress` while the agent works, then a `proposal` or an `error`, then `done`.","oneOf":[{"$ref":"#/components/schemas/RaskEventDone"},{"$ref":"#/components/schemas/RaskEventError"},{"$ref":"#/components/schemas/RaskEventProgress"},{"$ref":"#/components/schemas/RaskEventProposal"}],"discriminator":{"propertyName":"event","mapping":{"done":"#/components/schemas/RaskEventDone","error":"#/components/schemas/RaskEventError","progress":"#/components/schemas/RaskEventProgress","proposal":"#/components/schemas/RaskEventProposal"}}},"RaskEventDone":{"title":"RaskEventDone","description":"Always last.","examples":[{"event":"done","data":{"usage":{"inputTokens":1250,"outputTokens":1250}}}],"type":"object","required":["event","data"],"properties":{"event":{"description":"Always `done`: the frame's `event:` line.","type":"string","enum":["done"]},"data":{"$ref":"#/components/schemas/RaskEventDoneData"}}},"RaskEventDoneData":{"title":"RaskEventDoneData","description":"The run has ended. Always the last event.","examples":[{"usage":{"inputTokens":1250,"outputTokens":1250}}],"type":"object","properties":{"usage":{"$ref":"#/components/schemas/RaskUsage"}}},"RaskEventError":{"title":"RaskEventError","description":"The run ended without a proposal. In place of one.","examples":[{"event":"error","data":{"message":"example","retryable":true}}],"type":"object","required":["event","data"],"properties":{"event":{"description":"Always `error`: the frame's `event:` line.","type":"string","enum":["error"]},"data":{"$ref":"#/components/schemas/RaskEventErrorData"}}},"RaskEventErrorData":{"title":"RaskEventErrorData","description":"Why the run ended without an answer.","examples":[{"message":"example","retryable":true}],"type":"object","required":["message","retryable"],"properties":{"message":{"description":"For the person.","type":"string"},"retryable":{"description":"Whether asking again may answer it.","type":"boolean"}}},"RaskEventProgress":{"title":"RaskEventProgress","description":"While the agent reads and asks. Any number of them.","examples":[{"event":"progress","data":{"text":"example"}}],"type":"object","required":["event","data"],"properties":{"event":{"description":"Always `progress`: the frame's `event:` line.","type":"string","enum":["progress"]},"data":{"$ref":"#/components/schemas/RaskEventProgressData"}}},"RaskEventProgressData":{"title":"RaskEventProgressData","description":"What the agent is doing while it reads the datasets and asks the semantic layer.","examples":[{"text":"example"}],"type":"object","required":["text"],"properties":{"text":{"description":"A line for the person, such as `Reading the datasets`.","type":"string"}}},"RaskEventProposal":{"title":"RaskEventProposal","description":"The proposal, answered live by the widget. At most one.","examples":[{"event":"proposal","data":{"kind":"questions","questions":[{"type":"RqryCmdRun","reportDatasetId":"abc123","measures":["example"],"dimensions":["example"],"time":{"type":"RqryTimeSliceAttributes","grain":"example","range":{"type":"RqryRangeBetween","from":"2026-08-19","to":"2026-08-19"},"compare":"PreviousPeriod"},"filters":[{"type":"RqryFilterAbove","dimension":"example","value":"example"}],"sort":[{"type":"RqrySortDimension","dimension":"example","ascending":true}],"limit":25,"page":"example","segments":["example"],"measureFilters":[{"type":"RqryMeasureFilterAbove","measure":"example","value":"example"}],"top":{"type":"RqryTopAttributes","dimension":"example","count":42,"measure":"example"},"narrowTo":{"type":"RqryNarrowCustomers","customerIds":["cust_9f2Kd8QpLzXw"]},"asAt":"2026-08-19T04:21:07Z","pivot":{"type":"RqryPivotAttributes","rows":["example"],"columns":["example"],"subtotals":true},"timezone":"example"}],"chart":{"title":"example","chartType":"auto"},"dashboard":{"title":"example","tiles":[{"chart":{"title":"example","chartType":"auto"},"x":1250,"y":1250,"w":1250,"h":1250}]},"explanation":"example"}}],"type":"object","required":["event","data"],"properties":{"event":{"description":"Always `proposal`: the frame's `event:` line.","type":"string","enum":["proposal"]},"data":{"$ref":"#/components/schemas/RaskEventProposalData","description":"Questions to ask, a chart drawing one, or a dashboard laid out from several, which nothing saves. Its figures come from asking its questions."}}},"RaskEventProposalData":{"title":"RaskEventProposalData","examples":[{"kind":"questions","questions":[{"type":"RqryCmdRun","reportDatasetId":"abc123","measures":["example"],"dimensions":["example"],"time":{"type":"RqryTimeSliceAttributes","grain":"example","range":{"type":"RqryRangeBetween","from":"2026-08-19","to":"2026-08-19"},"compare":"PreviousPeriod"},"filters":[{"type":"RqryFilterAbove","dimension":"example","value":"example"}],"sort":[{"type":"RqrySortDimension","dimension":"example","ascending":true}],"limit":25,"page":"example","segments":["example"],"measureFilters":[{"type":"RqryMeasureFilterAbove","measure":"example","value":"example"}],"top":{"type":"RqryTopAttributes","dimension":"example","count":42,"measure":"example"},"narrowTo":{"type":"RqryNarrowCustomers","customerIds":["cust_9f2Kd8QpLzXw"]},"asAt":"2026-08-19T04:21:07Z","pivot":{"type":"RqryPivotAttributes","rows":["example"],"columns":["example"],"subtotals":true},"timezone":"example"}],"chart":{"title":"example","chartType":"auto"},"dashboard":{"title":"example","tiles":[{"chart":{"title":"example","chartType":"auto"},"x":1250,"y":1250,"w":1250,"h":1250}]},"explanation":"example"}],"type":"object","required":["kind","questions","explanation"],"properties":{"kind":{"$ref":"#/components/schemas/RaskProposalKind"},"questions":{"description":"Each written as a saved chart's question is, so it opens in the editor as one.","type":"array","items":{"$ref":"#/components/schemas/RqryCmdRun"}},"chart":{"$ref":"#/components/schemas/RaskProposedChart","description":"For a `chart` proposal: the chart. Absent otherwise."},"dashboard":{"$ref":"#/components/schemas/RaskProposedDashboard"},"explanation":{"description":"One or two sentences for the person: what the proposal shows, and what it read to answer it.","type":"string"}}},"RaskProposalKind":{"title":"RaskProposalKind","type":"string","enum":["questions","chart","dashboard"]},"RaskProposedChart":{"title":"RaskProposedChart","examples":[{"title":"example","chartType":"auto"}],"type":"object","required":["title","chartType"],"properties":{"title":{"description":"A short title a person would give the chart.","type":"string"},"chartType":{"$ref":"#/components/schemas/RaskChartType"}}},"RaskProposedDashboard":{"title":"RaskProposedDashboard","description":"For a `dashboard` proposal: the dashboard. Absent otherwise.","examples":[{"title":"example","tiles":[{"chart":{"title":"example","chartType":"auto"},"x":1250,"y":1250,"w":1250,"h":1250}]}],"type":"object","required":["title","tiles"],"properties":{"title":{"description":"A short title a person would give the dashboard.","type":"string"},"tiles":{"description":"Its tiles, one per question.","type":"array","items":{"$ref":"#/components/schemas/RaskProposedTile"}}}},"RaskProposedTile":{"title":"RaskProposedTile","description":"A tile of a proposed dashboard, on its 24-column grid.","examples":[{"chart":{"title":"example","chartType":"auto"},"x":1250,"y":1250,"w":1250,"h":1250}],"type":"object","required":["chart","x","y","w","h"],"properties":{"chart":{"$ref":"#/components/schemas/RaskProposedChart","description":"A chart a proposal draws."},"x":{"description":"Its left column, from 0.","type":"integer","format":"int32"},"y":{"description":"Its top row, from 0.","type":"integer","format":"int32"},"w":{"description":"Its width in columns, 1 to 24.","type":"integer","format":"int32"},"h":{"description":"Its height in rows.","type":"integer","format":"int32"}}},"RaskUsage":{"title":"RaskUsage","description":"Absent when nothing was asked of a model.","examples":[{"inputTokens":1250,"outputTokens":1250}],"type":"object","required":["inputTokens","outputTokens"],"properties":{"inputTokens":{"description":"Tokens the model read.","type":"integer","format":"int64"},"outputTokens":{"description":"Tokens the model wrote.","type":"integer","format":"int64"}}},"RchtChartType":{"title":"RchtChartType","type":"string","enum":["Auto","Line","Area","Column","Bar","Stacked","Number","Table","Pie","Unknown"]},"RchtCmd":{"oneOf":[{"$ref":"#/components/schemas/RchtCmdCopy"},{"$ref":"#/components/schemas/RchtCmdCreate"}],"discriminator":{"propertyName":"type","mapping":{"RchtCmdCopy":"#/components/schemas/RchtCmdCopy","RchtCmdCreate":"#/components/schemas/RchtCmdCreate"}}},"RchtCmdCopy":{"title":"RchtCmdCopy","description":"Save a copy of a chart the caller can read, owned by the caller, in its space or another the caller may change.","examples":[{"type":"RchtCmdCopy","copyOf":"rcht_9f2Kd8QpLzXw","reportSpaceId":"rspc_9f2Kd8QpLzXw","title":"example"}],"type":"object","required":["type","copyOf"],"properties":{"type":{"description":"Always `RchtCmdCopy`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RchtCmdCopy"]},"copyOf":{"$ref":"#/components/schemas/RchtId","description":"The chart to copy."},"reportSpaceId":{"$ref":"#/components/schemas/RspcId","description":"Where to save the copy. Absent for the original's space, or for the caller's default space when the original is in the System space."},"title":{"description":"Absent for the original's title with ` (copy)` after it.","type":"string"}}},"RchtCmdCreate":{"title":"RchtCmdCreate","description":"Save a chart in a space the caller may change. Its question must be one the caller could ask now.","examples":[{"type":"RchtCmdCreate","reportSpaceId":"rspc_9f2Kd8QpLzXw","title":"example","question":{"type":"RqryCmdRun","reportDatasetId":"abc123","measures":["example"],"dimensions":["example"],"time":{"type":"RqryTimeSliceAttributes","grain":"example","range":{"type":"RqryRangeBetween","from":"2026-08-19","to":"2026-08-19"},"compare":"PreviousPeriod"},"filters":[{"type":"RqryFilterAbove","dimension":"example","value":"example"}],"sort":[{"type":"RqrySortDimension","dimension":"example","ascending":true}],"limit":25,"page":"example","segments":["example"],"measureFilters":[{"type":"RqryMeasureFilterAbove","measure":"example","value":"example"}],"top":{"type":"RqryTopAttributes","dimension":"example","count":42,"measure":"example"},"narrowTo":{"type":"RqryNarrowCustomers","customerIds":["cust_9f2Kd8QpLzXw"]},"asAt":"2026-08-19T04:21:07Z","pivot":{"type":"RqryPivotAttributes","rows":["example"],"columns":["example"],"subtotals":true},"timezone":"example"},"presentation":{"type":"RchtPresentationAttributes","chartType":"Auto","colours":{"type":"RchtColoursAttributes","palette":"Categorical","overrides":[{"type":"RchtColourOverrideAttributes","series":"example","swatch":"example"}]},"description":"A short description.","riseIs":"Good","stackTotal":"example","referenceLines":[{"type":"RchtReferenceLineConstant","label":"example","value":"example"}],"table":{"type":"RchtTableAttributes","rowLink":"example","statuses":[{"type":"RchtStatusColumnAttributes","column":"example","tones":[{"type":"RchtValueToneAttributes","value":"example","tone":"Danger"}]}]}}}],"type":"object","required":["type","reportSpaceId","title","question"],"properties":{"type":{"description":"Always `RchtCmdCreate`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RchtCmdCreate"]},"reportSpaceId":{"$ref":"#/components/schemas/RspcId","description":"Identifier of a report space."},"title":{"type":"string"},"question":{"$ref":"#/components/schemas/RqryCmdRun"},"presentation":{"$ref":"#/components/schemas/RchtPresentation","description":"Absent to draw it as its answer's shape calls for."}}},"RchtColourOverride":{"oneOf":[{"$ref":"#/components/schemas/RchtColourOverrideAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RchtColourOverrideAttributes":"#/components/schemas/RchtColourOverrideAttributes"}}},"RchtColourOverrideAttributes":{"title":"RchtColourOverrideAttributes","examples":[{"type":"RchtColourOverrideAttributes","series":"example","swatch":"example"}],"type":"object","required":["type","series","swatch"],"properties":{"type":{"description":"Always `RchtColourOverrideAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RchtColourOverrideAttributes"]},"series":{"description":"The series it colours: a measure's name, or a value of the dimension the chart is split by.","type":"string"},"swatch":{"description":"A step of a palette, its prefix and its number: `cat-3`, `seq-5`, `band-1`.","type":"string"}}},"RchtColours":{"description":"Absent for the palette the chart's shape calls for.","oneOf":[{"$ref":"#/components/schemas/RchtColoursAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RchtColoursAttributes":"#/components/schemas/RchtColoursAttributes"}}},"RchtColoursAttributes":{"title":"RchtColoursAttributes","examples":[{"type":"RchtColoursAttributes","palette":"Categorical","overrides":[{"type":"RchtColourOverrideAttributes","series":"example","swatch":"example"}]}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `RchtColoursAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RchtColoursAttributes"]},"palette":{"$ref":"#/components/schemas/RchtPalette"},"overrides":{"type":"array","items":{"$ref":"#/components/schemas/RchtColourOverride"}}}},"RchtColumn":{"title":"RchtColumn","type":"string","enum":["ReportChartId","ReportSpaceId","Title","QuestionReportDatasetId","QuestionTimeGrain","QuestionTimeCompare","QuestionLimit","QuestionPage","QuestionTopDimension","QuestionTopCount","QuestionTopMeasure","QuestionAsAt","QuestionPivotSubtotals","QuestionTimezone","PresentationChartType","PresentationColoursPalette","PresentationDescription","PresentationRiseIs","PresentationStackTotal","PresentationTableRowLink","Stale","Access","OwnedByCaller","Editable","CreatedAt","UpdatedAt"]},"RchtCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/RchtCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RchtCreateRspAttributes":"#/components/schemas/RchtCreateRspAttributes"}}},"RchtCreateRspAttributes":{"title":"RchtCreateRspAttributes","examples":[{"type":"RchtCreateRspAttributes","created":{"type":"RchtViewAttributes","reportChartId":"rcht_9f2Kd8QpLzXw","reportSpaceId":"rspc_9f2Kd8QpLzXw","title":"example","question":{"type":"RqryCmdRun","reportDatasetId":"abc123","measures":["example"],"dimensions":["example"],"time":{"type":"RqryTimeSliceAttributes","grain":"example","range":{"type":"RqryRangeBetween","from":"2026-08-19","to":"2026-08-19"},"compare":"PreviousPeriod"},"filters":[{"type":"RqryFilterAbove","dimension":"example","value":"example"}],"sort":[{"type":"RqrySortDimension","dimension":"example","ascending":true}],"limit":25,"page":"example","segments":["example"],"measureFilters":[{"type":"RqryMeasureFilterAbove","measure":"example","value":"example"}],"top":{"type":"RqryTopAttributes","dimension":"example","count":42,"measure":"example"},"narrowTo":{"type":"RqryNarrowCustomers","customerIds":["cust_9f2Kd8QpLzXw"]},"asAt":"2026-08-19T04:21:07Z","pivot":{"type":"RqryPivotAttributes","rows":["example"],"columns":["example"],"subtotals":true},"timezone":"example"},"presentation":{"type":"RchtPresentationAttributes","chartType":"Auto","colours":{"type":"RchtColoursAttributes","palette":"Categorical","overrides":[{"type":"RchtColourOverrideAttributes","series":"example","swatch":"example"}]},"description":"A short description.","riseIs":"Good","stackTotal":"example","referenceLines":[{"type":"RchtReferenceLineConstant","label":"example","value":"example"}],"table":{"type":"RchtTableAttributes","rowLink":"example","statuses":[{"type":"RchtStatusColumnAttributes","column":"example","tones":[{"type":"RchtValueToneAttributes","value":"example","tone":"Danger"}]}]}},"stale":"example","access":"Private","tenant":{"type":"RspcTenantEnterprise","enterpriseId":"ent_9f2Kd8QpLzXw"},"ownedByCaller":true,"editable":true,"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `RchtCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RchtCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/RchtView","description":"The resource that was created."}}},"RchtId":{"title":"RchtId","examples":["rcht_9f2Kd8QpLzXw"],"type":"string"},"RchtPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/RchtPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RchtPageAttributes":"#/components/schemas/RchtPageAttributes"}}},"RchtPageAttributes":{"title":"RchtPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"RchtPageAttributes","data":[{"type":"RchtViewAttributes","reportChartId":"rcht_9f2Kd8QpLzXw","reportSpaceId":"rspc_9f2Kd8QpLzXw","title":"example","question":{"type":"RqryCmdRun","reportDatasetId":"abc123","measures":["example"],"dimensions":["example"],"time":{"type":"RqryTimeSliceAttributes","grain":"example","range":{"type":"RqryRangeBetween","from":"2026-08-19","to":"2026-08-19"},"compare":"PreviousPeriod"},"filters":[{"type":"RqryFilterAbove","dimension":"example","value":"example"}],"sort":[{"type":"RqrySortDimension","dimension":"example","ascending":true}],"limit":25,"page":"example","segments":["example"],"measureFilters":[{"type":"RqryMeasureFilterAbove","measure":"example","value":"example"}],"top":{"type":"RqryTopAttributes","dimension":"example","count":42,"measure":"example"},"narrowTo":{"type":"RqryNarrowCustomers","customerIds":["cust_9f2Kd8QpLzXw"]},"asAt":"2026-08-19T04:21:07Z","pivot":{"type":"RqryPivotAttributes","rows":["example"],"columns":["example"],"subtotals":true},"timezone":"example"},"presentation":{"type":"RchtPresentationAttributes","chartType":"Auto","colours":{"type":"RchtColoursAttributes","palette":"Categorical","overrides":[{"type":"RchtColourOverrideAttributes","series":"example","swatch":"example"}]},"description":"A short description.","riseIs":"Good","stackTotal":"example","referenceLines":[{"type":"RchtReferenceLineConstant","label":"example","value":"example"}],"table":{"type":"RchtTableAttributes","rowLink":"example","statuses":[{"type":"RchtStatusColumnAttributes","column":"example","tones":[{"type":"RchtValueToneAttributes","value":"example","tone":"Danger"}]}]}},"stale":"example","access":"Private","tenant":{"type":"RspcTenantEnterprise","enterpriseId":"ent_9f2Kd8QpLzXw"},"ownedByCaller":true,"editable":true,"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `RchtPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RchtPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/RchtView","description":"A saved question and how it is drawn. A dashboard's tiles show charts, and a change to a chart reaches every dashboard showing it."}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"RchtPalette":{"title":"RchtPalette","description":"Absent for the palette the chart's shape calls for.","type":"string","enum":["Categorical","Sequential","Bands","Unknown"]},"RchtPresentation":{"oneOf":[{"$ref":"#/components/schemas/RchtPresentationAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RchtPresentationAttributes":"#/components/schemas/RchtPresentationAttributes"}}},"RchtPresentationAttributes":{"title":"RchtPresentationAttributes","description":"How a chart draws its answer. What it asks is its question.","examples":[{"type":"RchtPresentationAttributes","chartType":"Auto","colours":{"type":"RchtColoursAttributes","palette":"Categorical","overrides":[{"type":"RchtColourOverrideAttributes","series":"example","swatch":"example"}]},"description":"A short description.","riseIs":"Good","stackTotal":"example","referenceLines":[{"type":"RchtReferenceLineConstant","label":"example","value":"example"}],"table":{"type":"RchtTableAttributes","rowLink":"example","statuses":[{"type":"RchtStatusColumnAttributes","column":"example","tones":[{"type":"RchtValueToneAttributes","value":"example","tone":"Danger"}]}]}}],"type":"object","required":["type","chartType"],"properties":{"type":{"description":"Always `RchtPresentationAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RchtPresentationAttributes"]},"chartType":{"$ref":"#/components/schemas/RchtChartType"},"colours":{"$ref":"#/components/schemas/RchtColours"},"description":{"description":"What the figure means, shown under the chart's title.","type":"string"},"riseIs":{"$ref":"#/components/schemas/RchtRiseIs","description":"Whether a rise in the figure is good news, which colours its change. Absent, a measure's target decides, and without one a change is not judged."},"stackTotal":{"description":"Given, a stacked chart also draws its stack's total, as a line under this label.","type":"string"},"referenceLines":{"type":"array","items":{"$ref":"#/components/schemas/RchtReferenceLine"}},"table":{"$ref":"#/components/schemas/RchtTable"}}},"RchtReferenceLine":{"oneOf":[{"$ref":"#/components/schemas/RchtReferenceLineConstant"},{"$ref":"#/components/schemas/RchtReferenceLineMeasure"},{"$ref":"#/components/schemas/RchtReferenceLineTarget"}],"discriminator":{"propertyName":"type","mapping":{"RchtReferenceLineConstant":"#/components/schemas/RchtReferenceLineConstant","RchtReferenceLineMeasure":"#/components/schemas/RchtReferenceLineMeasure","RchtReferenceLineTarget":"#/components/schemas/RchtReferenceLineTarget"}}},"RchtReferenceLineConstant":{"title":"RchtReferenceLineConstant","description":"A fixed figure, written as a decimal.","examples":[{"type":"RchtReferenceLineConstant","label":"example","value":"example"}],"type":"object","required":["type","label","value"],"properties":{"type":{"description":"Always `RchtReferenceLineConstant`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RchtReferenceLineConstant"]},"label":{"type":"string"},"value":{"type":"string"}}},"RchtReferenceLineMeasure":{"title":"RchtReferenceLineMeasure","description":"The figure of one of the dataset's measures over the chart's own range, such as a peak.","examples":[{"type":"RchtReferenceLineMeasure","label":"example","measure":"example"}],"type":"object","required":["type","label","measure"],"properties":{"type":{"description":"Always `RchtReferenceLineMeasure`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RchtReferenceLineMeasure"]},"label":{"type":"string"},"measure":{"type":"string"}}},"RchtReferenceLineTarget":{"title":"RchtReferenceLineTarget","description":"The target the catalogue sets the measure.","examples":[{"type":"RchtReferenceLineTarget","label":"example","measure":"example"}],"type":"object","required":["type","label","measure"],"properties":{"type":{"description":"Always `RchtReferenceLineTarget`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RchtReferenceLineTarget"]},"label":{"type":"string"},"measure":{"type":"string"}}},"RchtRiseIs":{"title":"RchtRiseIs","type":"string","enum":["Good","Bad","Neutral","Unknown"]},"RchtStatusColumn":{"description":"A column drawn as status chips, each value in its tone.","oneOf":[{"$ref":"#/components/schemas/RchtStatusColumnAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RchtStatusColumnAttributes":"#/components/schemas/RchtStatusColumnAttributes"}}},"RchtStatusColumnAttributes":{"title":"RchtStatusColumnAttributes","description":"A column drawn as status chips, each value in its tone.","examples":[{"type":"RchtStatusColumnAttributes","column":"example","tones":[{"type":"RchtValueToneAttributes","value":"example","tone":"Danger"}]}],"type":"object","required":["type","column"],"properties":{"type":{"description":"Always `RchtStatusColumnAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RchtStatusColumnAttributes"]},"column":{"description":"A dimension by its name, or a target's status by its measure's.","type":"string"},"tones":{"type":"array","items":{"$ref":"#/components/schemas/RchtValueTone"}}}},"RchtTable":{"description":"How a chart drawn as a table shows its rows, beyond the answer itself.","oneOf":[{"$ref":"#/components/schemas/RchtTableAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RchtTableAttributes":"#/components/schemas/RchtTableAttributes"}}},"RchtTableAttributes":{"title":"RchtTableAttributes","description":"How a chart drawn as a table shows its rows, beyond the answer itself.","examples":[{"type":"RchtTableAttributes","rowLink":"example","statuses":[{"type":"RchtStatusColumnAttributes","column":"example","tones":[{"type":"RchtValueToneAttributes","value":"example","tone":"Danger"}]}]}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `RchtTableAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RchtTableAttributes"]},"rowLink":{"description":"The dimension whose value opens its own page, such as a customer.","type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/RchtStatusColumn"}}}},"RchtTone":{"title":"RchtTone","type":"string","enum":["Danger","Warning","Success","Muted","Unknown"]},"RchtUpdate":{"oneOf":[{"$ref":"#/components/schemas/RchtUpdateMove"},{"$ref":"#/components/schemas/RchtUpdateRename"},{"$ref":"#/components/schemas/RchtUpdateReplaceQuestion"},{"$ref":"#/components/schemas/RchtUpdateSetPresentation"}],"discriminator":{"propertyName":"type","mapping":{"RchtUpdateMove":"#/components/schemas/RchtUpdateMove","RchtUpdateRename":"#/components/schemas/RchtUpdateRename","RchtUpdateReplaceQuestion":"#/components/schemas/RchtUpdateReplaceQuestion","RchtUpdateSetPresentation":"#/components/schemas/RchtUpdateSetPresentation"}}},"RchtUpdateMove":{"title":"RchtUpdateMove","description":"Save it in another space the caller may change.","examples":[{"type":"RchtUpdateMove","reportSpaceId":"rspc_9f2Kd8QpLzXw"}],"type":"object","required":["type","reportSpaceId"],"properties":{"type":{"description":"Always `RchtUpdateMove`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RchtUpdateMove"]},"reportSpaceId":{"$ref":"#/components/schemas/RspcId","description":"Identifier of a report space."}}},"RchtUpdateRename":{"title":"RchtUpdateRename","examples":[{"type":"RchtUpdateRename","title":"example"}],"type":"object","required":["type","title"],"properties":{"type":{"description":"Always `RchtUpdateRename`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RchtUpdateRename"]},"title":{"type":"string"}}},"RchtUpdateReplaceQuestion":{"title":"RchtUpdateReplaceQuestion","description":"Ask another question. It must be one the caller could ask now.","examples":[{"type":"RchtUpdateReplaceQuestion","question":{"type":"RqryCmdRun","reportDatasetId":"abc123","measures":["example"],"dimensions":["example"],"time":{"type":"RqryTimeSliceAttributes","grain":"example","range":{"type":"RqryRangeBetween","from":"2026-08-19","to":"2026-08-19"},"compare":"PreviousPeriod"},"filters":[{"type":"RqryFilterAbove","dimension":"example","value":"example"}],"sort":[{"type":"RqrySortDimension","dimension":"example","ascending":true}],"limit":25,"page":"example","segments":["example"],"measureFilters":[{"type":"RqryMeasureFilterAbove","measure":"example","value":"example"}],"top":{"type":"RqryTopAttributes","dimension":"example","count":42,"measure":"example"},"narrowTo":{"type":"RqryNarrowCustomers","customerIds":["cust_9f2Kd8QpLzXw"]},"asAt":"2026-08-19T04:21:07Z","pivot":{"type":"RqryPivotAttributes","rows":["example"],"columns":["example"],"subtotals":true},"timezone":"example"}}],"type":"object","required":["type","question"],"properties":{"type":{"description":"Always `RchtUpdateReplaceQuestion`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RchtUpdateReplaceQuestion"]},"question":{"$ref":"#/components/schemas/RqryCmdRun"}}},"RchtUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/RchtUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RchtUpdateRspAttributes":"#/components/schemas/RchtUpdateRspAttributes"}}},"RchtUpdateRspAttributes":{"title":"RchtUpdateRspAttributes","examples":[{"type":"RchtUpdateRspAttributes","updated":{"type":"RchtViewAttributes","reportChartId":"rcht_9f2Kd8QpLzXw","reportSpaceId":"rspc_9f2Kd8QpLzXw","title":"example","question":{"type":"RqryCmdRun","reportDatasetId":"abc123","measures":["example"],"dimensions":["example"],"time":{"type":"RqryTimeSliceAttributes","grain":"example","range":{"type":"RqryRangeBetween","from":"2026-08-19","to":"2026-08-19"},"compare":"PreviousPeriod"},"filters":[{"type":"RqryFilterAbove","dimension":"example","value":"example"}],"sort":[{"type":"RqrySortDimension","dimension":"example","ascending":true}],"limit":25,"page":"example","segments":["example"],"measureFilters":[{"type":"RqryMeasureFilterAbove","measure":"example","value":"example"}],"top":{"type":"RqryTopAttributes","dimension":"example","count":42,"measure":"example"},"narrowTo":{"type":"RqryNarrowCustomers","customerIds":["cust_9f2Kd8QpLzXw"]},"asAt":"2026-08-19T04:21:07Z","pivot":{"type":"RqryPivotAttributes","rows":["example"],"columns":["example"],"subtotals":true},"timezone":"example"},"presentation":{"type":"RchtPresentationAttributes","chartType":"Auto","colours":{"type":"RchtColoursAttributes","palette":"Categorical","overrides":[{"type":"RchtColourOverrideAttributes","series":"example","swatch":"example"}]},"description":"A short description.","riseIs":"Good","stackTotal":"example","referenceLines":[{"type":"RchtReferenceLineConstant","label":"example","value":"example"}],"table":{"type":"RchtTableAttributes","rowLink":"example","statuses":[{"type":"RchtStatusColumnAttributes","column":"example","tones":[{"type":"RchtValueToneAttributes","value":"example","tone":"Danger"}]}]}},"stale":"example","access":"Private","tenant":{"type":"RspcTenantEnterprise","enterpriseId":"ent_9f2Kd8QpLzXw"},"ownedByCaller":true,"editable":true,"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `RchtUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RchtUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/RchtView","description":"The resource as it stands after the change."}}},"RchtUpdateSetPresentation":{"title":"RchtUpdateSetPresentation","description":"Draw it another way.","examples":[{"type":"RchtUpdateSetPresentation","presentation":{"type":"RchtPresentationAttributes","chartType":"Auto","colours":{"type":"RchtColoursAttributes","palette":"Categorical","overrides":[{"type":"RchtColourOverrideAttributes","series":"example","swatch":"example"}]},"description":"A short description.","riseIs":"Good","stackTotal":"example","referenceLines":[{"type":"RchtReferenceLineConstant","label":"example","value":"example"}],"table":{"type":"RchtTableAttributes","rowLink":"example","statuses":[{"type":"RchtStatusColumnAttributes","column":"example","tones":[{"type":"RchtValueToneAttributes","value":"example","tone":"Danger"}]}]}}}],"type":"object","required":["type","presentation"],"properties":{"type":{"description":"Always `RchtUpdateSetPresentation`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RchtUpdateSetPresentation"]},"presentation":{"$ref":"#/components/schemas/RchtPresentation","description":"How a chart draws its answer. What it asks is its question."}}},"RchtValueTone":{"oneOf":[{"$ref":"#/components/schemas/RchtValueToneAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RchtValueToneAttributes":"#/components/schemas/RchtValueToneAttributes"}}},"RchtValueToneAttributes":{"title":"RchtValueToneAttributes","examples":[{"type":"RchtValueToneAttributes","value":"example","tone":"Danger"}],"type":"object","required":["type","value","tone"],"properties":{"type":{"description":"Always `RchtValueToneAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RchtValueToneAttributes"]},"value":{"description":"A value of the column, as its answer writes it.","type":"string"},"tone":{"$ref":"#/components/schemas/RchtTone"}}},"RchtView":{"oneOf":[{"$ref":"#/components/schemas/RchtViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RchtViewAttributes":"#/components/schemas/RchtViewAttributes"}}},"RchtViewAttributes":{"title":"RchtViewAttributes","description":"A saved question and how it is drawn. A dashboard's tiles show charts, and a change to a chart reaches every dashboard showing it.","examples":[{"type":"RchtViewAttributes","reportChartId":"rcht_9f2Kd8QpLzXw","reportSpaceId":"rspc_9f2Kd8QpLzXw","title":"example","question":{"type":"RqryCmdRun","reportDatasetId":"abc123","measures":["example"],"dimensions":["example"],"time":{"type":"RqryTimeSliceAttributes","grain":"example","range":{"type":"RqryRangeBetween","from":"2026-08-19","to":"2026-08-19"},"compare":"PreviousPeriod"},"filters":[{"type":"RqryFilterAbove","dimension":"example","value":"example"}],"sort":[{"type":"RqrySortDimension","dimension":"example","ascending":true}],"limit":25,"page":"example","segments":["example"],"measureFilters":[{"type":"RqryMeasureFilterAbove","measure":"example","value":"example"}],"top":{"type":"RqryTopAttributes","dimension":"example","count":42,"measure":"example"},"narrowTo":{"type":"RqryNarrowCustomers","customerIds":["cust_9f2Kd8QpLzXw"]},"asAt":"2026-08-19T04:21:07Z","pivot":{"type":"RqryPivotAttributes","rows":["example"],"columns":["example"],"subtotals":true},"timezone":"example"},"presentation":{"type":"RchtPresentationAttributes","chartType":"Auto","colours":{"type":"RchtColoursAttributes","palette":"Categorical","overrides":[{"type":"RchtColourOverrideAttributes","series":"example","swatch":"example"}]},"description":"A short description.","riseIs":"Good","stackTotal":"example","referenceLines":[{"type":"RchtReferenceLineConstant","label":"example","value":"example"}],"table":{"type":"RchtTableAttributes","rowLink":"example","statuses":[{"type":"RchtStatusColumnAttributes","column":"example","tones":[{"type":"RchtValueToneAttributes","value":"example","tone":"Danger"}]}]}},"stale":"example","access":"Private","tenant":{"type":"RspcTenantEnterprise","enterpriseId":"ent_9f2Kd8QpLzXw"},"ownedByCaller":true,"editable":true,"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","reportChartId","reportSpaceId","title","question","presentation","access","tenant","ownedByCaller","editable","createdAt","updatedAt"],"properties":{"type":{"description":"Always `RchtViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RchtViewAttributes"]},"reportChartId":{"$ref":"#/components/schemas/RchtId","description":"Identifier of a saved chart."},"reportSpaceId":{"$ref":"#/components/schemas/RspcId","description":"Identifier of a report space."},"title":{"type":"string"},"question":{"$ref":"#/components/schemas/RqryCmdRun"},"presentation":{"$ref":"#/components/schemas/RchtPresentation","description":"How a chart draws its answer. What it asks is its question."},"stale":{"description":"Present when the catalogue has moved under the question since it was saved, so asking it now would be refused: why, as the refusal would say. The chart is still read, and saving a new question clears it.","type":"string"},"access":{"$ref":"#/components/schemas/RspcAccess"},"tenant":{"$ref":"#/components/schemas/RspcTenant"},"ownedByCaller":{"type":"boolean"},"editable":{"description":"Whether the caller may change, move or delete it.","type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"RconvCmd":{"title":"RconvCmd","description":"A message to a conversation with Ask, in words.","examples":[{"prompt":"example","context":{"dashboardId":"abc123","tab":"example","proposal":{}}}],"type":"object","required":["prompt"],"properties":{"prompt":{"description":"The message, at most 2000 characters. The first message of a conversation is its title.","type":"string"},"context":{"$ref":"#/components/schemas/RaskContext"}}},"RconvEvent":{"description":"One server-sent event of a message: `message` first, then `text` and `progress`, then a `proposal` or an `error`, then `done`.","oneOf":[{"$ref":"#/components/schemas/RconvEventDone"},{"$ref":"#/components/schemas/RconvEventError"},{"$ref":"#/components/schemas/RconvEventMessage"},{"$ref":"#/components/schemas/RconvEventProgress"},{"$ref":"#/components/schemas/RconvEventProposal"},{"$ref":"#/components/schemas/RconvEventText"}],"discriminator":{"propertyName":"event","mapping":{"done":"#/components/schemas/RconvEventDone","error":"#/components/schemas/RconvEventError","message":"#/components/schemas/RconvEventMessage","progress":"#/components/schemas/RconvEventProgress","proposal":"#/components/schemas/RconvEventProposal","text":"#/components/schemas/RconvEventText"}}},"RconvEventDone":{"title":"RconvEventDone","description":"Always last.","examples":[{"event":"done","data":{"usage":{"inputTokens":1250,"outputTokens":1250}}}],"type":"object","required":["event","data"],"properties":{"event":{"description":"Always `done`: the frame's `event:` line.","type":"string","enum":["done"]},"data":{"$ref":"#/components/schemas/RaskEventDoneData"}}},"RconvEventError":{"title":"RconvEventError","description":"The message ended without an answer.","examples":[{"event":"error","data":{"message":"example","retryable":true}}],"type":"object","required":["event","data"],"properties":{"event":{"description":"Always `error`: the frame's `event:` line.","type":"string","enum":["error"]},"data":{"$ref":"#/components/schemas/RaskEventErrorData"}}},"RconvEventMessage":{"title":"RconvEventMessage","description":"The conversation and the message being answered. Always first.","examples":[{"event":"message","data":{"reportConversationId":"rconv_9f2Kd8QpLzXw","reportConversationMessageId":"rcmsg_9f2Kd8QpLzXw"}}],"type":"object","required":["event","data"],"properties":{"event":{"description":"Always `message`: the frame's `event:` line.","type":"string","enum":["message"]},"data":{"$ref":"#/components/schemas/RconvEventMessageData"}}},"RconvEventMessageData":{"title":"RconvEventMessageData","description":"The message has been taken. Always first, so the dashboard learns a new conversation's id.","examples":[{"reportConversationId":"rconv_9f2Kd8QpLzXw","reportConversationMessageId":"rcmsg_9f2Kd8QpLzXw"}],"type":"object","required":["reportConversationId","reportConversationMessageId"],"properties":{"reportConversationId":{"$ref":"#/components/schemas/RconvId"},"reportConversationMessageId":{"$ref":"#/components/schemas/RconvMessageId"}}},"RconvEventProgress":{"title":"RconvEventProgress","description":"While the agent reads and asks. Any number of them.","examples":[{"event":"progress","data":{"text":"example"}}],"type":"object","required":["event","data"],"properties":{"event":{"description":"Always `progress`: the frame's `event:` line.","type":"string","enum":["progress"]},"data":{"$ref":"#/components/schemas/RaskEventProgressData"}}},"RconvEventProposal":{"title":"RconvEventProposal","description":"A proposal or a question back. At most one.","examples":[{"event":"proposal","data":{"kind":"proposal","text":"example","proposal":{"kind":"questions","questions":[{"type":"RqryCmdRun","reportDatasetId":"abc123","measures":["example"],"dimensions":["example"],"time":{"type":"RqryTimeSliceAttributes","grain":"example","range":{"type":"RqryRangeBetween","from":"2026-08-19","to":"2026-08-19"},"compare":"PreviousPeriod"},"filters":[{"type":"RqryFilterAbove","dimension":"example","value":"example"}],"sort":[{"type":"RqrySortDimension","dimension":"example","ascending":true}],"limit":25,"page":"example","segments":["example"],"measureFilters":[{"type":"RqryMeasureFilterAbove","measure":"example","value":"example"}],"top":{"type":"RqryTopAttributes","dimension":"example","count":42,"measure":"example"},"narrowTo":{"type":"RqryNarrowCustomers","customerIds":["cust_9f2Kd8QpLzXw"]},"asAt":"2026-08-19T04:21:07Z","pivot":{"type":"RqryPivotAttributes","rows":["example"],"columns":["example"],"subtotals":true},"timezone":"example"}],"chart":{"title":"example","chartType":"auto"},"dashboard":{"title":"example","tiles":[{"chart":{"title":"example","chartType":"auto"},"x":1250,"y":1250,"w":1250,"h":1250}]},"explanation":"example"},"suggestions":["example"]}}],"type":"object","required":["event","data"],"properties":{"event":{"description":"Always `proposal`: the frame's `event:` line.","type":"string","enum":["proposal"]},"data":{"$ref":"#/components/schemas/RconvEventProposalData"}}},"RconvEventProposalData":{"title":"RconvEventProposalData","description":"How the message was answered, when it is more than words: `proposal` carries a single Ask's proposal, and `clarify` asks the person a question back with suggested replies.","examples":[{"kind":"proposal","text":"example","proposal":{"kind":"questions","questions":[{"type":"RqryCmdRun","reportDatasetId":"abc123","measures":["example"],"dimensions":["example"],"time":{"type":"RqryTimeSliceAttributes","grain":"example","range":{"type":"RqryRangeBetween","from":"2026-08-19","to":"2026-08-19"},"compare":"PreviousPeriod"},"filters":[{"type":"RqryFilterAbove","dimension":"example","value":"example"}],"sort":[{"type":"RqrySortDimension","dimension":"example","ascending":true}],"limit":25,"page":"example","segments":["example"],"measureFilters":[{"type":"RqryMeasureFilterAbove","measure":"example","value":"example"}],"top":{"type":"RqryTopAttributes","dimension":"example","count":42,"measure":"example"},"narrowTo":{"type":"RqryNarrowCustomers","customerIds":["cust_9f2Kd8QpLzXw"]},"asAt":"2026-08-19T04:21:07Z","pivot":{"type":"RqryPivotAttributes","rows":["example"],"columns":["example"],"subtotals":true},"timezone":"example"}],"chart":{"title":"example","chartType":"auto"},"dashboard":{"title":"example","tiles":[{"chart":{"title":"example","chartType":"auto"},"x":1250,"y":1250,"w":1250,"h":1250}]},"explanation":"example"},"suggestions":["example"]}],"type":"object","required":["kind"],"properties":{"kind":{"$ref":"#/components/schemas/RconvReplyKind"},"text":{"description":"For `clarify` and `answer`: the words. Absent for `proposal`.","type":"string"},"proposal":{"$ref":"#/components/schemas/RaskEventProposalData","description":"For `proposal`: the proposal, as a single Ask's `proposal` event carries it. Absent otherwise."},"suggestions":{"description":"For `clarify`: up to four suggested replies, `[]` when there are none. Absent otherwise.","type":"array","items":{"type":"string"}}}},"RconvEventText":{"title":"RconvEventText","description":"The model's words. Any number of them.","examples":[{"event":"text","data":{"text":"example"}}],"type":"object","required":["event","data"],"properties":{"event":{"description":"Always `text`: the frame's `event:` line.","type":"string","enum":["text"]},"data":{"$ref":"#/components/schemas/RconvEventTextData"}}},"RconvEventTextData":{"title":"RconvEventTextData","description":"The model's words, as it writes them.","examples":[{"text":"example"}],"type":"object","required":["text"],"properties":{"text":{"type":"string"}}},"RconvId":{"title":"RconvId","description":"Identifier of one of the caller's conversations with Ask.","examples":["rconv_9f2Kd8QpLzXw"],"type":"string"},"RconvMessageId":{"title":"RconvMessageId","description":"Identifier of a message in a conversation with Ask.","examples":["rcmsg_9f2Kd8QpLzXw"],"type":"string"},"RconvMessageStatus":{"title":"RconvMessageStatus","description":"`Answering` while it is answered, then `Answered` or `Failed`.","type":"string","enum":["Answering","Answered","Failed","Unknown"]},"RconvPage":{"title":"RconvPage","description":"A page of the caller's conversations, most recently active first. Pass `nextStartingAfter` back as `startingAfter` for the next.","examples":[{"data":[{"reportConversationId":"rconv_9f2Kd8QpLzXw","title":"example","createdAt":"2026-08-19T04:21:07Z","lastActiveAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"rconv_9f2Kd8QpLzXw"}],"type":"object","required":["data","hasMore"],"properties":{"data":{"description":"The conversations on this page, `[]` when there are none.","type":"array","items":{"$ref":"#/components/schemas/RconvViewSummary"}},"hasMore":{"type":"boolean"},"nextStartingAfter":{"$ref":"#/components/schemas/RconvId"}}},"RconvReply":{"description":"How it was answered. Absent unless it was.","oneOf":[{"$ref":"#/components/schemas/RconvReplyAnswer"},{"$ref":"#/components/schemas/RconvReplyClarify"},{"$ref":"#/components/schemas/RconvReplyProposal"}],"discriminator":{"propertyName":"type","mapping":{"RconvReplyAnswer":"#/components/schemas/RconvReplyAnswer","RconvReplyClarify":"#/components/schemas/RconvReplyClarify","RconvReplyProposal":"#/components/schemas/RconvReplyProposal"}}},"RconvReplyAnswer":{"title":"RconvReplyAnswer","description":"Words alone, for a message that needs no figures.","examples":[{"type":"RconvReplyAnswer","text":"example"}],"type":"object","required":["type","text"],"properties":{"type":{"description":"Always `RconvReplyAnswer`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RconvReplyAnswer"]},"text":{"description":"What the model wrote.","type":"string"}}},"RconvReplyClarify":{"title":"RconvReplyClarify","description":"A question back to the person, with up to four suggested replies.","examples":[{"type":"RconvReplyClarify","text":"example","suggestions":["example"]}],"type":"object","required":["type","text","suggestions"],"properties":{"type":{"description":"Always `RconvReplyClarify`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RconvReplyClarify"]},"text":{"description":"The question.","type":"string"},"suggestions":{"description":"Up to four replies the person can pick, `[]` when there are none.","type":"array","items":{"type":"string"}}}},"RconvReplyKind":{"title":"RconvReplyKind","type":"string","enum":["proposal","clarify","answer"]},"RconvReplyProposal":{"title":"RconvReplyProposal","description":"A proposal and what it shows. The proposal is a single Ask's `proposal` event: questions to ask, a chart drawing one, or a dashboard. Its figures come from asking its questions, never from the text.","examples":[{"type":"RconvReplyProposal","text":"example","proposal":{"kind":"questions","questions":[{"type":"RqryCmdRun","reportDatasetId":"abc123","measures":["example"],"dimensions":["example"],"time":{"type":"RqryTimeSliceAttributes","grain":"example","range":{"type":"RqryRangeBetween","from":"2026-08-19","to":"2026-08-19"},"compare":"PreviousPeriod"},"filters":[{"type":"RqryFilterAbove","dimension":"example","value":"example"}],"sort":[{"type":"RqrySortDimension","dimension":"example","ascending":true}],"limit":25,"page":"example","segments":["example"],"measureFilters":[{"type":"RqryMeasureFilterAbove","measure":"example","value":"example"}],"top":{"type":"RqryTopAttributes","dimension":"example","count":42,"measure":"example"},"narrowTo":{"type":"RqryNarrowCustomers","customerIds":["cust_9f2Kd8QpLzXw"]},"asAt":"2026-08-19T04:21:07Z","pivot":{"type":"RqryPivotAttributes","rows":["example"],"columns":["example"],"subtotals":true},"timezone":"example"}],"chart":{"title":"example","chartType":"auto"},"dashboard":{"title":"example","tiles":[{"chart":{"title":"example","chartType":"auto"},"x":1250,"y":1250,"w":1250,"h":1250}]},"explanation":"example"}}],"type":"object","required":["type","text","proposal"],"properties":{"type":{"description":"Always `RconvReplyProposal`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RconvReplyProposal"]},"text":{"description":"What the model wrote with it.","type":"string"},"proposal":{"$ref":"#/components/schemas/RaskEventProposalData","description":"Questions to ask, a chart drawing one, or a dashboard laid out from several, which nothing saves. Its figures come from asking its questions."}}},"RconvUsage":{"title":"RconvUsage","description":"What answering a message spent.","examples":[{"inputTokens":1250,"outputTokens":1250}],"type":"object","required":["inputTokens","outputTokens"],"properties":{"inputTokens":{"description":"Tokens the model read.","type":"integer","format":"int64"},"outputTokens":{"description":"Tokens the model wrote.","type":"integer","format":"int64"}}},"RconvView":{"title":"RconvView","description":"One of the caller's conversations with Ask and its messages, in order.","examples":[{"reportConversationId":"rconv_9f2Kd8QpLzXw","title":"example","createdAt":"2026-08-19T04:21:07Z","lastActiveAt":"2026-08-19T04:21:07Z","messages":[{"reportConversationMessageId":"rcmsg_9f2Kd8QpLzXw","index":1250,"status":"Answering","prompt":"example","reply":{"type":"RconvReplyAnswer","text":"example"},"failure":"example","usage":{"inputTokens":1250,"outputTokens":1250},"createdAt":"2026-08-19T04:21:07Z","endedAt":"2026-08-19T04:21:07Z"}]}],"type":"object","required":["reportConversationId","title","createdAt","lastActiveAt","messages"],"properties":{"reportConversationId":{"$ref":"#/components/schemas/RconvId"},"title":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"lastActiveAt":{"type":"string","format":"date-time"},"messages":{"description":"Its messages in order, `[]` when it has none.","type":"array","items":{"$ref":"#/components/schemas/RconvViewMessage"}}}},"RconvViewMessage":{"title":"RconvViewMessage","description":"A message in a conversation and how it was answered.","examples":[{"reportConversationMessageId":"rcmsg_9f2Kd8QpLzXw","index":1250,"status":"Answering","prompt":"example","reply":{"type":"RconvReplyAnswer","text":"example"},"failure":"example","usage":{"inputTokens":1250,"outputTokens":1250},"createdAt":"2026-08-19T04:21:07Z","endedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["reportConversationMessageId","index","status","prompt","usage","createdAt"],"properties":{"reportConversationMessageId":{"$ref":"#/components/schemas/RconvMessageId"},"index":{"description":"Its position in the conversation, from 0.","type":"integer","format":"int32"},"status":{"$ref":"#/components/schemas/RconvMessageStatus"},"prompt":{"description":"What the person wrote.","type":"string"},"reply":{"$ref":"#/components/schemas/RconvReply"},"failure":{"description":"Why it ended without an answer. Absent unless it failed.","type":"string"},"usage":{"$ref":"#/components/schemas/RconvUsage"},"createdAt":{"description":"When it was sent.","type":"string","format":"date-time"},"endedAt":{"description":"When it was answered or failed. Absent while it is answered.","type":"string","format":"date-time"}}},"RconvViewSummary":{"title":"RconvViewSummary","description":"One of the caller's conversations with Ask. It is the caller's alone, and kept 90 days after its last message.","examples":[{"reportConversationId":"rconv_9f2Kd8QpLzXw","title":"example","createdAt":"2026-08-19T04:21:07Z","lastActiveAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["reportConversationId","title","createdAt","lastActiveAt"],"properties":{"reportConversationId":{"$ref":"#/components/schemas/RconvId"},"title":{"description":"The first message, on one line.","type":"string"},"createdAt":{"type":"string","format":"date-time"},"lastActiveAt":{"type":"string","format":"date-time"}}},"RdecArgument":{"description":"An argument an action took when a rule fired it.","oneOf":[{"$ref":"#/components/schemas/RdecArgumentAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RdecArgumentAttributes":"#/components/schemas/RdecArgumentAttributes"}}},"RdecArgumentAttributes":{"title":"RdecArgumentAttributes","description":"An argument an action took when a rule fired it.","examples":[{"type":"RdecArgumentAttributes","argument":"example","sensitivity":"Plain","value":{"type":"RdecValueAbsent"}}],"type":"object","required":["type","argument","sensitivity","value"],"properties":{"type":{"description":"Always `RdecArgumentAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdecArgumentAttributes"]},"argument":{"type":"string"},"sensitivity":{"$ref":"#/components/schemas/RareaSensitivity"},"value":{"$ref":"#/components/schemas/RdecValue"}}},"RdecColumn":{"title":"RdecColumn","type":"string","enum":["RuleDecisionId","Domain","SnapshotVersion","TargetId","TargetVersion","Outcome","DecidedAt"]},"RdecId":{"title":"RdecId","description":"Identifier of a rule decision.","examples":["rdec_9f2Kd8QpLzXw"],"type":"string"},"RdecInput":{"description":"A field the evaluation read, as it was, or withheld where it is sensitive.","oneOf":[{"$ref":"#/components/schemas/RdecInputAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RdecInputAttributes":"#/components/schemas/RdecInputAttributes"}}},"RdecInputAttributes":{"title":"RdecInputAttributes","description":"A field the evaluation read, as it was, or withheld where it is sensitive.","examples":[{"type":"RdecInputAttributes","field":"example","sensitivity":"Plain","value":{"type":"RdecValueAbsent"}}],"type":"object","required":["type","field","sensitivity","value"],"properties":{"type":{"description":"Always `RdecInputAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdecInputAttributes"]},"field":{"type":"string"},"sensitivity":{"$ref":"#/components/schemas/RareaSensitivity"},"value":{"$ref":"#/components/schemas/RdecValue"}}},"RdecList":{"description":"A named list a decision read, at the version it was read at.","oneOf":[{"$ref":"#/components/schemas/RdecListAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RdecListAttributes":"#/components/schemas/RdecListAttributes"}}},"RdecListAttributes":{"title":"RdecListAttributes","description":"A named list a decision read, at the version it was read at.","examples":[{"type":"RdecListAttributes","namedListId":"nlst_9f2Kd8QpLzXw","version":1250}],"type":"object","required":["type","namedListId","version"],"properties":{"type":{"description":"Always `RdecListAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdecListAttributes"]},"namedListId":{"$ref":"#/components/schemas/NlstId"},"version":{"type":"integer","format":"int32"}}},"RdecOutcome":{"title":"RdecOutcome","type":"string","enum":["NoMatch","Matched","ShadowOnly","Failed","Unknown"]},"RdecPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/RdecPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RdecPageAttributes":"#/components/schemas/RdecPageAttributes"}}},"RdecPageAttributes":{"title":"RdecPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"RdecPageAttributes","data":[{"type":"RdecViewAttributes","ruleDecisionId":"rdec_9f2Kd8QpLzXw","domain":"example","owner":{"type":"RpolOwnerEnterprise","enterpriseId":"ent_9f2Kd8QpLzXw"},"snapshotVersion":1250,"targetId":"abc123","targetVersion":1250,"matchedRuleIds":["rpol_9f2Kd8QpLzXw"],"shadowRuleIds":["rpol_9f2Kd8QpLzXw"],"namedLists":[{"type":"RdecListAttributes","namedListId":"nlst_9f2Kd8QpLzXw","version":1250}],"outcome":"NoMatch","decidedAt":"2026-08-19T04:21:07Z","inputs":[{"type":"RdecInputAttributes","field":"example","sensitivity":"Plain","value":{"type":"RdecValueAbsent"}}],"results":[{"type":"RdecResultAttributes","rulePolicyId":"rpol_9f2Kd8QpLzXw","ruleVersion":1250,"templateId":"abc123","templateVersion":1250,"mode":"Shadow","matched":true,"action":"example","arguments":[{"type":"RdecArgumentAttributes","argument":"example","sensitivity":"Plain","value":{"type":"RdecValueAbsent"}}]}]}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `RdecPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdecPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/RdecView"}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"RdecResult":{"description":"What one rule did in a decision: the version of the policy it was, whether it matched and, for each action it fired, a result of its own.","oneOf":[{"$ref":"#/components/schemas/RdecResultAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RdecResultAttributes":"#/components/schemas/RdecResultAttributes"}}},"RdecResultAttributes":{"title":"RdecResultAttributes","description":"What one rule did in a decision: the version of the policy it was, whether it matched and, for each action it fired, a result of its own.","examples":[{"type":"RdecResultAttributes","rulePolicyId":"rpol_9f2Kd8QpLzXw","ruleVersion":1250,"templateId":"abc123","templateVersion":1250,"mode":"Shadow","matched":true,"action":"example","arguments":[{"type":"RdecArgumentAttributes","argument":"example","sensitivity":"Plain","value":{"type":"RdecValueAbsent"}}]}],"type":"object","required":["type","rulePolicyId","ruleVersion","templateId","templateVersion","mode","matched"],"properties":{"type":{"description":"Always `RdecResultAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdecResultAttributes"]},"rulePolicyId":{"$ref":"#/components/schemas/RpolId"},"ruleVersion":{"description":"The version of the policy the rule was evaluated at.","type":"integer","format":"int32"},"templateId":{"type":"string"},"templateVersion":{"description":"The version of the template the rule was evaluated by.","type":"integer","format":"int32"},"mode":{"$ref":"#/components/schemas/RpolMode"},"matched":{"type":"boolean"},"action":{"description":"The action the rule fired. Absent for a rule that fired none.","type":"string"},"arguments":{"type":"array","items":{"$ref":"#/components/schemas/RdecArgument"}}}},"RdecValue":{"oneOf":[{"$ref":"#/components/schemas/RdecValueAbsent"},{"$ref":"#/components/schemas/RdecValueAmount"},{"$ref":"#/components/schemas/RdecValueFlag"},{"$ref":"#/components/schemas/RdecValueMoment"},{"$ref":"#/components/schemas/RdecValueNumber"},{"$ref":"#/components/schemas/RdecValuePercent"},{"$ref":"#/components/schemas/RdecValueShown"},{"$ref":"#/components/schemas/RdecValueText"},{"$ref":"#/components/schemas/RdecValueWithheld"}],"discriminator":{"propertyName":"type","mapping":{"RdecValueAbsent":"#/components/schemas/RdecValueAbsent","RdecValueAmount":"#/components/schemas/RdecValueAmount","RdecValueFlag":"#/components/schemas/RdecValueFlag","RdecValueMoment":"#/components/schemas/RdecValueMoment","RdecValueNumber":"#/components/schemas/RdecValueNumber","RdecValuePercent":"#/components/schemas/RdecValuePercent","RdecValueShown":"#/components/schemas/RdecValueShown","RdecValueText":"#/components/schemas/RdecValueText","RdecValueWithheld":"#/components/schemas/RdecValueWithheld"}}},"RdecValueAbsent":{"title":"RdecValueAbsent","description":"A field the evaluation found no value for.","examples":[{"type":"RdecValueAbsent"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `RdecValueAbsent`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdecValueAbsent"]}}},"RdecValueAmount":{"title":"RdecValueAmount","description":"A value a decision's record holds. A value the area marks sensitive is withheld, its name and kind kept and its value never.","examples":[{"type":"RdecValueAmount","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"}}],"type":"object","required":["type","amount"],"properties":{"type":{"description":"Always `RdecValueAmount`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdecValueAmount"]},"amount":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"An amount in minor current units of a given currency."}}},"RdecValueFlag":{"title":"RdecValueFlag","description":"A value a decision's record holds. A value the area marks sensitive is withheld, its name and kind kept and its value never.","examples":[{"type":"RdecValueFlag","flag":true}],"type":"object","required":["type","flag"],"properties":{"type":{"description":"Always `RdecValueFlag`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdecValueFlag"]},"flag":{"type":"boolean"}}},"RdecValueMoment":{"title":"RdecValueMoment","description":"A value a decision's record holds. A value the area marks sensitive is withheld, its name and kind kept and its value never.","examples":[{"type":"RdecValueMoment","moment":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","moment"],"properties":{"type":{"description":"Always `RdecValueMoment`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdecValueMoment"]},"moment":{"type":"string","format":"date-time"}}},"RdecValueNumber":{"title":"RdecValueNumber","description":"A value a decision's record holds. A value the area marks sensitive is withheld, its name and kind kept and its value never.","examples":[{"type":"RdecValueNumber","number":12.5}],"type":"object","required":["type","number"],"properties":{"type":{"description":"Always `RdecValueNumber`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdecValueNumber"]},"number":{"type":"number"}}},"RdecValuePercent":{"title":"RdecValuePercent","description":"A value a decision's record holds. A value the area marks sensitive is withheld, its name and kind kept and its value never.","examples":[{"type":"RdecValuePercent","percent":12.5}],"type":"object","required":["type","percent"],"properties":{"type":{"description":"Always `RdecValuePercent`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdecValuePercent"]},"percent":{"type":"number"}}},"RdecValueShown":{"title":"RdecValueShown","description":"A list, a range or a window, as the engine shows it.","examples":[{"type":"RdecValueShown","shown":"example"}],"type":"object","required":["type","shown"],"properties":{"type":{"description":"Always `RdecValueShown`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdecValueShown"]},"shown":{"type":"string"}}},"RdecValueText":{"title":"RdecValueText","description":"A value a decision's record holds. A value the area marks sensitive is withheld, its name and kind kept and its value never.","examples":[{"type":"RdecValueText","text":"example"}],"type":"object","required":["type","text"],"properties":{"type":{"description":"Always `RdecValueText`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdecValueText"]},"text":{"type":"string"}}},"RdecValueWithheld":{"title":"RdecValueWithheld","description":"A value that is sensitive, so the record does not hold it.","examples":[{"type":"RdecValueWithheld"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `RdecValueWithheld`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdecValueWithheld"]}}},"RdecView":{"description":"The evidence of one evaluation: a target's version evaluated against a ruleset, the fields it read and what each rule did. It is written once, and an evaluation repeated writes nothing. The tenant that owns it reads it, as do the tenants above it.","oneOf":[{"$ref":"#/components/schemas/RdecViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RdecViewAttributes":"#/components/schemas/RdecViewAttributes"}}},"RdecViewAttributes":{"title":"RdecViewAttributes","description":"The evidence of one evaluation: a target's version evaluated against a ruleset, the fields it read and what each rule did. It is written once, and an evaluation repeated writes nothing. The tenant that owns it reads it, as do the tenants above it.","examples":[{"type":"RdecViewAttributes","ruleDecisionId":"rdec_9f2Kd8QpLzXw","domain":"example","owner":{"type":"RpolOwnerEnterprise","enterpriseId":"ent_9f2Kd8QpLzXw"},"snapshotVersion":1250,"targetId":"abc123","targetVersion":1250,"matchedRuleIds":["rpol_9f2Kd8QpLzXw"],"shadowRuleIds":["rpol_9f2Kd8QpLzXw"],"namedLists":[{"type":"RdecListAttributes","namedListId":"nlst_9f2Kd8QpLzXw","version":1250}],"outcome":"NoMatch","decidedAt":"2026-08-19T04:21:07Z","inputs":[{"type":"RdecInputAttributes","field":"example","sensitivity":"Plain","value":{"type":"RdecValueAbsent"}}],"results":[{"type":"RdecResultAttributes","rulePolicyId":"rpol_9f2Kd8QpLzXw","ruleVersion":1250,"templateId":"abc123","templateVersion":1250,"mode":"Shadow","matched":true,"action":"example","arguments":[{"type":"RdecArgumentAttributes","argument":"example","sensitivity":"Plain","value":{"type":"RdecValueAbsent"}}]}]}],"type":"object","required":["type","ruleDecisionId","domain","owner","snapshotVersion","targetId","targetVersion","outcome","decidedAt"],"properties":{"type":{"description":"Always `RdecViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdecViewAttributes"]},"ruleDecisionId":{"$ref":"#/components/schemas/RdecId"},"domain":{"description":"The area whose ruleset was evaluated.","type":"string"},"owner":{"$ref":"#/components/schemas/RpolOwner"},"snapshotVersion":{"description":"The version of the ruleset the target was evaluated against.","type":"integer","format":"int32"},"targetId":{"description":"What was evaluated, by its id without the prefix, as 24 hexadecimal characters.","type":"string"},"targetVersion":{"description":"The version of the target that was evaluated.","type":"integer","format":"int64"},"matchedRuleIds":{"type":"array","items":{"$ref":"#/components/schemas/RpolId"}},"shadowRuleIds":{"description":"The shadow rules that matched.","type":"array","items":{"$ref":"#/components/schemas/RpolId"}},"namedLists":{"type":"array","items":{"$ref":"#/components/schemas/RdecList"}},"outcome":{"$ref":"#/components/schemas/RdecOutcome"},"decidedAt":{"type":"string","format":"date-time"},"inputs":{"type":"array","items":{"$ref":"#/components/schemas/RdecInput"}},"results":{"type":"array","items":{"$ref":"#/components/schemas/RdecResult"}}}},"Rdset":{"description":"A dataset a report can be asked of: what it can be grouped by, what it adds up, and over what time grains.","oneOf":[{"$ref":"#/components/schemas/RdsetAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RdsetAttributes":"#/components/schemas/RdsetAttributes"}}},"RdsetAttributes":{"title":"RdsetAttributes","description":"A dataset a report can be asked of: what it can be grouped by, what it adds up, and over what time grains.","examples":[{"type":"RdsetAttributes","reportDatasetId":"abc123","domain":"example","label":"example","description":"A short description.","grains":[{"type":"RdsetGrainAttributes","name":"Ada Lovelace","label":"example","rules":[{"type":"RdsetRuleAggregateLimit","max":1250}]}],"defaultGrain":"example","dimensions":[{"type":"RdsetDimensionAttributes","name":"Ada Lovelace","label":"example","description":"A short description.","summary":"example","kind":"Text","lookup":"OwnValues","values":{"type":"RdsetValuesEntered","reason":"Requested by the customer."},"drillsTo":"example","matchesText":true,"group":"example","rules":[{"type":"RdsetRuleAggregateLimit","max":1250}],"operators":["Equals"],"identifies":"Enterprise","bands":[{"type":"RdsetStatusOutcomeAttributes","label":"example","tone":"Danger"}],"currencyDimension":"AUD"}],"measures":[{"type":"RdsetMeasureAttributes","name":"Ada Lovelace","label":"example","description":"A short description.","summary":"example","format":"Money","currencyDimension":"AUD","currency":"AUD","decimals":1250,"additivity":"Additive","target":{"type":"RdsetTargetBands","label":"example","bands":[{"type":"RdsetTargetBandAttributes","label":"example","from":"example","until":"example"}]},"group":"example","rules":[{"type":"RdsetRuleAggregateLimit","max":1250}],"riseIs":"Good"}],"rowColumns":["example"],"suggestedCharts":["BigNumber"],"segments":[{"type":"RdsetSegmentAttributes","name":"Ada Lovelace","label":"example","description":"A short description."}],"periods":[{"type":"RdsetPeriodAttributes","name":"Ada Lovelace","label":"example","description":"A short description."}],"timezone":"example","rules":[{"type":"RdsetRuleAggregateLimit","max":1250}],"statuses":[{"type":"RdsetStatusAttributes","name":"Ada Lovelace","label":"example","description":"A short description.","measures":["example"],"rules":[{"type":"RdsetStatusRuleAttributes","label":"example","tone":"Danger","tests":[{"type":"RdsetStatusTestAttributes","measure":"example","comparison":"Above","value":"example","passesAbsent":true}]}],"otherwise":{"type":"RdsetStatusOutcomeAttributes","label":"example","tone":"Danger"}}]}],"type":"object","required":["type","reportDatasetId","domain","label","description","timezone"],"properties":{"type":{"description":"Always `RdsetAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetAttributes"]},"reportDatasetId":{"description":"The dataset's name, which is also its id.","type":"string"},"domain":{"description":"The subject area the dataset belongs to.","type":"string"},"label":{"type":"string"},"description":{"type":"string"},"grains":{"description":"The time grains a query may bucket by. Empty for a dataset with no time dimension.","type":"array","items":{"$ref":"#/components/schemas/RdsetGrain"}},"defaultGrain":{"description":"The grain a client uses when the person has not chosen one.","type":"string"},"dimensions":{"description":"Only the dimensions this caller may see.","type":"array","items":{"$ref":"#/components/schemas/RdsetDimension"}},"measures":{"type":"array","items":{"$ref":"#/components/schemas/RdsetMeasure"}},"rowColumns":{"description":"The columns a query with no measures returns, one row per record. Empty when the dataset has no row mode.","type":"array","items":{"type":"string"}},"suggestedCharts":{"type":"array","items":{"$ref":"#/components/schemas/RdsetChart"}},"segments":{"description":"Named filters a question can apply by name, in `segments`.","type":"array","items":{"$ref":"#/components/schemas/RdsetSegment"}},"periods":{"description":"The kinds of custom period the dataset is asked by, named in an `RqryRangePeriod` with the period's own bounds.","type":"array","items":{"$ref":"#/components/schemas/RdsetPeriod"}},"timezone":{"description":"The timezone this caller's questions are answered in when they name none, an IANA name or an offset: the timezone every active merchant the caller reads keeps, or the dataset's where they keep several. It is the default over the caller's own scope; a question narrowed with `narrowTo` takes the default of the tenants it narrows to, which may differ. A question's `timezone` overrides it.","type":"string"},"rules":{"description":"The rules every question of this dataset is held to. Each dimension, measure and grain carries the rules a question naming it is held to.","type":"array","items":{"$ref":"#/components/schemas/RdsetRule"}},"statuses":{"description":"What a row of an answer is, read from several of its measures, such as a customer's credit status. An answer carries a `RowStatus` column for each status whose every measure the question asks. Only the statuses this caller may read every measure of are listed.","type":"array","items":{"$ref":"#/components/schemas/RdsetStatus"}}}},"RdsetChart":{"title":"RdsetChart","type":"string","enum":["BigNumber","TimeSeries","Bar","Pie","Table","Unknown"]},"RdsetColumn":{"title":"RdsetColumn","type":"string","enum":["ReportDatasetId","Domain","Label","Description","DefaultGrain","Timezone"]},"RdsetDatePart":{"title":"RdsetDatePart","description":"For a number that is a part of the time, which part, so a client reads a value as its label (`is March`, `is Monday`) rather than comparing a figure. Absent for any other set.","type":"string","enum":["HourOfDay","DayOfWeek","DayOfMonth","MonthOfYear","Unknown"]},"RdsetDimension":{"description":"Something a report can be grouped or filtered by.","oneOf":[{"$ref":"#/components/schemas/RdsetDimensionAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RdsetDimensionAttributes":"#/components/schemas/RdsetDimensionAttributes"}}},"RdsetDimensionAttributes":{"title":"RdsetDimensionAttributes","description":"Something a report can be grouped or filtered by.","examples":[{"type":"RdsetDimensionAttributes","name":"Ada Lovelace","label":"example","description":"A short description.","summary":"example","kind":"Text","lookup":"OwnValues","values":{"type":"RdsetValuesEntered","reason":"Requested by the customer."},"drillsTo":"example","matchesText":true,"group":"example","rules":[{"type":"RdsetRuleAggregateLimit","max":1250}],"operators":["Equals"],"identifies":"Enterprise","bands":[{"type":"RdsetStatusOutcomeAttributes","label":"example","tone":"Danger"}],"currencyDimension":"AUD"}],"type":"object","required":["type","name","label","description","summary","kind","lookup","values","matchesText","group"],"properties":{"type":{"description":"Always `RdsetDimensionAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetDimensionAttributes"]},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"},"summary":{"description":"The description cut to a few words, at most 50 characters, for a client to show on one line where the description would not fit.","type":"string"},"kind":{"$ref":"#/components/schemas/RdsetDimensionKind"},"lookup":{"$ref":"#/components/schemas/RdsetLookup"},"values":{"$ref":"#/components/schemas/RdsetValues"},"drillsTo":{"description":"For a tenancy level, `enterprise`, `marketplace`, `merchant` or `customer`, the dimension of the level beneath it, to drill into. Absent for the lowest level and for every other dimension.","type":"string"},"matchesText":{"description":"Whether an `RqryFilterContains` may search it for part of its text.","type":"boolean"},"group":{"description":"The heading a client files it under beside the dataset's other dimensions, such as `Tenancy`, `Time` or `Bands`.","type":"string"},"rules":{"description":"The rules a question grouping or filtering by it is held to.","type":"array","items":{"$ref":"#/components/schemas/RdsetRule"}},"operators":{"description":"The filters it takes, each naming the `RqryFilter` subtype of that name. A number or a date is compared and ranged, text a person reads is searched, and anything filterable is matched by its values. Empty for a dimension that cannot be filtered on.","type":"array","items":{"$ref":"#/components/schemas/RdsetFilterOperator"}},"identifies":{"$ref":"#/components/schemas/RdsetEntityKind"},"bands":{"description":"For a band, its values in the order the bands climb, each with the tone a figure in it reads in, so a client colours a band by what it means rather than by its place. Empty for any other dimension.","type":"array","items":{"$ref":"#/components/schemas/RdsetStatusOutcome"}},"currencyDimension":{"description":"For an amount of money, the dimension holding its currency on the same row, as a `Money` measure's `currencyDimension` does. A question lists it beside the amount for its answer to carry the currency. Absent for any other dimension.","type":"string"}}},"RdsetDimensionKind":{"title":"RdsetDimensionKind","type":"string","enum":["Text","Enum","Id","Date","Number","Currency","Unknown"]},"RdsetEntityKind":{"title":"RdsetEntityKind","description":"The record its values are the ids of, so a client links each value to that record through one mapping of kinds to pages. Absent for a dimension whose values identify nothing to open, a name or a row key among them.","type":"string","enum":["Enterprise","Marketplace","Merchant","Customer","Payment","Loan","LoanStatement","LoanTransaction","LoanFacility","IssuerTransaction","Card","Ledger","LedgerEntry","Invoice","Unknown"]},"RdsetFilterOperator":{"title":"RdsetFilterOperator","type":"string","enum":["Equals","In","NotEquals","NotIn","Between","Absent","Contains","Above","AtLeast","Below","AtMost","Unknown"]},"RdsetGrain":{"oneOf":[{"$ref":"#/components/schemas/RdsetGrainAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RdsetGrainAttributes":"#/components/schemas/RdsetGrainAttributes"}}},"RdsetGrainAttributes":{"title":"RdsetGrainAttributes","examples":[{"type":"RdsetGrainAttributes","name":"Ada Lovelace","label":"example","rules":[{"type":"RdsetRuleAggregateLimit","max":1250}]}],"type":"object","required":["type","name","label"],"properties":{"type":{"description":"Always `RdsetGrainAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetGrainAttributes"]},"name":{"type":"string"},"label":{"type":"string"},"rules":{"description":"The rules a question bucketed by this grain is held to.","type":"array","items":{"$ref":"#/components/schemas/RdsetRule"}}}},"RdsetLimitKind":{"title":"RdsetLimitKind","type":"string","enum":["AtMost","AtLeast","Unknown"]},"RdsetLookup":{"title":"RdsetLookup","description":"How a person finds a value to filter on. `Search` means type part of a name into `/report-datasets/{id}/dimension-values` and pick from what comes back; an id is never typed by hand.","type":"string","enum":["OwnValues","Search","NotFilterable","ByValue","Unknown"]},"RdsetMeasure":{"description":"Something a report adds up.","oneOf":[{"$ref":"#/components/schemas/RdsetMeasureAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RdsetMeasureAttributes":"#/components/schemas/RdsetMeasureAttributes"}}},"RdsetMeasureAdditivity":{"title":"RdsetMeasureAdditivity","description":"Whether a client may add the measure's figures up itself, across the rows of an answer.","type":"string","enum":["Additive","SemiAdditive","NonAdditive","Unknown"]},"RdsetMeasureAttributes":{"title":"RdsetMeasureAttributes","description":"Something a report adds up.","examples":[{"type":"RdsetMeasureAttributes","name":"Ada Lovelace","label":"example","description":"A short description.","summary":"example","format":"Money","currencyDimension":"AUD","currency":"AUD","decimals":1250,"additivity":"Additive","target":{"type":"RdsetTargetBands","label":"example","bands":[{"type":"RdsetTargetBandAttributes","label":"example","from":"example","until":"example"}]},"group":"example","rules":[{"type":"RdsetRuleAggregateLimit","max":1250}],"riseIs":"Good"}],"type":"object","required":["type","name","label","description","summary","format","decimals","additivity","group"],"properties":{"type":{"description":"Always `RdsetMeasureAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetMeasureAttributes"]},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"},"summary":{"description":"The description cut to a few words, at most 50 characters, for a client to show on one line where the description would not fit.","type":"string"},"format":{"$ref":"#/components/schemas/RdsetMeasureFormat"},"currencyDimension":{"description":"For a `Money` measure, the dimension holding its currency. A query must group or pin that dimension.","type":"string"},"currency":{"description":"For a `Money` measure already in one currency, such as a converted one, that currency.","type":"string"},"decimals":{"type":"integer","format":"int32"},"additivity":{"$ref":"#/components/schemas/RdsetMeasureAdditivity"},"target":{"$ref":"#/components/schemas/RdsetTarget"},"group":{"description":"The heading a client files it under beside the dataset's other measures, such as `Amounts`, `Counts` or `Balances`.","type":"string"},"rules":{"description":"The rules a question asking it is held to.","type":"array","items":{"$ref":"#/components/schemas/RdsetRule"}},"riseIs":{"$ref":"#/components/schemas/RchtRiseIs","description":"Whether a rise in it is good news, bad news or neither, which a client colours a change in it by wherever it is shown, a table's column as well as a single figure. Absent where the dataset does not say."}}},"RdsetMeasureFormat":{"title":"RdsetMeasureFormat","type":"string","enum":["Money","Percent","Count","Number","Timestamp","Unknown"]},"RdsetOption":{"oneOf":[{"$ref":"#/components/schemas/RdsetOptionAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RdsetOptionAttributes":"#/components/schemas/RdsetOptionAttributes"}}},"RdsetOptionAttributes":{"title":"RdsetOptionAttributes","examples":[{"type":"RdsetOptionAttributes","value":"example","label":"example"}],"type":"object","required":["type","value","label"],"properties":{"type":{"description":"Always `RdsetOptionAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetOptionAttributes"]},"value":{"description":"The value to send in a filter.","type":"string"},"label":{"description":"What a person reads for it.","type":"string"}}},"RdsetPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/RdsetPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RdsetPageAttributes":"#/components/schemas/RdsetPageAttributes"}}},"RdsetPageAttributes":{"title":"RdsetPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"RdsetPageAttributes","data":[{"type":"RdsetAttributes","reportDatasetId":"abc123","domain":"example","label":"example","description":"A short description.","grains":[{"type":"RdsetGrainAttributes","name":"Ada Lovelace","label":"example","rules":[{"type":"RdsetRuleAggregateLimit","max":1250}]}],"defaultGrain":"example","dimensions":[{"type":"RdsetDimensionAttributes","name":"Ada Lovelace","label":"example","description":"A short description.","summary":"example","kind":"Text","lookup":"OwnValues","values":{"type":"RdsetValuesEntered","reason":"Requested by the customer."},"drillsTo":"example","matchesText":true,"group":"example","rules":[{"type":"RdsetRuleAggregateLimit","max":1250}],"operators":["Equals"],"identifies":"Enterprise","bands":[{"type":"RdsetStatusOutcomeAttributes","label":"example","tone":"Danger"}],"currencyDimension":"AUD"}],"measures":[{"type":"RdsetMeasureAttributes","name":"Ada Lovelace","label":"example","description":"A short description.","summary":"example","format":"Money","currencyDimension":"AUD","currency":"AUD","decimals":1250,"additivity":"Additive","target":{"type":"RdsetTargetBands","label":"example","bands":[{"type":"RdsetTargetBandAttributes","label":"example","from":"example","until":"example"}]},"group":"example","rules":[{"type":"RdsetRuleAggregateLimit","max":1250}],"riseIs":"Good"}],"rowColumns":["example"],"suggestedCharts":["BigNumber"],"segments":[{"type":"RdsetSegmentAttributes","name":"Ada Lovelace","label":"example","description":"A short description."}],"periods":[{"type":"RdsetPeriodAttributes","name":"Ada Lovelace","label":"example","description":"A short description."}],"timezone":"example","rules":[{"type":"RdsetRuleAggregateLimit","max":1250}],"statuses":[{"type":"RdsetStatusAttributes","name":"Ada Lovelace","label":"example","description":"A short description.","measures":["example"],"rules":[{"type":"RdsetStatusRuleAttributes","label":"example","tone":"Danger","tests":[{"type":"RdsetStatusTestAttributes","measure":"example","comparison":"Above","value":"example","passesAbsent":true}]}],"otherwise":{"type":"RdsetStatusOutcomeAttributes","label":"example","tone":"Danger"}}]}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `RdsetPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/Rdset"}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"RdsetPeriod":{"oneOf":[{"$ref":"#/components/schemas/RdsetPeriodAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RdsetPeriodAttributes":"#/components/schemas/RdsetPeriodAttributes"}}},"RdsetPeriodAttributes":{"title":"RdsetPeriodAttributes","examples":[{"type":"RdsetPeriodAttributes","name":"Ada Lovelace","label":"example","description":"A short description."}],"type":"object","required":["type","name","label","description"],"properties":{"type":{"description":"Always `RdsetPeriodAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetPeriodAttributes"]},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}},"RdsetQuestionPart":{"title":"RdsetQuestionPart","type":"string","enum":["Pivot","Top","MeasureFilter","Comparison","AsAt","TimeSlice","PeriodRange","RowMode","Sort","SortByTime","Page","Export","Unknown"]},"RdsetRule":{"oneOf":[{"$ref":"#/components/schemas/RdsetRuleAggregateLimit"},{"$ref":"#/components/schemas/RdsetRuleAskedBesideOnly"},{"$ref":"#/components/schemas/RdsetRuleAtMostValues"},{"$ref":"#/components/schemas/RdsetRuleContainsNeedsTimeSlice"},{"$ref":"#/components/schemas/RdsetRuleExcludes"},{"$ref":"#/components/schemas/RdsetRuleExclusive"},{"$ref":"#/components/schemas/RdsetRuleExportLimit"},{"$ref":"#/components/schemas/RdsetRuleFilteredBy"},{"$ref":"#/components/schemas/RdsetRuleGroupNeedsBound"},{"$ref":"#/components/schemas/RdsetRuleGroupsWithin"},{"$ref":"#/components/schemas/RdsetRuleMaxDimensions"},{"$ref":"#/components/schemas/RdsetRuleMaxMeasureFilters"},{"$ref":"#/components/schemas/RdsetRuleMaxRange"},{"$ref":"#/components/schemas/RdsetRuleNeeds"},{"$ref":"#/components/schemas/RdsetRuleNeedsBalance"},{"$ref":"#/components/schemas/RdsetRuleNeedsCurrency"},{"$ref":"#/components/schemas/RdsetRuleNeedsCurrencyPinned"},{"$ref":"#/components/schemas/RdsetRuleNotBesideDimensions"},{"$ref":"#/components/schemas/RdsetRuleNotContains"},{"$ref":"#/components/schemas/RdsetRuleNotFiltered"},{"$ref":"#/components/schemas/RdsetRuleNotFilteredBy"},{"$ref":"#/components/schemas/RdsetRuleNotRanked"},{"$ref":"#/components/schemas/RdsetRuleNotSplitBy"},{"$ref":"#/components/schemas/RdsetRuleNotThresholded"},{"$ref":"#/components/schemas/RdsetRuleObservedBy"},{"$ref":"#/components/schemas/RdsetRuleOneDataset"},{"$ref":"#/components/schemas/RdsetRulePivotSize"},{"$ref":"#/components/schemas/RdsetRuleRefersToQuestion"},{"$ref":"#/components/schemas/RdsetRuleRequires"},{"$ref":"#/components/schemas/RdsetRuleRowModeLimit"},{"$ref":"#/components/schemas/RdsetRuleTenantIds"},{"$ref":"#/components/schemas/RdsetRuleTopCount"},{"$ref":"#/components/schemas/RdsetRuleWellFormed"},{"$ref":"#/components/schemas/RdsetRuleWholeNumbers"}],"discriminator":{"propertyName":"type","mapping":{"RdsetRuleAggregateLimit":"#/components/schemas/RdsetRuleAggregateLimit","RdsetRuleAskedBesideOnly":"#/components/schemas/RdsetRuleAskedBesideOnly","RdsetRuleAtMostValues":"#/components/schemas/RdsetRuleAtMostValues","RdsetRuleContainsNeedsTimeSlice":"#/components/schemas/RdsetRuleContainsNeedsTimeSlice","RdsetRuleExcludes":"#/components/schemas/RdsetRuleExcludes","RdsetRuleExclusive":"#/components/schemas/RdsetRuleExclusive","RdsetRuleExportLimit":"#/components/schemas/RdsetRuleExportLimit","RdsetRuleFilteredBy":"#/components/schemas/RdsetRuleFilteredBy","RdsetRuleGroupNeedsBound":"#/components/schemas/RdsetRuleGroupNeedsBound","RdsetRuleGroupsWithin":"#/components/schemas/RdsetRuleGroupsWithin","RdsetRuleMaxDimensions":"#/components/schemas/RdsetRuleMaxDimensions","RdsetRuleMaxMeasureFilters":"#/components/schemas/RdsetRuleMaxMeasureFilters","RdsetRuleMaxRange":"#/components/schemas/RdsetRuleMaxRange","RdsetRuleNeeds":"#/components/schemas/RdsetRuleNeeds","RdsetRuleNeedsBalance":"#/components/schemas/RdsetRuleNeedsBalance","RdsetRuleNeedsCurrency":"#/components/schemas/RdsetRuleNeedsCurrency","RdsetRuleNeedsCurrencyPinned":"#/components/schemas/RdsetRuleNeedsCurrencyPinned","RdsetRuleNotBesideDimensions":"#/components/schemas/RdsetRuleNotBesideDimensions","RdsetRuleNotContains":"#/components/schemas/RdsetRuleNotContains","RdsetRuleNotFiltered":"#/components/schemas/RdsetRuleNotFiltered","RdsetRuleNotFilteredBy":"#/components/schemas/RdsetRuleNotFilteredBy","RdsetRuleNotRanked":"#/components/schemas/RdsetRuleNotRanked","RdsetRuleNotSplitBy":"#/components/schemas/RdsetRuleNotSplitBy","RdsetRuleNotThresholded":"#/components/schemas/RdsetRuleNotThresholded","RdsetRuleObservedBy":"#/components/schemas/RdsetRuleObservedBy","RdsetRuleOneDataset":"#/components/schemas/RdsetRuleOneDataset","RdsetRulePivotSize":"#/components/schemas/RdsetRulePivotSize","RdsetRuleRefersToQuestion":"#/components/schemas/RdsetRuleRefersToQuestion","RdsetRuleRequires":"#/components/schemas/RdsetRuleRequires","RdsetRuleRowModeLimit":"#/components/schemas/RdsetRuleRowModeLimit","RdsetRuleTenantIds":"#/components/schemas/RdsetRuleTenantIds","RdsetRuleTopCount":"#/components/schemas/RdsetRuleTopCount","RdsetRuleWellFormed":"#/components/schemas/RdsetRuleWellFormed","RdsetRuleWholeNumbers":"#/components/schemas/RdsetRuleWholeNumbers"}}},"RdsetRuleAggregateLimit":{"title":"RdsetRuleAggregateLimit","description":"A question with measures returns at most `max` rows, and its `limit` is at most `max`.","examples":[{"type":"RdsetRuleAggregateLimit","max":1250}],"type":"object","required":["type","max"],"properties":{"type":{"description":"Always `RdsetRuleAggregateLimit`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetRuleAggregateLimit"]},"max":{"type":"integer","format":"int32"}}},"RdsetRuleAskedBesideOnly":{"title":"RdsetRuleAskedBesideOnly","description":"A question asking it may ask, beside it, only `measures`.","examples":[{"type":"RdsetRuleAskedBesideOnly","measures":["example"]}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `RdsetRuleAskedBesideOnly`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetRuleAskedBesideOnly"]},"measures":{"type":"array","items":{"type":"string"}}}},"RdsetRuleAtMostValues":{"title":"RdsetRuleAtMostValues","description":"It takes at most `max` values, which a pivot column counts against `RdsetRulePivotSize`.","examples":[{"type":"RdsetRuleAtMostValues","max":1250}],"type":"object","required":["type","max"],"properties":{"type":{"description":"Always `RdsetRuleAtMostValues`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetRuleAtMostValues"]},"max":{"type":"integer","format":"int32"}}},"RdsetRuleContainsNeedsTimeSlice":{"title":"RdsetRuleContainsNeedsTimeSlice","description":"An `RqryFilterContains` on it needs a time slice, to bound the rows it tests.","examples":[{"type":"RdsetRuleContainsNeedsTimeSlice"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `RdsetRuleContainsNeedsTimeSlice`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetRuleContainsNeedsTimeSlice"]}}},"RdsetRuleExcludes":{"title":"RdsetRuleExcludes","description":"A question asking it may not hold `part`.","examples":[{"type":"RdsetRuleExcludes","part":"Pivot"}],"type":"object","required":["type","part"],"properties":{"type":{"description":"Always `RdsetRuleExcludes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetRuleExcludes"]},"part":{"$ref":"#/components/schemas/RdsetQuestionPart"}}},"RdsetRuleExclusive":{"title":"RdsetRuleExclusive","description":"A question may not hold both parts.","examples":[{"type":"RdsetRuleExclusive","first":"Pivot","second":"Pivot"}],"type":"object","required":["type","first","second"],"properties":{"type":{"description":"Always `RdsetRuleExclusive`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetRuleExclusive"]},"first":{"$ref":"#/components/schemas/RdsetQuestionPart"},"second":{"$ref":"#/components/schemas/RdsetQuestionPart"}}},"RdsetRuleExportLimit":{"title":"RdsetRuleExportLimit","description":"An export holds at most `max` rows, and is refused rather than cut short when the answer holds more.","examples":[{"type":"RdsetRuleExportLimit","max":1250}],"type":"object","required":["type","max"],"properties":{"type":{"description":"Always `RdsetRuleExportLimit`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetRuleExportLimit"]},"max":{"type":"integer","format":"int32"}}},"RdsetRuleFilteredBy":{"title":"RdsetRuleFilteredBy","description":"A filter on it is one of `operators`, each naming the `RqryFilter` subtype of that name; any other is refused.","examples":[{"type":"RdsetRuleFilteredBy","operators":["Equals"]}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `RdsetRuleFilteredBy`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetRuleFilteredBy"]},"operators":{"type":"array","items":{"$ref":"#/components/schemas/RdsetFilterOperator"}}}},"RdsetRuleGroupNeedsBound":{"title":"RdsetRuleGroupNeedsBound","description":"It has too many values to group by unbounded: grouping by it needs an `RqryFilterEquals`, `RqryFilterIn`, `RqryFilterBetween` or `RqryFilterAbsent` on it, a `limit`, or a top ranking it. An export is bounded by its own limit. It is never a pivot column.","examples":[{"type":"RdsetRuleGroupNeedsBound"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `RdsetRuleGroupNeedsBound`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetRuleGroupNeedsBound"]}}},"RdsetRuleGroupsWithin":{"title":"RdsetRuleGroupsWithin","description":"It is a share within `dimensions`, so a question asking it groups by each of them and never ranks one with a top.","examples":[{"type":"RdsetRuleGroupsWithin","dimensions":["example"]}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `RdsetRuleGroupsWithin`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetRuleGroupsWithin"]},"dimensions":{"type":"array","items":{"type":"string"}}}},"RdsetRuleMaxDimensions":{"title":"RdsetRuleMaxDimensions","description":"A question groups by at most `max` dimensions.","examples":[{"type":"RdsetRuleMaxDimensions","max":1250}],"type":"object","required":["type","max"],"properties":{"type":{"description":"Always `RdsetRuleMaxDimensions`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetRuleMaxDimensions"]},"max":{"type":"integer","format":"int32"}}},"RdsetRuleMaxMeasureFilters":{"title":"RdsetRuleMaxMeasureFilters","description":"A question holds at most `max` measure filters.","examples":[{"type":"RdsetRuleMaxMeasureFilters","max":1250}],"type":"object","required":["type","max"],"properties":{"type":{"description":"Always `RdsetRuleMaxMeasureFilters`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetRuleMaxMeasureFilters"]},"max":{"type":"integer","format":"int32"}}},"RdsetRuleMaxRange":{"title":"RdsetRuleMaxRange","description":"A range bucketed by this grain spans at most `range`, an ISO 8601 period such as `P31D`.","examples":[{"type":"RdsetRuleMaxRange","range":"example"}],"type":"object","required":["type","range"],"properties":{"type":{"description":"Always `RdsetRuleMaxRange`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetRuleMaxRange"]},"range":{"type":"string"}}},"RdsetRuleNeeds":{"title":"RdsetRuleNeeds","description":"A question asking it must hold `part`.","examples":[{"type":"RdsetRuleNeeds","part":"Pivot"}],"type":"object","required":["type","part"],"properties":{"type":{"description":"Always `RdsetRuleNeeds`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetRuleNeeds"]},"part":{"$ref":"#/components/schemas/RdsetQuestionPart"}}},"RdsetRuleNeedsBalance":{"title":"RdsetRuleNeedsBalance","description":"It is read at the close of each time bucket, as a key's whole balance there, so a question grouping or filtering by it must also ask a balance carried from a change log.","examples":[{"type":"RdsetRuleNeedsBalance"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `RdsetRuleNeedsBalance`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetRuleNeedsBalance"]}}},"RdsetRuleNeedsCurrency":{"title":"RdsetRuleNeedsCurrency","description":"It is money in the currency `dimension` holds, so a question asking it groups by that dimension or pins it with an `RqryFilterEquals`; in a pivot, or under a top ranking that dimension, it pins it.","examples":[{"type":"RdsetRuleNeedsCurrency","dimension":"example"}],"type":"object","required":["type","dimension"],"properties":{"type":{"description":"Always `RdsetRuleNeedsCurrency`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetRuleNeedsCurrency"]},"dimension":{"type":"string"}}},"RdsetRuleNeedsCurrencyPinned":{"title":"RdsetRuleNeedsCurrencyPinned","description":"It divides money in the currency `dimension` holds, so a question asking it pins that dimension with an `RqryFilterEquals`.","examples":[{"type":"RdsetRuleNeedsCurrencyPinned","dimension":"example"}],"type":"object","required":["type","dimension"],"properties":{"type":{"description":"Always `RdsetRuleNeedsCurrencyPinned`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetRuleNeedsCurrencyPinned"]},"dimension":{"type":"string"}}},"RdsetRuleNotBesideDimensions":{"title":"RdsetRuleNotBesideDimensions","description":"A question asking it cannot group or filter by `dimensions`, each a band worked out per group.","examples":[{"type":"RdsetRuleNotBesideDimensions","dimensions":["example"]}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `RdsetRuleNotBesideDimensions`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetRuleNotBesideDimensions"]},"dimensions":{"type":"array","items":{"type":"string"}}}},"RdsetRuleNotContains":{"title":"RdsetRuleNotContains","description":"An `RqryFilterContains` cannot search it.","examples":[{"type":"RdsetRuleNotContains"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `RdsetRuleNotContains`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetRuleNotContains"]}}},"RdsetRuleNotFiltered":{"title":"RdsetRuleNotFiltered","description":"It cannot be filtered on, only grouped by or listed as a row column.","examples":[{"type":"RdsetRuleNotFiltered"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `RdsetRuleNotFiltered`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetRuleNotFiltered"]}}},"RdsetRuleNotFilteredBy":{"title":"RdsetRuleNotFilteredBy","description":"A question asking it cannot filter on `dimensions`; it may group by them.","examples":[{"type":"RdsetRuleNotFilteredBy","dimensions":["example"]}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `RdsetRuleNotFilteredBy`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetRuleNotFilteredBy"]},"dimensions":{"type":"array","items":{"type":"string"}}}},"RdsetRuleNotRanked":{"title":"RdsetRuleNotRanked","description":"A top cannot rank by it.","examples":[{"type":"RdsetRuleNotRanked"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `RdsetRuleNotRanked`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetRuleNotRanked"]}}},"RdsetRuleNotSplitBy":{"title":"RdsetRuleNotSplitBy","description":"It is a balance carried from each record's latest change, so a question asking it cannot group or filter by `dimensions`.","examples":[{"type":"RdsetRuleNotSplitBy","dimensions":["example"]}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `RdsetRuleNotSplitBy`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetRuleNotSplitBy"]},"dimensions":{"type":"array","items":{"type":"string"}}}},"RdsetRuleNotThresholded":{"title":"RdsetRuleNotThresholded","description":"A measure filter cannot test it.","examples":[{"type":"RdsetRuleNotThresholded"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `RdsetRuleNotThresholded`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetRuleNotThresholded"]}}},"RdsetRuleObservedBy":{"title":"RdsetRuleObservedBy","description":"It is a balance observed by `grain` snapshots, so it cannot be bucketed by `notByGrains` or grouped by `notByDimensions`, whose buckets do not hold whole snapshots. It is summed across dimensions, never across time.","examples":[{"type":"RdsetRuleObservedBy","grain":"example","notByGrains":["example"],"notByDimensions":["example"]}],"type":"object","required":["type","grain"],"properties":{"type":{"description":"Always `RdsetRuleObservedBy`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetRuleObservedBy"]},"grain":{"type":"string"},"notByGrains":{"type":"array","items":{"type":"string"}},"notByDimensions":{"type":"array","items":{"type":"string"}}}},"RdsetRuleOneDataset":{"title":"RdsetRuleOneDataset","description":"A question names only the dimensions, measures, grains, segments, periods and row columns this dataset's entry lists.","examples":[{"type":"RdsetRuleOneDataset"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `RdsetRuleOneDataset`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetRuleOneDataset"]}}},"RdsetRulePivotSize":{"title":"RdsetRulePivotSize","description":"A pivot's columns combine to at most `maxColumnValues` values, by each column dimension's `RdsetRuleAtMostValues`, and its rows, time and subtotals to at most `maxGroupingSets` grouping sets.","examples":[{"type":"RdsetRulePivotSize","maxColumnValues":1250,"maxGroupingSets":1250}],"type":"object","required":["type","maxColumnValues","maxGroupingSets"],"properties":{"type":{"description":"Always `RdsetRulePivotSize`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetRulePivotSize"]},"maxColumnValues":{"type":"integer","format":"int32"},"maxGroupingSets":{"type":"integer","format":"int32"}}},"RdsetRuleRefersToQuestion":{"title":"RdsetRuleRefersToQuestion","description":"The part names only dimensions the question groups by and measures it asks for; a pivot names each grouped dimension once.","examples":[{"type":"RdsetRuleRefersToQuestion","part":"Pivot"}],"type":"object","required":["type","part"],"properties":{"type":{"description":"Always `RdsetRuleRefersToQuestion`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetRuleRefersToQuestion"]},"part":{"$ref":"#/components/schemas/RdsetQuestionPart"}}},"RdsetRuleRequires":{"title":"RdsetRuleRequires","description":"A question holding `part` must hold `needs` too.","examples":[{"type":"RdsetRuleRequires","part":"Pivot","needs":"Pivot"}],"type":"object","required":["type","part","needs"],"properties":{"type":{"description":"Always `RdsetRuleRequires`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetRuleRequires"]},"part":{"$ref":"#/components/schemas/RdsetQuestionPart"},"needs":{"$ref":"#/components/schemas/RdsetQuestionPart"}}},"RdsetRuleRowModeLimit":{"title":"RdsetRuleRowModeLimit","description":"A question with no measures returns at most `max` rows a page, and its `limit` is at most `max`.","examples":[{"type":"RdsetRuleRowModeLimit","max":1250}],"type":"object","required":["type","max"],"properties":{"type":{"description":"Always `RdsetRuleRowModeLimit`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetRuleRowModeLimit"]},"max":{"type":"integer","format":"int32"}}},"RdsetRuleTenantIds":{"title":"RdsetRuleTenantIds","description":"A filter value is one of its values from `/report-datasets/{id}/dimension-values`, never a range or part of its text. A marketplace also takes `Direct`.","examples":[{"type":"RdsetRuleTenantIds"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `RdsetRuleTenantIds`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetRuleTenantIds"]}}},"RdsetRuleTopCount":{"title":"RdsetRuleTopCount","description":"A top's `count` is from 1 to `max`.","examples":[{"type":"RdsetRuleTopCount","max":1250}],"type":"object","required":["type","max"],"properties":{"type":{"description":"Always `RdsetRuleTopCount`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetRuleTopCount"]},"max":{"type":"integer","format":"int32"}}},"RdsetRuleWellFormed":{"title":"RdsetRuleWellFormed","description":"A range ends after it starts and lies within the representable years, as does an `asAt` instant; a filter value fits its dimension's `kind`; an `RqryFilterIn` or `RqryFilterNotIn` names a value; and a `page` is one this question's answer returned.","examples":[{"type":"RdsetRuleWellFormed"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `RdsetRuleWellFormed`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetRuleWellFormed"]}}},"RdsetRuleWholeNumbers":{"title":"RdsetRuleWholeNumbers","description":"A filter value is a whole number from `first` to `last`; any other can never match.","examples":[{"type":"RdsetRuleWholeNumbers","first":1250,"last":1250}],"type":"object","required":["type","first","last"],"properties":{"type":{"description":"Always `RdsetRuleWholeNumbers`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetRuleWholeNumbers"]},"first":{"type":"integer","format":"int32"},"last":{"type":"integer","format":"int32"}}},"RdsetSegment":{"oneOf":[{"$ref":"#/components/schemas/RdsetSegmentAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RdsetSegmentAttributes":"#/components/schemas/RdsetSegmentAttributes"}}},"RdsetSegmentAttributes":{"title":"RdsetSegmentAttributes","examples":[{"type":"RdsetSegmentAttributes","name":"Ada Lovelace","label":"example","description":"A short description."}],"type":"object","required":["type","name","label","description"],"properties":{"type":{"description":"Always `RdsetSegmentAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetSegmentAttributes"]},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}},"RdsetStatus":{"description":"A status of a row: the label of the first rule whose every test passes, else `otherwise`, else none. It reads the row's own figures, after any comparison, so a previous period's figures have none.","oneOf":[{"$ref":"#/components/schemas/RdsetStatusAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RdsetStatusAttributes":"#/components/schemas/RdsetStatusAttributes"}}},"RdsetStatusAttributes":{"title":"RdsetStatusAttributes","description":"A status of a row: the label of the first rule whose every test passes, else `otherwise`, else none. It reads the row's own figures, after any comparison, so a previous period's figures have none.","examples":[{"type":"RdsetStatusAttributes","name":"Ada Lovelace","label":"example","description":"A short description.","measures":["example"],"rules":[{"type":"RdsetStatusRuleAttributes","label":"example","tone":"Danger","tests":[{"type":"RdsetStatusTestAttributes","measure":"example","comparison":"Above","value":"example","passesAbsent":true}]}],"otherwise":{"type":"RdsetStatusOutcomeAttributes","label":"example","tone":"Danger"}}],"type":"object","required":["type","name","label","description"],"properties":{"type":{"description":"Always `RdsetStatusAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetStatusAttributes"]},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"},"measures":{"description":"The measures its rules test, every one of which a question asks for an answer to carry the status.","type":"array","items":{"type":"string"}},"rules":{"type":"array","items":{"$ref":"#/components/schemas/RdsetStatusRule"}},"otherwise":{"$ref":"#/components/schemas/RdsetStatusOutcome","description":"The status of a row no rule holds for. Absent for none."}}},"RdsetStatusComparison":{"title":"RdsetStatusComparison","type":"string","enum":["Above","AtLeast","Below","AtMost","NotEqual","Unknown"]},"RdsetStatusOutcome":{"oneOf":[{"$ref":"#/components/schemas/RdsetStatusOutcomeAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RdsetStatusOutcomeAttributes":"#/components/schemas/RdsetStatusOutcomeAttributes"}}},"RdsetStatusOutcomeAttributes":{"title":"RdsetStatusOutcomeAttributes","examples":[{"type":"RdsetStatusOutcomeAttributes","label":"example","tone":"Danger"}],"type":"object","required":["type","label","tone"],"properties":{"type":{"description":"Always `RdsetStatusOutcomeAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetStatusOutcomeAttributes"]},"label":{"type":"string"},"tone":{"$ref":"#/components/schemas/RdsetStatusTone"}}},"RdsetStatusRule":{"oneOf":[{"$ref":"#/components/schemas/RdsetStatusRuleAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RdsetStatusRuleAttributes":"#/components/schemas/RdsetStatusRuleAttributes"}}},"RdsetStatusRuleAttributes":{"title":"RdsetStatusRuleAttributes","examples":[{"type":"RdsetStatusRuleAttributes","label":"example","tone":"Danger","tests":[{"type":"RdsetStatusTestAttributes","measure":"example","comparison":"Above","value":"example","passesAbsent":true}]}],"type":"object","required":["type","label","tone"],"properties":{"type":{"description":"Always `RdsetStatusRuleAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetStatusRuleAttributes"]},"label":{"type":"string"},"tone":{"$ref":"#/components/schemas/RdsetStatusTone","description":"How the status reads to a person, so a client shades it without knowing the report."},"tests":{"description":"Every test must pass for the rule to hold.","type":"array","items":{"$ref":"#/components/schemas/RdsetStatusTest"}}}},"RdsetStatusTest":{"description":"A test of one measure's figure in the row against a value, a decimal as text.","oneOf":[{"$ref":"#/components/schemas/RdsetStatusTestAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RdsetStatusTestAttributes":"#/components/schemas/RdsetStatusTestAttributes"}}},"RdsetStatusTestAttributes":{"title":"RdsetStatusTestAttributes","description":"A test of one measure's figure in the row against a value, a decimal as text.","examples":[{"type":"RdsetStatusTestAttributes","measure":"example","comparison":"Above","value":"example","passesAbsent":true}],"type":"object","required":["type","measure","comparison","value","passesAbsent"],"properties":{"type":{"description":"Always `RdsetStatusTestAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetStatusTestAttributes"]},"measure":{"type":"string"},"comparison":{"$ref":"#/components/schemas/RdsetStatusComparison"},"value":{"type":"string"},"passesAbsent":{"description":"Whether a row with no figure for the measure passes.","type":"boolean"}}},"RdsetStatusTone":{"title":"RdsetStatusTone","type":"string","enum":["Danger","Warning","Success","Muted","Neutral","Unknown"]},"RdsetTarget":{"description":"What the measure is held to. An answer holding the measure carries, per row, its status against it. Absent for none.","oneOf":[{"$ref":"#/components/schemas/RdsetTargetBands"},{"$ref":"#/components/schemas/RdsetTargetLimit"}],"discriminator":{"propertyName":"type","mapping":{"RdsetTargetBands":"#/components/schemas/RdsetTargetBands","RdsetTargetLimit":"#/components/schemas/RdsetTargetLimit"}}},"RdsetTargetBand":{"description":"A band of figures from `from`, inclusive, to `until`, exclusive, either end open. Each is a decimal as text.","oneOf":[{"$ref":"#/components/schemas/RdsetTargetBandAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RdsetTargetBandAttributes":"#/components/schemas/RdsetTargetBandAttributes"}}},"RdsetTargetBandAttributes":{"title":"RdsetTargetBandAttributes","description":"A band of figures from `from`, inclusive, to `until`, exclusive, either end open. Each is a decimal as text.","examples":[{"type":"RdsetTargetBandAttributes","label":"example","from":"example","until":"example"}],"type":"object","required":["type","label"],"properties":{"type":{"description":"Always `RdsetTargetBandAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetTargetBandAttributes"]},"label":{"type":"string"},"from":{"type":"string"},"until":{"type":"string"}}},"RdsetTargetBands":{"title":"RdsetTargetBands","description":"Bands, such as green, amber and red: a row's status is the label of the band its figure falls in.","examples":[{"type":"RdsetTargetBands","label":"example","bands":[{"type":"RdsetTargetBandAttributes","label":"example","from":"example","until":"example"}]}],"type":"object","required":["type","label"],"properties":{"type":{"description":"Always `RdsetTargetBands`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetTargetBands"]},"label":{"type":"string"},"bands":{"type":"array","items":{"$ref":"#/components/schemas/RdsetTargetBand"}}}},"RdsetTargetLimit":{"title":"RdsetTargetLimit","description":"A limit, such as a card scheme's dispute threshold: a row's figure `Met` it or `Breached` it. The value is a decimal as text.","examples":[{"type":"RdsetTargetLimit","label":"example","value":"example","kind":"AtMost"}],"type":"object","required":["type","label","value","kind"],"properties":{"type":{"description":"Always `RdsetTargetLimit`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetTargetLimit"]},"label":{"type":"string"},"value":{"type":"string"},"kind":{"$ref":"#/components/schemas/RdsetLimitKind"}}},"RdsetValue":{"description":"One value a dimension can be filtered to, with the name a person picks it by.","oneOf":[{"$ref":"#/components/schemas/RdsetValueAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RdsetValueAttributes":"#/components/schemas/RdsetValueAttributes"}}},"RdsetValueAttributes":{"title":"RdsetValueAttributes","description":"One value a dimension can be filtered to, with the name a person picks it by.","examples":[{"type":"RdsetValueAttributes","value":"example","label":"example"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `RdsetValueAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetValueAttributes"]},"value":{"description":"The value to put in a filter. Absent for a record with no value.","type":"string"},"label":{"description":"What to show a person. Absent where the value is its own label.","type":"string"}}},"RdsetValuePage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/RdsetValuePageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RdsetValuePageAttributes":"#/components/schemas/RdsetValuePageAttributes"}}},"RdsetValuePageAttributes":{"title":"RdsetValuePageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"RdsetValuePageAttributes","data":[{"type":"RdsetValueAttributes","value":"example","label":"example"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `RdsetValuePageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetValuePageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/RdsetValue"}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"RdsetValues":{"description":"How a value to filter on is found, by its subtype: a fixed set listed inline with each value's label, in the order a person picks from; the dimension's own values or a lookup's, searched through `/report-datasets/{id}/dimension-values`; typed by the person, with why; or none, for a dimension that cannot be filtered on.","oneOf":[{"$ref":"#/components/schemas/RdsetValuesEntered"},{"$ref":"#/components/schemas/RdsetValuesListed"},{"$ref":"#/components/schemas/RdsetValuesNotFiltered"},{"$ref":"#/components/schemas/RdsetValuesReferenced"},{"$ref":"#/components/schemas/RdsetValuesSearched"}],"discriminator":{"propertyName":"type","mapping":{"RdsetValuesEntered":"#/components/schemas/RdsetValuesEntered","RdsetValuesListed":"#/components/schemas/RdsetValuesListed","RdsetValuesNotFiltered":"#/components/schemas/RdsetValuesNotFiltered","RdsetValuesReferenced":"#/components/schemas/RdsetValuesReferenced","RdsetValuesSearched":"#/components/schemas/RdsetValuesSearched"}}},"RdsetValuesEntered":{"title":"RdsetValuesEntered","description":"Typed by the person: a number, a date or text with nothing to pick from.","examples":[{"type":"RdsetValuesEntered","reason":"Requested by the customer."}],"type":"object","required":["type","reason"],"properties":{"type":{"description":"Always `RdsetValuesEntered`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetValuesEntered"]},"reason":{"description":"Why nothing is offered to pick from, for a client to show beside the input.","type":"string"}}},"RdsetValuesListed":{"title":"RdsetValuesListed","description":"A fixed set: pick from `options`, in their order. `/report-datasets/{id}/dimension-values` answers the same options, narrowed by `q` to those whose value or label holds it, whatever its case.","examples":[{"type":"RdsetValuesListed","options":[{"type":"RdsetOptionAttributes","value":"example","label":"example"}],"namedPart":"HourOfDay"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `RdsetValuesListed`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetValuesListed"]},"options":{"type":"array","items":{"$ref":"#/components/schemas/RdsetOption"}},"namedPart":{"$ref":"#/components/schemas/RdsetDatePart"}}},"RdsetValuesNotFiltered":{"title":"RdsetValuesNotFiltered","description":"The dimension cannot be filtered on, so it takes no value.","examples":[{"type":"RdsetValuesNotFiltered"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `RdsetValuesNotFiltered`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetValuesNotFiltered"]}}},"RdsetValuesReferenced":{"title":"RdsetValuesReferenced","description":"Ids of a record found by its name: read them from `/report-datasets/{id}/dimension-values` with part of the name in `q`, each id answered with its name where this caller may read it.","examples":[{"type":"RdsetValuesReferenced","minimumSearch":1250}],"type":"object","required":["type","minimumSearch"],"properties":{"type":{"description":"Always `RdsetValuesReferenced`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetValuesReferenced"]},"minimumSearch":{"description":"How many characters of `q` the read needs.","type":"integer","format":"int32"}}},"RdsetValuesSearched":{"title":"RdsetValuesSearched","description":"The dimension's own stored values: read them from `/report-datasets/{id}/dimension-values`, by part of a value in `q`.","examples":[{"type":"RdsetValuesSearched","minimumSearch":1250}],"type":"object","required":["type","minimumSearch"],"properties":{"type":{"description":"Always `RdsetValuesSearched`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdsetValuesSearched"]},"minimumSearch":{"description":"How many characters of `q` the read needs. A read with no `q` is refused while the values are too many to list.","type":"integer","format":"int32"}}},"RdshChartCopying":{"title":"RdshChartCopying","type":"string","enum":["Reference","Copy","Unknown"]},"RdshCmd":{"oneOf":[{"$ref":"#/components/schemas/RdshCmdCopy"},{"$ref":"#/components/schemas/RdshCmdCreate"}],"discriminator":{"propertyName":"type","mapping":{"RdshCmdCopy":"#/components/schemas/RdshCmdCopy","RdshCmdCreate":"#/components/schemas/RdshCmdCreate"}}},"RdshCmdCopy":{"title":"RdshCmdCopy","description":"Save a copy of a dashboard the caller can read, owned by the caller. Its tiles are those the caller is shown.","examples":[{"type":"RdshCmdCopy","copyOf":"rdsh_9f2Kd8QpLzXw","reportSpaceId":"rspc_9f2Kd8QpLzXw","title":"example","charts":"Reference","onlyReportChartIds":["rcht_9f2Kd8QpLzXw"],"filters":{"type":"RdshFiltersAttributes","range":{"type":"RqryRangeBetween","from":"2026-08-19","to":"2026-08-19"},"timezone":"example","dimensionFilters":[{"type":"RdshDimensionFilterAttributes","dimension":"example","operator":"Equals","values":["example"],"fromTile":"example"}],"periodClick":{"type":"RdshPeriodClickAttributes","fromTile":"example","range":{"type":"RqryRangeBetween","from":"2026-08-19","to":"2026-08-19"}}}}],"type":"object","required":["type","copyOf","charts"],"properties":{"type":{"description":"Always `RdshCmdCopy`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdshCmdCopy"]},"copyOf":{"$ref":"#/components/schemas/RdshId","description":"The dashboard to copy."},"reportSpaceId":{"$ref":"#/components/schemas/RspcId","description":"Where to save the copy. Absent for the original's space, or for the caller's default space when the original is in the System space."},"title":{"description":"Absent for the original's title with ` (copy)` after it.","type":"string"},"charts":{"$ref":"#/components/schemas/RdshChartCopying"},"onlyReportChartIds":{"description":"Copy only the tiles showing these charts. Empty for every tile.","type":"array","items":{"$ref":"#/components/schemas/RchtId","description":"Identifier of a saved chart."}},"filters":{"$ref":"#/components/schemas/RdshFilters","description":"What the copy opens filtered by. Absent for the original's."}}},"RdshCmdCreate":{"title":"RdshCmdCreate","description":"Save a dashboard in a space the caller may change. Every tile shows a chart the caller may read and everyone who sees the space may see.","examples":[{"type":"RdshCmdCreate","reportSpaceId":"rspc_9f2Kd8QpLzXw","title":"example","description":"A short description.","layout":{"type":"RdshLayoutAttributes","tabs":[{"type":"RdshTabAttributes","tabId":"abc123","title":"example"}],"tiles":[{"type":"RdshTileAttributes","reportChartId":"rcht_9f2Kd8QpLzXw","tabId":"abc123","x":1250,"y":1250,"w":1250,"h":1250,"click":{"type":"RdshTileClickSetsDimension","dimension":"example"},"keepsOwnRange":true,"thresholds":[{"type":"RdshThresholdAttributes","measure":"example","comparison":"Above","value":"example","tone":"Danger"}],"rowFilters":[{"type":"RdshRowFilterAttributes","dimension":"example","column":"example"}]}]},"filters":{"type":"RdshFiltersAttributes","range":{"type":"RqryRangeBetween","from":"2026-08-19","to":"2026-08-19"},"timezone":"example","dimensionFilters":[{"type":"RdshDimensionFilterAttributes","dimension":"example","operator":"Equals","values":["example"],"fromTile":"example"}],"periodClick":{"type":"RdshPeriodClickAttributes","fromTile":"example","range":{"type":"RqryRangeBetween","from":"2026-08-19","to":"2026-08-19"}}}}],"type":"object","required":["type","reportSpaceId","title"],"properties":{"type":{"description":"Always `RdshCmdCreate`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdshCmdCreate"]},"reportSpaceId":{"$ref":"#/components/schemas/RspcId","description":"Identifier of a report space."},"title":{"type":"string"},"description":{"type":"string"},"layout":{"$ref":"#/components/schemas/RdshLayout","description":"Absent for a dashboard with no tiles yet."},"filters":{"$ref":"#/components/schemas/RdshFilters","description":"What the dashboard opens filtered by."}}},"RdshColumn":{"title":"RdshColumn","type":"string","enum":["ReportDashboardId","ReportSpaceId","Title","Description","FiltersTimezone","FiltersPeriodClickFromTile","Access","OwnedByCaller","Editable","CreatedAt","UpdatedAt"]},"RdshCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/RdshCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RdshCreateRspAttributes":"#/components/schemas/RdshCreateRspAttributes"}}},"RdshCreateRspAttributes":{"title":"RdshCreateRspAttributes","examples":[{"type":"RdshCreateRspAttributes","created":{"type":"RdshViewAttributes","reportDashboardId":"rdsh_9f2Kd8QpLzXw","reportSpaceId":"rspc_9f2Kd8QpLzXw","title":"example","description":"A short description.","layout":{"type":"RdshLayoutAttributes","tabs":[{"type":"RdshTabAttributes","tabId":"abc123","title":"example"}],"tiles":[{"type":"RdshTileAttributes","reportChartId":"rcht_9f2Kd8QpLzXw","tabId":"abc123","x":1250,"y":1250,"w":1250,"h":1250,"click":{"type":"RdshTileClickSetsDimension","dimension":"example"},"keepsOwnRange":true,"thresholds":[{"type":"RdshThresholdAttributes","measure":"example","comparison":"Above","value":"example","tone":"Danger"}],"rowFilters":[{"type":"RdshRowFilterAttributes","dimension":"example","column":"example"}]}]},"filters":{"type":"RdshFiltersAttributes","range":{"type":"RqryRangeBetween","from":"2026-08-19","to":"2026-08-19"},"timezone":"example","dimensionFilters":[{"type":"RdshDimensionFilterAttributes","dimension":"example","operator":"Equals","values":["example"],"fromTile":"example"}],"periodClick":{"type":"RdshPeriodClickAttributes","fromTile":"example","range":{"type":"RqryRangeBetween","from":"2026-08-19","to":"2026-08-19"}}},"access":"Private","tenant":{"type":"RspcTenantEnterprise","enterpriseId":"ent_9f2Kd8QpLzXw"},"ownedByCaller":true,"editable":true,"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z","charts":[{"type":"RchtViewAttributes","reportChartId":"rcht_9f2Kd8QpLzXw","reportSpaceId":"rspc_9f2Kd8QpLzXw","title":"example","question":{"type":"RqryCmdRun","reportDatasetId":"abc123","measures":["example"],"dimensions":["example"],"time":{"type":"RqryTimeSliceAttributes","grain":"example","range":{"type":"RqryRangeBetween","from":"2026-08-19","to":"2026-08-19"},"compare":"PreviousPeriod"},"filters":[{"type":"RqryFilterAbove","dimension":"example","value":"example"}],"sort":[{"type":"RqrySortDimension","dimension":"example","ascending":true}],"limit":25,"page":"example","segments":["example"],"measureFilters":[{"type":"RqryMeasureFilterAbove","measure":"example","value":"example"}],"top":{"type":"RqryTopAttributes","dimension":"example","count":42,"measure":"example"},"narrowTo":{"type":"RqryNarrowCustomers","customerIds":["cust_9f2Kd8QpLzXw"]},"asAt":"2026-08-19T04:21:07Z","pivot":{"type":"RqryPivotAttributes","rows":["example"],"columns":["example"],"subtotals":true},"timezone":"example"},"presentation":{"type":"RchtPresentationAttributes","chartType":"Auto","colours":{"type":"RchtColoursAttributes","palette":"Categorical","overrides":[{"type":"RchtColourOverrideAttributes","series":"example","swatch":"example"}]},"description":"A short description.","riseIs":"Good","stackTotal":"example","referenceLines":[{"type":"RchtReferenceLineConstant","label":"example","value":"example"}],"table":{"type":"RchtTableAttributes","rowLink":"example","statuses":[{"type":"RchtStatusColumnAttributes","column":"example","tones":[{"type":"RchtValueToneAttributes","value":"example","tone":"Danger"}]}]}},"stale":"example","access":"Private","tenant":{"type":"RspcTenantEnterprise","enterpriseId":"ent_9f2Kd8QpLzXw"},"ownedByCaller":true,"editable":true,"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}]}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `RdshCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdshCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/RdshView","description":"The resource that was created."}}},"RdshDimensionFilter":{"description":"A filter on one dimension, applied to every tile whose dataset has it, as a question's filter of its `operator` is. A filter that picks no values filters nothing.","oneOf":[{"$ref":"#/components/schemas/RdshDimensionFilterAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RdshDimensionFilterAttributes":"#/components/schemas/RdshDimensionFilterAttributes"}}},"RdshDimensionFilterAttributes":{"title":"RdshDimensionFilterAttributes","description":"A filter on one dimension, applied to every tile whose dataset has it, as a question's filter of its `operator` is. A filter that picks no values filters nothing.","examples":[{"type":"RdshDimensionFilterAttributes","dimension":"example","operator":"Equals","values":["example"],"fromTile":"example"}],"type":"object","required":["type","dimension"],"properties":{"type":{"description":"Always `RdshDimensionFilterAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdshDimensionFilterAttributes"]},"dimension":{"type":"string"},"operator":{"$ref":"#/components/schemas/RdsetFilterOperator","description":"How it filters, one of the operators the dataset lists for the dimension. Absent for `In`, and a filter read back as `In` has none. `In` and `NotIn` take any number of values, `Between` two, `Absent` none, and every other one value."},"values":{"type":"array","items":{"type":"string"}},"fromTile":{"description":"The tile a click set it from, which keeps showing every value so the others can be clicked: its chart's id, or `<tabId>/<chart id>` on a dashboard with tabs.","type":"string"}}},"RdshFilters":{"oneOf":[{"$ref":"#/components/schemas/RdshFiltersAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RdshFiltersAttributes":"#/components/schemas/RdshFiltersAttributes"}}},"RdshFiltersAttributes":{"title":"RdshFiltersAttributes","description":"What the dashboard opens filtered by.","examples":[{"type":"RdshFiltersAttributes","range":{"type":"RqryRangeBetween","from":"2026-08-19","to":"2026-08-19"},"timezone":"example","dimensionFilters":[{"type":"RdshDimensionFilterAttributes","dimension":"example","operator":"Equals","values":["example"],"fromTile":"example"}],"periodClick":{"type":"RdshPeriodClickAttributes","fromTile":"example","range":{"type":"RqryRangeBetween","from":"2026-08-19","to":"2026-08-19"}}}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `RdshFiltersAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdshFiltersAttributes"]},"range":{"$ref":"#/components/schemas/RqryRange","description":"Replaces every tile's range but those that keep their own. Absent to leave each tile's own."},"timezone":{"description":"Absent to leave each tile's own timezone.","type":"string"},"dimensionFilters":{"type":"array","items":{"$ref":"#/components/schemas/RdshDimensionFilter"}},"periodClick":{"$ref":"#/components/schemas/RdshPeriodClick"}}},"RdshId":{"title":"RdshId","examples":["rdsh_9f2Kd8QpLzXw"],"type":"string"},"RdshInclude":{"title":"RdshInclude","type":"string","enum":["Charts","Unknown"]},"RdshLayout":{"oneOf":[{"$ref":"#/components/schemas/RdshLayoutAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RdshLayoutAttributes":"#/components/schemas/RdshLayoutAttributes"}}},"RdshLayoutAttributes":{"title":"RdshLayoutAttributes","description":"Where each chart sits. A reader is shown the tiles whose charts it may read, and no others; a layout it writes keeps the tiles it was not shown.","examples":[{"type":"RdshLayoutAttributes","tabs":[{"type":"RdshTabAttributes","tabId":"abc123","title":"example"}],"tiles":[{"type":"RdshTileAttributes","reportChartId":"rcht_9f2Kd8QpLzXw","tabId":"abc123","x":1250,"y":1250,"w":1250,"h":1250,"click":{"type":"RdshTileClickSetsDimension","dimension":"example"},"keepsOwnRange":true,"thresholds":[{"type":"RdshThresholdAttributes","measure":"example","comparison":"Above","value":"example","tone":"Danger"}],"rowFilters":[{"type":"RdshRowFilterAttributes","dimension":"example","column":"example"}]}]}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `RdshLayoutAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdshLayoutAttributes"]},"tabs":{"description":"Empty for a dashboard of one page.","type":"array","items":{"$ref":"#/components/schemas/RdshTab"}},"tiles":{"type":"array","items":{"$ref":"#/components/schemas/RdshTile"}}}},"RdshPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/RdshPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RdshPageAttributes":"#/components/schemas/RdshPageAttributes"}}},"RdshPageAttributes":{"title":"RdshPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"RdshPageAttributes","data":[{"type":"RdshViewAttributes","reportDashboardId":"rdsh_9f2Kd8QpLzXw","reportSpaceId":"rspc_9f2Kd8QpLzXw","title":"example","description":"A short description.","layout":{"type":"RdshLayoutAttributes","tabs":[{"type":"RdshTabAttributes","tabId":"abc123","title":"example"}],"tiles":[{"type":"RdshTileAttributes","reportChartId":"rcht_9f2Kd8QpLzXw","tabId":"abc123","x":1250,"y":1250,"w":1250,"h":1250,"click":{"type":"RdshTileClickSetsDimension","dimension":"example"},"keepsOwnRange":true,"thresholds":[{"type":"RdshThresholdAttributes","measure":"example","comparison":"Above","value":"example","tone":"Danger"}],"rowFilters":[{"type":"RdshRowFilterAttributes","dimension":"example","column":"example"}]}]},"filters":{"type":"RdshFiltersAttributes","range":{"type":"RqryRangeBetween","from":"2026-08-19","to":"2026-08-19"},"timezone":"example","dimensionFilters":[{"type":"RdshDimensionFilterAttributes","dimension":"example","operator":"Equals","values":["example"],"fromTile":"example"}],"periodClick":{"type":"RdshPeriodClickAttributes","fromTile":"example","range":{"type":"RqryRangeBetween","from":"2026-08-19","to":"2026-08-19"}}},"access":"Private","tenant":{"type":"RspcTenantEnterprise","enterpriseId":"ent_9f2Kd8QpLzXw"},"ownedByCaller":true,"editable":true,"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z","charts":[{"type":"RchtViewAttributes","reportChartId":"rcht_9f2Kd8QpLzXw","reportSpaceId":"rspc_9f2Kd8QpLzXw","title":"example","question":{"type":"RqryCmdRun","reportDatasetId":"abc123","measures":["example"],"dimensions":["example"],"time":{"type":"RqryTimeSliceAttributes","grain":"example","range":{"type":"RqryRangeBetween","from":"2026-08-19","to":"2026-08-19"},"compare":"PreviousPeriod"},"filters":[{"type":"RqryFilterAbove","dimension":"example","value":"example"}],"sort":[{"type":"RqrySortDimension","dimension":"example","ascending":true}],"limit":25,"page":"example","segments":["example"],"measureFilters":[{"type":"RqryMeasureFilterAbove","measure":"example","value":"example"}],"top":{"type":"RqryTopAttributes","dimension":"example","count":42,"measure":"example"},"narrowTo":{"type":"RqryNarrowCustomers","customerIds":["cust_9f2Kd8QpLzXw"]},"asAt":"2026-08-19T04:21:07Z","pivot":{"type":"RqryPivotAttributes","rows":["example"],"columns":["example"],"subtotals":true},"timezone":"example"},"presentation":{"type":"RchtPresentationAttributes","chartType":"Auto","colours":{"type":"RchtColoursAttributes","palette":"Categorical","overrides":[{"type":"RchtColourOverrideAttributes","series":"example","swatch":"example"}]},"description":"A short description.","riseIs":"Good","stackTotal":"example","referenceLines":[{"type":"RchtReferenceLineConstant","label":"example","value":"example"}],"table":{"type":"RchtTableAttributes","rowLink":"example","statuses":[{"type":"RchtStatusColumnAttributes","column":"example","tones":[{"type":"RchtValueToneAttributes","value":"example","tone":"Danger"}]}]}},"stale":"example","access":"Private","tenant":{"type":"RspcTenantEnterprise","enterpriseId":"ent_9f2Kd8QpLzXw"},"ownedByCaller":true,"editable":true,"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}]}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `RdshPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdshPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/RdshView","description":"Charts laid out together, with tabs, filters and what clicking a tile does."}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"RdshPeriodClick":{"description":"Absent unless `range` was set by clicking a trend tile.","oneOf":[{"$ref":"#/components/schemas/RdshPeriodClickAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RdshPeriodClickAttributes":"#/components/schemas/RdshPeriodClickAttributes"}}},"RdshPeriodClickAttributes":{"title":"RdshPeriodClickAttributes","description":"The period a click on a trend tile set: the dashboard's `range` is the bucket clicked, and the tile clicked keeps the range it showed it in.","examples":[{"type":"RdshPeriodClickAttributes","fromTile":"example","range":{"type":"RqryRangeBetween","from":"2026-08-19","to":"2026-08-19"}}],"type":"object","required":["type","fromTile"],"properties":{"type":{"description":"Always `RdshPeriodClickAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdshPeriodClickAttributes"]},"fromTile":{"description":"The tile clicked: its chart's id, or `<tabId>/<chart id>` on a dashboard with tabs.","type":"string"},"range":{"$ref":"#/components/schemas/RqryRange","description":"The dashboard's range before the click, which the tile clicked keeps. Absent where the dashboard had none, so the tile keeps its chart's own."}}},"RdshPresentation":{"description":"What a dashboard says about itself and what it opens filtered by. Each absent field clears it.","oneOf":[{"$ref":"#/components/schemas/RdshPresentationAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RdshPresentationAttributes":"#/components/schemas/RdshPresentationAttributes"}}},"RdshPresentationAttributes":{"title":"RdshPresentationAttributes","description":"What a dashboard says about itself and what it opens filtered by. Each absent field clears it.","examples":[{"type":"RdshPresentationAttributes","description":"A short description.","filters":{"type":"RdshFiltersAttributes","range":{"type":"RqryRangeBetween","from":"2026-08-19","to":"2026-08-19"},"timezone":"example","dimensionFilters":[{"type":"RdshDimensionFilterAttributes","dimension":"example","operator":"Equals","values":["example"],"fromTile":"example"}],"periodClick":{"type":"RdshPeriodClickAttributes","fromTile":"example","range":{"type":"RqryRangeBetween","from":"2026-08-19","to":"2026-08-19"}}}}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `RdshPresentationAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdshPresentationAttributes"]},"description":{"description":"What the dashboard is for, shown under its title.","type":"string"},"filters":{"$ref":"#/components/schemas/RdshFilters","description":"What the dashboard opens filtered by."}}},"RdshRowFilter":{"oneOf":[{"$ref":"#/components/schemas/RdshRowFilterAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RdshRowFilterAttributes":"#/components/schemas/RdshRowFilterAttributes"}}},"RdshRowFilterAttributes":{"title":"RdshRowFilterAttributes","examples":[{"type":"RdshRowFilterAttributes","dimension":"example","column":"example"}],"type":"object","required":["type","dimension","column"],"properties":{"type":{"description":"Always `RdshRowFilterAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdshRowFilterAttributes"]},"dimension":{"description":"The dashboard filter's dimension.","type":"string"},"column":{"description":"The answer's column whose value the filter's values are matched against.","type":"string"}}},"RdshTab":{"oneOf":[{"$ref":"#/components/schemas/RdshTabAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RdshTabAttributes":"#/components/schemas/RdshTabAttributes"}}},"RdshTabAttributes":{"title":"RdshTabAttributes","examples":[{"type":"RdshTabAttributes","tabId":"abc123","title":"example"}],"type":"object","required":["type","tabId","title"],"properties":{"type":{"description":"Always `RdshTabAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdshTabAttributes"]},"tabId":{"description":"The tab's own id within the dashboard, which its tiles name.","type":"string"},"title":{"type":"string"}}},"RdshThreshold":{"oneOf":[{"$ref":"#/components/schemas/RdshThresholdAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RdshThresholdAttributes":"#/components/schemas/RdshThresholdAttributes"}}},"RdshThresholdAttributes":{"title":"RdshThresholdAttributes","examples":[{"type":"RdshThresholdAttributes","measure":"example","comparison":"Above","value":"example","tone":"Danger"}],"type":"object","required":["type","comparison","value","tone"],"properties":{"type":{"description":"Always `RdshThresholdAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdshThresholdAttributes"]},"measure":{"description":"The measure it judges. Absent for the first measure the chart shows.","type":"string"},"comparison":{"$ref":"#/components/schemas/RdshThresholdComparison"},"value":{"description":"The level, written as a decimal.","type":"string"},"tone":{"$ref":"#/components/schemas/RchtTone"}}},"RdshThresholdComparison":{"title":"RdshThresholdComparison","type":"string","enum":["Above","AtLeast","Below","AtMost","Unknown"]},"RdshTile":{"description":"A chart on the dashboard's grid, which is 24 columns wide and runs down in rows from the top.","oneOf":[{"$ref":"#/components/schemas/RdshTileAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RdshTileAttributes":"#/components/schemas/RdshTileAttributes"}}},"RdshTileAttributes":{"title":"RdshTileAttributes","description":"A chart on the dashboard's grid, which is 24 columns wide and runs down in rows from the top.","examples":[{"type":"RdshTileAttributes","reportChartId":"rcht_9f2Kd8QpLzXw","tabId":"abc123","x":1250,"y":1250,"w":1250,"h":1250,"click":{"type":"RdshTileClickSetsDimension","dimension":"example"},"keepsOwnRange":true,"thresholds":[{"type":"RdshThresholdAttributes","measure":"example","comparison":"Above","value":"example","tone":"Danger"}],"rowFilters":[{"type":"RdshRowFilterAttributes","dimension":"example","column":"example"}]}],"type":"object","required":["type","reportChartId","x","y","w","h","keepsOwnRange"],"properties":{"type":{"description":"Always `RdshTileAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdshTileAttributes"]},"reportChartId":{"$ref":"#/components/schemas/RchtId","description":"Identifier of a saved chart."},"tabId":{"description":"The tab it is on. Absent on a dashboard without tabs, or for the first tab.","type":"string"},"x":{"description":"The column its left edge is in, from 0.","type":"integer","format":"int32"},"y":{"description":"The row its top edge is in, from 0.","type":"integer","format":"int32"},"w":{"description":"Its width, in columns of the 24.","type":"integer","format":"int32"},"h":{"description":"Its height, in rows.","type":"integer","format":"int32"},"click":{"$ref":"#/components/schemas/RdshTileClick"},"keepsOwnRange":{"description":"Keeps the chart's own range whatever period the dashboard is set to, as a year's trend beside a month's figures does.","type":"boolean"},"thresholds":{"description":"Levels the tile's figures are shaded at. A figure takes the tone of the first it passes, so the more severe is listed first.","type":"array","items":{"$ref":"#/components/schemas/RdshThreshold"}},"rowFilters":{"description":"How the tile takes a dashboard filter on a dimension its chart cannot be asked by, such as a band: it keeps the rows whose column holds a value the filter picked.","type":"array","items":{"$ref":"#/components/schemas/RdshRowFilter"}}}},"RdshTileClick":{"oneOf":[{"$ref":"#/components/schemas/RdshTileClickSetsDimension"},{"$ref":"#/components/schemas/RdshTileClickSetsPeriod"}],"discriminator":{"propertyName":"type","mapping":{"RdshTileClickSetsDimension":"#/components/schemas/RdshTileClickSetsDimension","RdshTileClickSetsPeriod":"#/components/schemas/RdshTileClickSetsPeriod"}}},"RdshTileClickSetsDimension":{"title":"RdshTileClickSetsDimension","description":"Filters the dashboard by the value clicked.","examples":[{"type":"RdshTileClickSetsDimension","dimension":"example"}],"type":"object","required":["type","dimension"],"properties":{"type":{"description":"Always `RdshTileClickSetsDimension`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdshTileClickSetsDimension"]},"dimension":{"type":"string"}}},"RdshTileClickSetsPeriod":{"title":"RdshTileClickSetsPeriod","description":"Sets the dashboard's period to the bucket clicked.","examples":[{"type":"RdshTileClickSetsPeriod"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `RdshTileClickSetsPeriod`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdshTileClickSetsPeriod"]}}},"RdshUpdate":{"oneOf":[{"$ref":"#/components/schemas/RdshUpdateMove"},{"$ref":"#/components/schemas/RdshUpdateRename"},{"$ref":"#/components/schemas/RdshUpdateReplaceLayout"},{"$ref":"#/components/schemas/RdshUpdateSetPresentation"}],"discriminator":{"propertyName":"type","mapping":{"RdshUpdateMove":"#/components/schemas/RdshUpdateMove","RdshUpdateRename":"#/components/schemas/RdshUpdateRename","RdshUpdateReplaceLayout":"#/components/schemas/RdshUpdateReplaceLayout","RdshUpdateSetPresentation":"#/components/schemas/RdshUpdateSetPresentation"}}},"RdshUpdateMove":{"title":"RdshUpdateMove","description":"Save it in another space the caller may change, whose viewers may see every chart it shows.","examples":[{"type":"RdshUpdateMove","reportSpaceId":"rspc_9f2Kd8QpLzXw"}],"type":"object","required":["type","reportSpaceId"],"properties":{"type":{"description":"Always `RdshUpdateMove`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdshUpdateMove"]},"reportSpaceId":{"$ref":"#/components/schemas/RspcId","description":"Identifier of a report space."}}},"RdshUpdateRename":{"title":"RdshUpdateRename","examples":[{"type":"RdshUpdateRename","title":"example"}],"type":"object","required":["type","title"],"properties":{"type":{"description":"Always `RdshUpdateRename`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdshUpdateRename"]},"title":{"type":"string"}}},"RdshUpdateReplaceLayout":{"title":"RdshUpdateReplaceLayout","description":"Lay out its tabs and tiles afresh. The tiles the caller is not shown are kept as they were.","examples":[{"type":"RdshUpdateReplaceLayout","layout":{"type":"RdshLayoutAttributes","tabs":[{"type":"RdshTabAttributes","tabId":"abc123","title":"example"}],"tiles":[{"type":"RdshTileAttributes","reportChartId":"rcht_9f2Kd8QpLzXw","tabId":"abc123","x":1250,"y":1250,"w":1250,"h":1250,"click":{"type":"RdshTileClickSetsDimension","dimension":"example"},"keepsOwnRange":true,"thresholds":[{"type":"RdshThresholdAttributes","measure":"example","comparison":"Above","value":"example","tone":"Danger"}],"rowFilters":[{"type":"RdshRowFilterAttributes","dimension":"example","column":"example"}]}]}}],"type":"object","required":["type","layout"],"properties":{"type":{"description":"Always `RdshUpdateReplaceLayout`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdshUpdateReplaceLayout"]},"layout":{"$ref":"#/components/schemas/RdshLayout","description":"Where each chart sits. A reader is shown the tiles whose charts it may read, and no others; a layout it writes keeps the tiles it was not shown."}}},"RdshUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/RdshUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RdshUpdateRspAttributes":"#/components/schemas/RdshUpdateRspAttributes"}}},"RdshUpdateRspAttributes":{"title":"RdshUpdateRspAttributes","examples":[{"type":"RdshUpdateRspAttributes","updated":{"type":"RdshViewAttributes","reportDashboardId":"rdsh_9f2Kd8QpLzXw","reportSpaceId":"rspc_9f2Kd8QpLzXw","title":"example","description":"A short description.","layout":{"type":"RdshLayoutAttributes","tabs":[{"type":"RdshTabAttributes","tabId":"abc123","title":"example"}],"tiles":[{"type":"RdshTileAttributes","reportChartId":"rcht_9f2Kd8QpLzXw","tabId":"abc123","x":1250,"y":1250,"w":1250,"h":1250,"click":{"type":"RdshTileClickSetsDimension","dimension":"example"},"keepsOwnRange":true,"thresholds":[{"type":"RdshThresholdAttributes","measure":"example","comparison":"Above","value":"example","tone":"Danger"}],"rowFilters":[{"type":"RdshRowFilterAttributes","dimension":"example","column":"example"}]}]},"filters":{"type":"RdshFiltersAttributes","range":{"type":"RqryRangeBetween","from":"2026-08-19","to":"2026-08-19"},"timezone":"example","dimensionFilters":[{"type":"RdshDimensionFilterAttributes","dimension":"example","operator":"Equals","values":["example"],"fromTile":"example"}],"periodClick":{"type":"RdshPeriodClickAttributes","fromTile":"example","range":{"type":"RqryRangeBetween","from":"2026-08-19","to":"2026-08-19"}}},"access":"Private","tenant":{"type":"RspcTenantEnterprise","enterpriseId":"ent_9f2Kd8QpLzXw"},"ownedByCaller":true,"editable":true,"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z","charts":[{"type":"RchtViewAttributes","reportChartId":"rcht_9f2Kd8QpLzXw","reportSpaceId":"rspc_9f2Kd8QpLzXw","title":"example","question":{"type":"RqryCmdRun","reportDatasetId":"abc123","measures":["example"],"dimensions":["example"],"time":{"type":"RqryTimeSliceAttributes","grain":"example","range":{"type":"RqryRangeBetween","from":"2026-08-19","to":"2026-08-19"},"compare":"PreviousPeriod"},"filters":[{"type":"RqryFilterAbove","dimension":"example","value":"example"}],"sort":[{"type":"RqrySortDimension","dimension":"example","ascending":true}],"limit":25,"page":"example","segments":["example"],"measureFilters":[{"type":"RqryMeasureFilterAbove","measure":"example","value":"example"}],"top":{"type":"RqryTopAttributes","dimension":"example","count":42,"measure":"example"},"narrowTo":{"type":"RqryNarrowCustomers","customerIds":["cust_9f2Kd8QpLzXw"]},"asAt":"2026-08-19T04:21:07Z","pivot":{"type":"RqryPivotAttributes","rows":["example"],"columns":["example"],"subtotals":true},"timezone":"example"},"presentation":{"type":"RchtPresentationAttributes","chartType":"Auto","colours":{"type":"RchtColoursAttributes","palette":"Categorical","overrides":[{"type":"RchtColourOverrideAttributes","series":"example","swatch":"example"}]},"description":"A short description.","riseIs":"Good","stackTotal":"example","referenceLines":[{"type":"RchtReferenceLineConstant","label":"example","value":"example"}],"table":{"type":"RchtTableAttributes","rowLink":"example","statuses":[{"type":"RchtStatusColumnAttributes","column":"example","tones":[{"type":"RchtValueToneAttributes","value":"example","tone":"Danger"}]}]}},"stale":"example","access":"Private","tenant":{"type":"RspcTenantEnterprise","enterpriseId":"ent_9f2Kd8QpLzXw"},"ownedByCaller":true,"editable":true,"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}]}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `RdshUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdshUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/RdshView","description":"The resource as it stands after the change."}}},"RdshUpdateSetPresentation":{"title":"RdshUpdateSetPresentation","description":"Set what it says about itself and what it opens filtered by.","examples":[{"type":"RdshUpdateSetPresentation","presentation":{"type":"RdshPresentationAttributes","description":"A short description.","filters":{"type":"RdshFiltersAttributes","range":{"type":"RqryRangeBetween","from":"2026-08-19","to":"2026-08-19"},"timezone":"example","dimensionFilters":[{"type":"RdshDimensionFilterAttributes","dimension":"example","operator":"Equals","values":["example"],"fromTile":"example"}],"periodClick":{"type":"RdshPeriodClickAttributes","fromTile":"example","range":{"type":"RqryRangeBetween","from":"2026-08-19","to":"2026-08-19"}}}}}],"type":"object","required":["type","presentation"],"properties":{"type":{"description":"Always `RdshUpdateSetPresentation`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdshUpdateSetPresentation"]},"presentation":{"$ref":"#/components/schemas/RdshPresentation"}}},"RdshView":{"oneOf":[{"$ref":"#/components/schemas/RdshViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RdshViewAttributes":"#/components/schemas/RdshViewAttributes"}}},"RdshViewAttributes":{"title":"RdshViewAttributes","description":"Charts laid out together, with tabs, filters and what clicking a tile does.","examples":[{"type":"RdshViewAttributes","reportDashboardId":"rdsh_9f2Kd8QpLzXw","reportSpaceId":"rspc_9f2Kd8QpLzXw","title":"example","description":"A short description.","layout":{"type":"RdshLayoutAttributes","tabs":[{"type":"RdshTabAttributes","tabId":"abc123","title":"example"}],"tiles":[{"type":"RdshTileAttributes","reportChartId":"rcht_9f2Kd8QpLzXw","tabId":"abc123","x":1250,"y":1250,"w":1250,"h":1250,"click":{"type":"RdshTileClickSetsDimension","dimension":"example"},"keepsOwnRange":true,"thresholds":[{"type":"RdshThresholdAttributes","measure":"example","comparison":"Above","value":"example","tone":"Danger"}],"rowFilters":[{"type":"RdshRowFilterAttributes","dimension":"example","column":"example"}]}]},"filters":{"type":"RdshFiltersAttributes","range":{"type":"RqryRangeBetween","from":"2026-08-19","to":"2026-08-19"},"timezone":"example","dimensionFilters":[{"type":"RdshDimensionFilterAttributes","dimension":"example","operator":"Equals","values":["example"],"fromTile":"example"}],"periodClick":{"type":"RdshPeriodClickAttributes","fromTile":"example","range":{"type":"RqryRangeBetween","from":"2026-08-19","to":"2026-08-19"}}},"access":"Private","tenant":{"type":"RspcTenantEnterprise","enterpriseId":"ent_9f2Kd8QpLzXw"},"ownedByCaller":true,"editable":true,"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z","charts":[{"type":"RchtViewAttributes","reportChartId":"rcht_9f2Kd8QpLzXw","reportSpaceId":"rspc_9f2Kd8QpLzXw","title":"example","question":{"type":"RqryCmdRun","reportDatasetId":"abc123","measures":["example"],"dimensions":["example"],"time":{"type":"RqryTimeSliceAttributes","grain":"example","range":{"type":"RqryRangeBetween","from":"2026-08-19","to":"2026-08-19"},"compare":"PreviousPeriod"},"filters":[{"type":"RqryFilterAbove","dimension":"example","value":"example"}],"sort":[{"type":"RqrySortDimension","dimension":"example","ascending":true}],"limit":25,"page":"example","segments":["example"],"measureFilters":[{"type":"RqryMeasureFilterAbove","measure":"example","value":"example"}],"top":{"type":"RqryTopAttributes","dimension":"example","count":42,"measure":"example"},"narrowTo":{"type":"RqryNarrowCustomers","customerIds":["cust_9f2Kd8QpLzXw"]},"asAt":"2026-08-19T04:21:07Z","pivot":{"type":"RqryPivotAttributes","rows":["example"],"columns":["example"],"subtotals":true},"timezone":"example"},"presentation":{"type":"RchtPresentationAttributes","chartType":"Auto","colours":{"type":"RchtColoursAttributes","palette":"Categorical","overrides":[{"type":"RchtColourOverrideAttributes","series":"example","swatch":"example"}]},"description":"A short description.","riseIs":"Good","stackTotal":"example","referenceLines":[{"type":"RchtReferenceLineConstant","label":"example","value":"example"}],"table":{"type":"RchtTableAttributes","rowLink":"example","statuses":[{"type":"RchtStatusColumnAttributes","column":"example","tones":[{"type":"RchtValueToneAttributes","value":"example","tone":"Danger"}]}]}},"stale":"example","access":"Private","tenant":{"type":"RspcTenantEnterprise","enterpriseId":"ent_9f2Kd8QpLzXw"},"ownedByCaller":true,"editable":true,"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}]}],"type":"object","required":["type","reportDashboardId","reportSpaceId","title","layout","access","tenant","ownedByCaller","editable","createdAt","updatedAt"],"properties":{"type":{"description":"Always `RdshViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RdshViewAttributes"]},"reportDashboardId":{"$ref":"#/components/schemas/RdshId","description":"Identifier of a saved dashboard."},"reportSpaceId":{"$ref":"#/components/schemas/RspcId","description":"Identifier of a report space."},"title":{"type":"string"},"description":{"description":"What the dashboard is for, shown under its title.","type":"string"},"layout":{"$ref":"#/components/schemas/RdshLayout","description":"Where each chart sits. A reader is shown the tiles whose charts it may read, and no others; a layout it writes keeps the tiles it was not shown."},"filters":{"$ref":"#/components/schemas/RdshFilters","description":"What the dashboard opens filtered by."},"access":{"$ref":"#/components/schemas/RspcAccess"},"tenant":{"$ref":"#/components/schemas/RspcTenant"},"ownedByCaller":{"type":"boolean"},"editable":{"description":"Whether the caller may change, move or delete it.","type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"charts":{"description":"The charts the tiles show that the caller may read, each as `GET /report-charts/{id}` returns it, in tile order and each once. `null` unless the read asked for `include=Charts`.","type":"array","items":{"$ref":"#/components/schemas/RchtView","description":"A saved question and how it is drawn. A dashboard's tiles show charts, and a change to a chart reaches every dashboard showing it."}}}},"RefAuBranchEntry":{"description":"One Australian branch, for a register load.","oneOf":[{"$ref":"#/components/schemas/RefAuBranchEntryAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RefAuBranchEntryAttributes":"#/components/schemas/RefAuBranchEntryAttributes"}}},"RefAuBranchEntryAttributes":{"title":"RefAuBranchEntryAttributes","description":"One Australian branch, for a register load.","examples":[{"type":"RefAuBranchEntryAttributes","bsb":"example","bankName":"Ada Lovelace"}],"type":"object","required":["type","bsb","bankName"],"properties":{"type":{"description":"Always `RefAuBranchEntryAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RefAuBranchEntryAttributes"]},"bsb":{"type":"string"},"bankName":{"type":"string"}}},"RefCmd":{"oneOf":[{"$ref":"#/components/schemas/RefCmdListIndustries"},{"$ref":"#/components/schemas/RefCmdLoadAuRegister"},{"$ref":"#/components/schemas/RefCmdLoadNzRegister"},{"$ref":"#/components/schemas/RefCmdLookupBsb"},{"$ref":"#/components/schemas/RefCmdLookupNzPrefix"}],"discriminator":{"propertyName":"type","mapping":{"RefCmdListIndustries":"#/components/schemas/RefCmdListIndustries","RefCmdLoadAuRegister":"#/components/schemas/RefCmdLoadAuRegister","RefCmdLoadNzRegister":"#/components/schemas/RefCmdLoadNzRegister","RefCmdLookupBsb":"#/components/schemas/RefCmdLookupBsb","RefCmdLookupNzPrefix":"#/components/schemas/RefCmdLookupNzPrefix"}}},"RefCmdListIndustries":{"title":"RefCmdListIndustries","description":"Ask which industries the platform recognises. Answers `RefViewIndustries`, the whole list.","examples":[{"type":"RefCmdListIndustries"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `RefCmdListIndustries`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RefCmdListIndustries"]}}},"RefCmdLoadAuRegister":{"title":"RefCmdLoadAuRegister","description":"Replace the Australian bank-branch register with these branches. Bulk, and it does not merge.","examples":[{"type":"RefCmdLoadAuRegister","branches":[{"type":"RefAuBranchEntryAttributes","bsb":"example","bankName":"Ada Lovelace"}]}],"type":"object","required":["type","branches"],"properties":{"type":{"description":"Always `RefCmdLoadAuRegister`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RefCmdLoadAuRegister"]},"branches":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/RefAuBranchEntry"}}}},"RefCmdLoadNzRegister":{"title":"RefCmdLoadNzRegister","description":"Replace the New Zealand bank-branch register with these branches.","examples":[{"type":"RefCmdLoadNzRegister","branches":[{"type":"RefNzBranchEntryAttributes","bankNumber":"example","branchNumber":"example","bankName":"Ada Lovelace"}]}],"type":"object","required":["type","branches"],"properties":{"type":{"description":"Always `RefCmdLoadNzRegister`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RefCmdLoadNzRegister"]},"branches":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/RefNzBranchEntry"}}}},"RefCmdLookupBsb":{"title":"RefCmdLookupBsb","description":"Find an Australian bank branch by its BSB. Matches at most one.","examples":[{"type":"RefCmdLookupBsb","bsb":"example"}],"type":"object","required":["type","bsb"],"properties":{"type":{"description":"Always `RefCmdLookupBsb`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RefCmdLookupBsb"]},"bsb":{"description":"Bank-state-branch, six digits.","type":"string"}}},"RefCmdLookupNzPrefix":{"title":"RefCmdLookupNzPrefix","description":"Find a New Zealand bank branch by an account prefix, the bank and branch numbers together.","examples":[{"type":"RefCmdLookupNzPrefix","accountPrefix":"example"}],"type":"object","required":["type","accountPrefix"],"properties":{"type":{"description":"Always `RefCmdLookupNzPrefix`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RefCmdLookupNzPrefix"]},"accountPrefix":{"description":"The first six digits of a New Zealand account number: two for the bank, four for the branch.","type":"string"}}},"RefCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/RefCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RefCreateRspAttributes":"#/components/schemas/RefCreateRspAttributes"}}},"RefCreateRspAttributes":{"title":"RefCreateRspAttributes","examples":[{"type":"RefCreateRspAttributes","created":{"type":"RefViewAuBranch","bsb":"example","bankName":"Ada Lovelace"}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `RefCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RefCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/RefView"}}},"RefIndustry":{"description":"One industry the platform recognises.","oneOf":[{"$ref":"#/components/schemas/RefIndustryAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RefIndustryAttributes":"#/components/schemas/RefIndustryAttributes"}}},"RefIndustryAttributes":{"title":"RefIndustryAttributes","description":"One industry the platform recognises.","examples":[{"type":"RefIndustryAttributes","name":"Ada Lovelace","description":"A short description.","mcc":"example"}],"type":"object","required":["type","name","description","mcc"],"properties":{"type":{"description":"Always `RefIndustryAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RefIndustryAttributes"]},"name":{"description":"The value to send as `industry`, `AcRefrigerationRepair`.","type":"string"},"description":{"description":"What it means, for showing a person, `A/C, Refrigeration Repair`.","type":"string"},"mcc":{"description":"ISO 18245 merchant category code, four digits.","type":"string"}}},"RefNzBranchEntry":{"description":"One New Zealand branch, for a register load.","oneOf":[{"$ref":"#/components/schemas/RefNzBranchEntryAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RefNzBranchEntryAttributes":"#/components/schemas/RefNzBranchEntryAttributes"}}},"RefNzBranchEntryAttributes":{"title":"RefNzBranchEntryAttributes","description":"One New Zealand branch, for a register load.","examples":[{"type":"RefNzBranchEntryAttributes","bankNumber":"example","branchNumber":"example","bankName":"Ada Lovelace"}],"type":"object","required":["type","bankNumber","branchNumber","bankName"],"properties":{"type":{"description":"Always `RefNzBranchEntryAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RefNzBranchEntryAttributes"]},"bankNumber":{"type":"string"},"branchNumber":{"type":"string"},"bankName":{"type":"string"}}},"RefView":{"description":"The resource that was created.","oneOf":[{"$ref":"#/components/schemas/RefViewAuBranch"},{"$ref":"#/components/schemas/RefViewIndustries"},{"$ref":"#/components/schemas/RefViewNzBranch"}],"discriminator":{"propertyName":"type","mapping":{"RefViewAuBranch":"#/components/schemas/RefViewAuBranch","RefViewIndustries":"#/components/schemas/RefViewIndustries","RefViewNzBranch":"#/components/schemas/RefViewNzBranch"}}},"RefViewAuBranch":{"title":"RefViewAuBranch","description":"A branch of an Australian bank, identified by its BSB.","examples":[{"type":"RefViewAuBranch","bsb":"example","bankName":"Ada Lovelace"}],"type":"object","required":["type","bsb","bankName"],"properties":{"type":{"description":"Always `RefViewAuBranch`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RefViewAuBranch"]},"bsb":{"description":"Bank-state-branch, six digits.","type":"string"},"bankName":{"type":"string"}}},"RefViewIndustries":{"title":"RefViewIndustries","description":"The industries the platform recognises, with their ISO 18245 category codes.","examples":[{"type":"RefViewIndustries","industries":[{"type":"RefIndustryAttributes","name":"Ada Lovelace","description":"A short description.","mcc":"example"}]}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `RefViewIndustries`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RefViewIndustries"]},"industries":{"type":"array","items":{"$ref":"#/components/schemas/RefIndustry"}}}},"RefViewNzBranch":{"title":"RefViewNzBranch","description":"A branch of a New Zealand bank, identified by its bank and branch numbers.","examples":[{"type":"RefViewNzBranch","bankNumber":"example","branchNumber":"example","bankName":"Ada Lovelace"}],"type":"object","required":["type","bankNumber","branchNumber","bankName"],"properties":{"type":{"description":"Always `RefViewNzBranch`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RefViewNzBranch"]},"bankNumber":{"description":"The bank's number, the first two digits of an account number.","type":"string"},"branchNumber":{"description":"The branch's number, the next four.","type":"string"},"bankName":{"type":"string"}}},"Rexp":{"description":"The resource that was created.","oneOf":[{"$ref":"#/components/schemas/RexpAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RexpAttributes":"#/components/schemas/RexpAttributes"}}},"RexpAttributes":{"title":"RexpAttributes","description":"A question's whole answer, as a file. Nothing is stored, so keep it; with `Accept: text/csv` the answer is the file itself.","examples":[{"type":"RexpAttributes","reportDatasetId":"abc123","columns":[{"type":"RqryColumnAttributes","role":"Time","name":"Ada Lovelace","grain":"example","axis":"Rows"}],"rowCount":42,"asOf":"2026-08-19T04:21:07Z","timezone":"example","csv":"example"}],"type":"object","required":["type","reportDatasetId","rowCount","asOf","timezone","csv"],"properties":{"type":{"description":"Always `RexpAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RexpAttributes"]},"reportDatasetId":{"type":"string"},"columns":{"description":"One per field of every line of `csv` after the level fields, in the same order.","type":"array","items":{"$ref":"#/components/schemas/RqryColumn"}},"rowCount":{"description":"How many rows the file holds, not counting its header.","type":"integer","format":"int32"},"asOf":{"description":"The instant the answer is complete to.","type":"string","format":"date-time"},"timezone":{"description":"The timezone the answer was bucketed in, an IANA name or an offset.","type":"string"},"csv":{"description":"RFC 4180 CSV: a header naming each column, then a line per row, each cell as a question's answer writes it. A pivot's or a top's lines begin with the row's `level` and a subtotal's `depth`. A text cell a spreadsheet would read as a formula begins with a quote.","type":"string"}}},"RexpCmd":{"description":"Export a question's whole answer, every row rather than a page, up to 100,000 rows. It is refused rather than cut short when the answer holds more. A comparison, a rolling or running measure and a converted one are computed after the query, so they are asked as questions.","oneOf":[{"$ref":"#/components/schemas/RexpCmdRun"}],"discriminator":{"propertyName":"type","mapping":{"RexpCmdRun":"#/components/schemas/RexpCmdRun"}}},"RexpCmdRun":{"title":"RexpCmdRun","description":"Export a question's whole answer, every row rather than a page, up to 100,000 rows. It is refused rather than cut short when the answer holds more. A comparison, a rolling or running measure and a converted one are computed after the query, so they are asked as questions.","examples":[{"type":"RexpCmdRun","question":{"type":"RqryCmdRun","reportDatasetId":"abc123","measures":["example"],"dimensions":["example"],"time":{"type":"RqryTimeSliceAttributes","grain":"example","range":{"type":"RqryRangeBetween","from":"2026-08-19","to":"2026-08-19"},"compare":"PreviousPeriod"},"filters":[{"type":"RqryFilterAbove","dimension":"example","value":"example"}],"sort":[{"type":"RqrySortDimension","dimension":"example","ascending":true}],"limit":25,"page":"example","segments":["example"],"measureFilters":[{"type":"RqryMeasureFilterAbove","measure":"example","value":"example"}],"top":{"type":"RqryTopAttributes","dimension":"example","count":42,"measure":"example"},"narrowTo":{"type":"RqryNarrowCustomers","customerIds":["cust_9f2Kd8QpLzXw"]},"asAt":"2026-08-19T04:21:07Z","pivot":{"type":"RqryPivotAttributes","rows":["example"],"columns":["example"],"subtotals":true},"timezone":"example"}}],"type":"object","required":["type","question"],"properties":{"type":{"description":"Always `RexpCmdRun`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RexpCmdRun"]},"question":{"$ref":"#/components/schemas/RqryCmdRun"}}},"RexpCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/RexpCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RexpCreateRspAttributes":"#/components/schemas/RexpCreateRspAttributes"}}},"RexpCreateRspAttributes":{"title":"RexpCreateRspAttributes","examples":[{"type":"RexpCreateRspAttributes","created":{"type":"RexpAttributes","reportDatasetId":"abc123","columns":[{"type":"RqryColumnAttributes","role":"Time","name":"Ada Lovelace","grain":"example","axis":"Rows"}],"rowCount":42,"asOf":"2026-08-19T04:21:07Z","timezone":"example","csv":"example"}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `RexpCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RexpCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/Rexp"}}},"RfndAmounts":{"description":"A refund and the transaction it came from. Both are in the single currency given here.","oneOf":[{"$ref":"#/components/schemas/RfndAmountsAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RfndAmountsAttributes":"#/components/schemas/RfndAmountsAttributes"}}},"RfndAmountsAttributes":{"title":"RfndAmountsAttributes","description":"A refund and the transaction it came from. Both are in the single currency given here.","examples":[{"type":"RfndAmountsAttributes","currency":"AUD","amount":1250,"transactionAmount":1250}],"type":"object","required":["type","currency","amount"],"properties":{"type":{"description":"Always `RfndAmountsAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RfndAmountsAttributes"]},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"amount":{"$ref":"#/components/schemas/MinorUnits","description":"How much came back."},"transactionAmount":{"$ref":"#/components/schemas/MinorUnits","description":"What the original transaction was for, beside what came back."}}},"RfndCmd":{"oneOf":[{"$ref":"#/components/schemas/RfndCmdCreate"}],"discriminator":{"propertyName":"type","mapping":{"RfndCmdCreate":"#/components/schemas/RfndCmdCreate"}}},"RfndCmdCreate":{"title":"RfndCmdCreate","description":"Refund part or all of a transaction.","examples":[{"type":"RfndCmdCreate","subject":{"type":"RfndSubjectTransaction","transactionId":"tran_9f2Kd8QpLzXw"},"amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"metadata":{"yourKey":{}}}],"type":"object","required":["type","subject"],"properties":{"type":{"description":"Always `RfndCmdCreate`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RfndCmdCreate"]},"subject":{"$ref":"#/components/schemas/RfndSubject"},"amount":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"How much to refund. Omit to refund everything not yet refunded."},"metadata":{"$ref":"#/components/schemas/Metadata","description":"Free-form data the platform stores against the refund and returns untouched."}}},"RfndColumn":{"title":"RfndColumn","type":"string","enum":["RefundId","MerchantId","CustomerCustomerId","CustomerName","CustomerEmailAddress","CustomerPhoneNumber","Status","AmountsCurrency","AmountsAmount","AmountsTransactionAmount","OrderId","ReferenceOrderId","PayoutId","SettlementDate","Attempts","LastError","CreatedAt","RefundedAt","UpdatedAt"]},"RfndCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/RfndCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RfndCreateRspAttributes":"#/components/schemas/RfndCreateRspAttributes"}}},"RfndCreateRspAttributes":{"title":"RfndCreateRspAttributes","examples":[{"type":"RfndCreateRspAttributes","created":{"type":"RfndViewAttributes","refundId":"rfnd_9f2Kd8QpLzXw","subject":{"type":"RfndSubjectTransaction","transactionId":"tran_9f2Kd8QpLzXw"},"merchantId":"mcht_9f2Kd8QpLzXw","customer":{"type":"RfndCustomerAttributes","customerId":"cust_9f2Kd8QpLzXw","name":"Ada Lovelace","emailAddress":"ada@example.com","phoneNumber":"+61400000000"},"status":"Pending","amounts":{"type":"RfndAmountsAttributes","currency":"AUD","amount":1250,"transactionAmount":1250},"orderId":"ordr_9f2Kd8QpLzXw","referenceOrderId":"your-own-reference","orderMetadata":{"yourKey":{}},"payoutId":"payout_9f2Kd8QpLzXw","settlementDate":"2026-08-19","attempts":1250,"lastError":"example","createdAt":"2026-08-19T04:21:07Z","refundedAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `RfndCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RfndCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/RfndView","description":"The resource that was created."}}},"RfndCustomer":{"oneOf":[{"$ref":"#/components/schemas/RfndCustomerAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RfndCustomerAttributes":"#/components/schemas/RfndCustomerAttributes"}}},"RfndCustomerAttributes":{"title":"RfndCustomerAttributes","description":"Who was paid back.","examples":[{"type":"RfndCustomerAttributes","customerId":"cust_9f2Kd8QpLzXw","name":"Ada Lovelace","emailAddress":"ada@example.com","phoneNumber":"+61400000000"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `RfndCustomerAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RfndCustomerAttributes"]},"customerId":{"$ref":"#/components/schemas/CustId","description":"Identifier of a customer."},"name":{"description":"The customer's display name.","type":"string"},"emailAddress":{"description":"Absent unless the principal may read customer PII.","type":"string"},"phoneNumber":{"description":"Absent unless the principal may read customer PII.","type":"string"}}},"RfndId":{"title":"RfndId","examples":["rfnd_9f2Kd8QpLzXw"],"type":"string"},"RfndPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/RfndPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RfndPageAttributes":"#/components/schemas/RfndPageAttributes"}}},"RfndPageAttributes":{"title":"RfndPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"RfndPageAttributes","data":[{"type":"RfndViewAttributes","refundId":"rfnd_9f2Kd8QpLzXw","subject":{"type":"RfndSubjectTransaction","transactionId":"tran_9f2Kd8QpLzXw"},"merchantId":"mcht_9f2Kd8QpLzXw","customer":{"type":"RfndCustomerAttributes","customerId":"cust_9f2Kd8QpLzXw","name":"Ada Lovelace","emailAddress":"ada@example.com","phoneNumber":"+61400000000"},"status":"Pending","amounts":{"type":"RfndAmountsAttributes","currency":"AUD","amount":1250,"transactionAmount":1250},"orderId":"ordr_9f2Kd8QpLzXw","referenceOrderId":"your-own-reference","orderMetadata":{"yourKey":{}},"payoutId":"payout_9f2Kd8QpLzXw","settlementDate":"2026-08-19","attempts":1250,"lastError":"example","createdAt":"2026-08-19T04:21:07Z","refundedAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `RfndPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RfndPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/RfndView","description":"A refund of part or all of a transaction."}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"RfndStatus":{"title":"RfndStatus","type":"string","enum":["Pending","Refunded","Settled","Reversed","Unknown"]},"RfndSubject":{"oneOf":[{"$ref":"#/components/schemas/RfndSubjectTransaction"}],"discriminator":{"propertyName":"type","mapping":{"RfndSubjectTransaction":"#/components/schemas/RfndSubjectTransaction"}}},"RfndSubjectTransaction":{"title":"RfndSubjectTransaction","description":"A refund of a payment taken from a customer, the acquiring side.","examples":[{"type":"RfndSubjectTransaction","transactionId":"tran_9f2Kd8QpLzXw"}],"type":"object","required":["type","transactionId"],"properties":{"type":{"description":"Always `RfndSubjectTransaction`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RfndSubjectTransaction"]},"transactionId":{"$ref":"#/components/schemas/TranId","description":"Identifier of a transaction."}}},"RfndView":{"oneOf":[{"$ref":"#/components/schemas/RfndViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RfndViewAttributes":"#/components/schemas/RfndViewAttributes"}}},"RfndViewAttributes":{"title":"RfndViewAttributes","description":"A refund of part or all of a transaction.","examples":[{"type":"RfndViewAttributes","refundId":"rfnd_9f2Kd8QpLzXw","subject":{"type":"RfndSubjectTransaction","transactionId":"tran_9f2Kd8QpLzXw"},"merchantId":"mcht_9f2Kd8QpLzXw","customer":{"type":"RfndCustomerAttributes","customerId":"cust_9f2Kd8QpLzXw","name":"Ada Lovelace","emailAddress":"ada@example.com","phoneNumber":"+61400000000"},"status":"Pending","amounts":{"type":"RfndAmountsAttributes","currency":"AUD","amount":1250,"transactionAmount":1250},"orderId":"ordr_9f2Kd8QpLzXw","referenceOrderId":"your-own-reference","orderMetadata":{"yourKey":{}},"payoutId":"payout_9f2Kd8QpLzXw","settlementDate":"2026-08-19","attempts":1250,"lastError":"example","createdAt":"2026-08-19T04:21:07Z","refundedAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","refundId","subject","merchantId","customer","status","amounts","attempts","createdAt","updatedAt"],"properties":{"type":{"description":"Always `RfndViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RfndViewAttributes"]},"refundId":{"$ref":"#/components/schemas/RfndId","description":"Identifier of a refund."},"subject":{"$ref":"#/components/schemas/RfndSubject","description":"The transaction this refund came from, acquiring or issuing."},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"Identifier of a merchant."},"customer":{"$ref":"#/components/schemas/RfndCustomer","description":"Who was paid back."},"status":{"$ref":"#/components/schemas/RfndStatus"},"amounts":{"$ref":"#/components/schemas/RfndAmounts"},"orderId":{"$ref":"#/components/schemas/OrdrId","description":"The order the refunded payment settled."},"referenceOrderId":{"description":"Your own reference for that order.","type":"string"},"orderMetadata":{"$ref":"#/components/schemas/Metadata","description":"Free-form data carried on the order. Absent unless the principal may read order PII."},"payoutId":{"$ref":"#/components/schemas/PayoutId","description":"The payout this refund was deducted from. Absent unless the principal may read merchant financials."},"settlementDate":{"description":"The date the payout carrying this refund settles.","type":"string","format":"date"},"attempts":{"description":"How many times the platform has attempted this refund with the gateway.","type":"integer","format":"int32"},"lastError":{"description":"What the gateway said when the refund last failed.","type":"string"},"createdAt":{"type":"string","format":"date-time"},"refundedAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"RhidCmd":{"oneOf":[{"$ref":"#/components/schemas/RhidCmdCreate"}],"discriminator":{"propertyName":"type","mapping":{"RhidCmdCreate":"#/components/schemas/RhidCmdCreate"}}},"RhidCmdCreate":{"title":"RhidCmdCreate","description":"Hide a dashboard the caller can read. Hiding one already hidden answers its hide.","examples":[{"type":"RhidCmdCreate","reportDashboardId":"rdsh_9f2Kd8QpLzXw"}],"type":"object","required":["type","reportDashboardId"],"properties":{"type":{"description":"Always `RhidCmdCreate`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RhidCmdCreate"]},"reportDashboardId":{"$ref":"#/components/schemas/RdshId","description":"Identifier of a saved dashboard."}}},"RhidColumn":{"title":"RhidColumn","type":"string","enum":["ReportHiddenDashboardId","ReportDashboardId","CreatedAt"]},"RhidCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/RhidCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RhidCreateRspAttributes":"#/components/schemas/RhidCreateRspAttributes"}}},"RhidCreateRspAttributes":{"title":"RhidCreateRspAttributes","examples":[{"type":"RhidCreateRspAttributes","created":{"type":"RhidViewAttributes","reportHiddenDashboardId":"rhid_9f2Kd8QpLzXw","reportDashboardId":"rdsh_9f2Kd8QpLzXw","createdAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `RhidCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RhidCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/RhidView","description":"The resource that was created."}}},"RhidId":{"title":"RhidId","description":"Identifier of a dashboard the caller has hidden.","examples":["rhid_9f2Kd8QpLzXw"],"type":"string"},"RhidPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/RhidPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RhidPageAttributes":"#/components/schemas/RhidPageAttributes"}}},"RhidPageAttributes":{"title":"RhidPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"RhidPageAttributes","data":[{"type":"RhidViewAttributes","reportHiddenDashboardId":"rhid_9f2Kd8QpLzXw","reportDashboardId":"rdsh_9f2Kd8QpLzXw","createdAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `RhidPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RhidPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/RhidView","description":"A dashboard the caller has hidden from its own navigation, under the tenant it signed in to. It is hidden from no one else."}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"RhidView":{"oneOf":[{"$ref":"#/components/schemas/RhidViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RhidViewAttributes":"#/components/schemas/RhidViewAttributes"}}},"RhidViewAttributes":{"title":"RhidViewAttributes","description":"A dashboard the caller has hidden from its own navigation, under the tenant it signed in to. It is hidden from no one else.","examples":[{"type":"RhidViewAttributes","reportHiddenDashboardId":"rhid_9f2Kd8QpLzXw","reportDashboardId":"rdsh_9f2Kd8QpLzXw","createdAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","reportHiddenDashboardId","reportDashboardId","createdAt"],"properties":{"type":{"description":"Always `RhidViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RhidViewAttributes"]},"reportHiddenDashboardId":{"$ref":"#/components/schemas/RhidId"},"reportDashboardId":{"$ref":"#/components/schemas/RdshId","description":"Identifier of a saved dashboard."},"createdAt":{"type":"string","format":"date-time"}}},"RnbkCell":{"oneOf":[{"$ref":"#/components/schemas/RnbkCellHidden"},{"$ref":"#/components/schemas/RnbkCellMarkdown"},{"$ref":"#/components/schemas/RnbkCellQuestion"}],"discriminator":{"propertyName":"type","mapping":{"RnbkCellHidden":"#/components/schemas/RnbkCellHidden","RnbkCellMarkdown":"#/components/schemas/RnbkCellMarkdown","RnbkCellQuestion":"#/components/schemas/RnbkCellQuestion"}}},"RnbkCellHidden":{"title":"RnbkCellHidden","description":"A question the caller may not read, shown only by its place. Writing the notebook's cells with `RnbkDraftCellKept` in its place keeps it.","examples":[{"type":"RnbkCellHidden","cellId":"abc123"}],"type":"object","required":["type","cellId"],"properties":{"type":{"description":"Always `RnbkCellHidden`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RnbkCellHidden"]},"cellId":{"type":"string"}}},"RnbkCellMarkdown":{"title":"RnbkCellMarkdown","description":"A note, as Markdown.","examples":[{"type":"RnbkCellMarkdown","cellId":"abc123","text":"example"}],"type":"object","required":["type","cellId","text"],"properties":{"type":{"description":"Always `RnbkCellMarkdown`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RnbkCellMarkdown"]},"cellId":{"type":"string"},"text":{"type":"string"}}},"RnbkCellQuestion":{"title":"RnbkCellQuestion","description":"A question, saved without its answer, so a notebook is always asked afresh.","examples":[{"type":"RnbkCellQuestion","cellId":"abc123","question":{"type":"RqryCmdRun","reportDatasetId":"abc123","measures":["example"],"dimensions":["example"],"time":{"type":"RqryTimeSliceAttributes","grain":"example","range":{"type":"RqryRangeBetween","from":"2026-08-19","to":"2026-08-19"},"compare":"PreviousPeriod"},"filters":[{"type":"RqryFilterAbove","dimension":"example","value":"example"}],"sort":[{"type":"RqrySortDimension","dimension":"example","ascending":true}],"limit":25,"page":"example","segments":["example"],"measureFilters":[{"type":"RqryMeasureFilterAbove","measure":"example","value":"example"}],"top":{"type":"RqryTopAttributes","dimension":"example","count":42,"measure":"example"},"narrowTo":{"type":"RqryNarrowCustomers","customerIds":["cust_9f2Kd8QpLzXw"]},"asAt":"2026-08-19T04:21:07Z","pivot":{"type":"RqryPivotAttributes","rows":["example"],"columns":["example"],"subtotals":true},"timezone":"example"},"presentation":{"type":"RchtPresentationAttributes","chartType":"Auto","colours":{"type":"RchtColoursAttributes","palette":"Categorical","overrides":[{"type":"RchtColourOverrideAttributes","series":"example","swatch":"example"}]},"description":"A short description.","riseIs":"Good","stackTotal":"example","referenceLines":[{"type":"RchtReferenceLineConstant","label":"example","value":"example"}],"table":{"type":"RchtTableAttributes","rowLink":"example","statuses":[{"type":"RchtStatusColumnAttributes","column":"example","tones":[{"type":"RchtValueToneAttributes","value":"example","tone":"Danger"}]}]}},"reportChartId":"rcht_9f2Kd8QpLzXw","stale":"example"}],"type":"object","required":["type","cellId","question","presentation"],"properties":{"type":{"description":"Always `RnbkCellQuestion`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RnbkCellQuestion"]},"cellId":{"description":"The cell's own id within the notebook.","type":"string"},"question":{"$ref":"#/components/schemas/RqryCmdRun"},"presentation":{"$ref":"#/components/schemas/RchtPresentation","description":"How a chart draws its answer. What it asks is its question."},"reportChartId":{"$ref":"#/components/schemas/RchtId","description":"The saved chart this cell edits, whose question and presentation it was opened with."},"stale":{"description":"Present when the catalogue has moved under the question since it was saved: why asking it now would be refused.","type":"string"}}},"RnbkCmd":{"oneOf":[{"$ref":"#/components/schemas/RnbkCmdCopy"},{"$ref":"#/components/schemas/RnbkCmdCreate"}],"discriminator":{"propertyName":"type","mapping":{"RnbkCmdCopy":"#/components/schemas/RnbkCmdCopy","RnbkCmdCreate":"#/components/schemas/RnbkCmdCreate"}}},"RnbkCmdCopy":{"title":"RnbkCmdCopy","description":"Save a copy of a notebook the caller can read, owned by the caller. It holds the cells the caller is shown.","examples":[{"type":"RnbkCmdCopy","copyOf":"rnbk_9f2Kd8QpLzXw","reportSpaceId":"rspc_9f2Kd8QpLzXw","title":"example"}],"type":"object","required":["type","copyOf"],"properties":{"type":{"description":"Always `RnbkCmdCopy`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RnbkCmdCopy"]},"copyOf":{"$ref":"#/components/schemas/RnbkId","description":"The notebook to copy."},"reportSpaceId":{"$ref":"#/components/schemas/RspcId","description":"Where to save the copy. Absent for the original's space, or for the caller's default space when the original is in the System space."},"title":{"description":"Absent for the original's title with ` (copy)` after it.","type":"string"}}},"RnbkCmdCreate":{"title":"RnbkCmdCreate","description":"Save a notebook in a space the caller may change.","examples":[{"type":"RnbkCmdCreate","reportSpaceId":"rspc_9f2Kd8QpLzXw","title":"example","cells":[{"type":"RnbkDraftCellKept","cellId":"abc123"}]}],"type":"object","required":["type","reportSpaceId","title"],"properties":{"type":{"description":"Always `RnbkCmdCreate`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RnbkCmdCreate"]},"reportSpaceId":{"$ref":"#/components/schemas/RspcId","description":"Identifier of a report space."},"title":{"type":"string"},"cells":{"type":"array","items":{"$ref":"#/components/schemas/RnbkDraftCell"}}}},"RnbkColumn":{"title":"RnbkColumn","type":"string","enum":["ReportNotebookId","ReportSpaceId","Title","Access","OwnedByCaller","Editable","CreatedAt","UpdatedAt"]},"RnbkCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/RnbkCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RnbkCreateRspAttributes":"#/components/schemas/RnbkCreateRspAttributes"}}},"RnbkCreateRspAttributes":{"title":"RnbkCreateRspAttributes","examples":[{"type":"RnbkCreateRspAttributes","created":{"type":"RnbkViewAttributes","reportNotebookId":"rnbk_9f2Kd8QpLzXw","reportSpaceId":"rspc_9f2Kd8QpLzXw","title":"example","cells":[{"type":"RnbkCellHidden","cellId":"abc123"}],"access":"Private","tenant":{"type":"RspcTenantEnterprise","enterpriseId":"ent_9f2Kd8QpLzXw"},"ownedByCaller":true,"editable":true,"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `RnbkCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RnbkCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/RnbkView","description":"The resource that was created."}}},"RnbkDraftCell":{"oneOf":[{"$ref":"#/components/schemas/RnbkDraftCellKept"},{"$ref":"#/components/schemas/RnbkDraftCellMarkdown"},{"$ref":"#/components/schemas/RnbkDraftCellQuestion"}],"discriminator":{"propertyName":"type","mapping":{"RnbkDraftCellKept":"#/components/schemas/RnbkDraftCellKept","RnbkDraftCellMarkdown":"#/components/schemas/RnbkDraftCellMarkdown","RnbkDraftCellQuestion":"#/components/schemas/RnbkDraftCellQuestion"}}},"RnbkDraftCellKept":{"title":"RnbkDraftCellKept","description":"Keeps, in this place, a question the caller was shown as `RnbkCellHidden`.","examples":[{"type":"RnbkDraftCellKept","cellId":"abc123"}],"type":"object","required":["type","cellId"],"properties":{"type":{"description":"Always `RnbkDraftCellKept`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RnbkDraftCellKept"]},"cellId":{"type":"string"}}},"RnbkDraftCellMarkdown":{"title":"RnbkDraftCellMarkdown","description":"One of the cells a caller writes, in its order.","examples":[{"type":"RnbkDraftCellMarkdown","cellId":"abc123","text":"example"}],"type":"object","required":["type","cellId","text"],"properties":{"type":{"description":"Always `RnbkDraftCellMarkdown`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RnbkDraftCellMarkdown"]},"cellId":{"type":"string"},"text":{"type":"string"}}},"RnbkDraftCellQuestion":{"title":"RnbkDraftCellQuestion","description":"A question, which must be one the caller could ask now.","examples":[{"type":"RnbkDraftCellQuestion","cellId":"abc123","question":{"type":"RqryCmdRun","reportDatasetId":"abc123","measures":["example"],"dimensions":["example"],"time":{"type":"RqryTimeSliceAttributes","grain":"example","range":{"type":"RqryRangeBetween","from":"2026-08-19","to":"2026-08-19"},"compare":"PreviousPeriod"},"filters":[{"type":"RqryFilterAbove","dimension":"example","value":"example"}],"sort":[{"type":"RqrySortDimension","dimension":"example","ascending":true}],"limit":25,"page":"example","segments":["example"],"measureFilters":[{"type":"RqryMeasureFilterAbove","measure":"example","value":"example"}],"top":{"type":"RqryTopAttributes","dimension":"example","count":42,"measure":"example"},"narrowTo":{"type":"RqryNarrowCustomers","customerIds":["cust_9f2Kd8QpLzXw"]},"asAt":"2026-08-19T04:21:07Z","pivot":{"type":"RqryPivotAttributes","rows":["example"],"columns":["example"],"subtotals":true},"timezone":"example"},"presentation":{"type":"RchtPresentationAttributes","chartType":"Auto","colours":{"type":"RchtColoursAttributes","palette":"Categorical","overrides":[{"type":"RchtColourOverrideAttributes","series":"example","swatch":"example"}]},"description":"A short description.","riseIs":"Good","stackTotal":"example","referenceLines":[{"type":"RchtReferenceLineConstant","label":"example","value":"example"}],"table":{"type":"RchtTableAttributes","rowLink":"example","statuses":[{"type":"RchtStatusColumnAttributes","column":"example","tones":[{"type":"RchtValueToneAttributes","value":"example","tone":"Danger"}]}]}},"reportChartId":"rcht_9f2Kd8QpLzXw"}],"type":"object","required":["type","cellId","question","presentation"],"properties":{"type":{"description":"Always `RnbkDraftCellQuestion`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RnbkDraftCellQuestion"]},"cellId":{"type":"string"},"question":{"$ref":"#/components/schemas/RqryCmdRun"},"presentation":{"$ref":"#/components/schemas/RchtPresentation","description":"How a chart draws its answer. What it asks is its question."},"reportChartId":{"$ref":"#/components/schemas/RchtId","description":"The saved chart this cell edits."}}},"RnbkId":{"title":"RnbkId","examples":["rnbk_9f2Kd8QpLzXw"],"type":"string"},"RnbkPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/RnbkPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RnbkPageAttributes":"#/components/schemas/RnbkPageAttributes"}}},"RnbkPageAttributes":{"title":"RnbkPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"RnbkPageAttributes","data":[{"type":"RnbkViewAttributes","reportNotebookId":"rnbk_9f2Kd8QpLzXw","reportSpaceId":"rspc_9f2Kd8QpLzXw","title":"example","cells":[{"type":"RnbkCellHidden","cellId":"abc123"}],"access":"Private","tenant":{"type":"RspcTenantEnterprise","enterpriseId":"ent_9f2Kd8QpLzXw"},"ownedByCaller":true,"editable":true,"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `RnbkPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RnbkPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/RnbkView","description":"Questions and notes in order, each question saved without its answer."}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"RnbkUpdate":{"oneOf":[{"$ref":"#/components/schemas/RnbkUpdateMove"},{"$ref":"#/components/schemas/RnbkUpdateRename"},{"$ref":"#/components/schemas/RnbkUpdateReplaceCells"}],"discriminator":{"propertyName":"type","mapping":{"RnbkUpdateMove":"#/components/schemas/RnbkUpdateMove","RnbkUpdateRename":"#/components/schemas/RnbkUpdateRename","RnbkUpdateReplaceCells":"#/components/schemas/RnbkUpdateReplaceCells"}}},"RnbkUpdateMove":{"title":"RnbkUpdateMove","description":"Save it in another space the caller may change.","examples":[{"type":"RnbkUpdateMove","reportSpaceId":"rspc_9f2Kd8QpLzXw"}],"type":"object","required":["type","reportSpaceId"],"properties":{"type":{"description":"Always `RnbkUpdateMove`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RnbkUpdateMove"]},"reportSpaceId":{"$ref":"#/components/schemas/RspcId","description":"Identifier of a report space."}}},"RnbkUpdateRename":{"title":"RnbkUpdateRename","examples":[{"type":"RnbkUpdateRename","title":"example"}],"type":"object","required":["type","title"],"properties":{"type":{"description":"Always `RnbkUpdateRename`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RnbkUpdateRename"]},"title":{"type":"string"}}},"RnbkUpdateReplaceCells":{"title":"RnbkUpdateReplaceCells","description":"Write its cells afresh, in order. A question the caller was not shown is kept only where a `RnbkDraftCellKept` names it.","examples":[{"type":"RnbkUpdateReplaceCells","cells":[{"type":"RnbkDraftCellKept","cellId":"abc123"}]}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `RnbkUpdateReplaceCells`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RnbkUpdateReplaceCells"]},"cells":{"type":"array","items":{"$ref":"#/components/schemas/RnbkDraftCell"}}}},"RnbkUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/RnbkUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RnbkUpdateRspAttributes":"#/components/schemas/RnbkUpdateRspAttributes"}}},"RnbkUpdateRspAttributes":{"title":"RnbkUpdateRspAttributes","examples":[{"type":"RnbkUpdateRspAttributes","updated":{"type":"RnbkViewAttributes","reportNotebookId":"rnbk_9f2Kd8QpLzXw","reportSpaceId":"rspc_9f2Kd8QpLzXw","title":"example","cells":[{"type":"RnbkCellHidden","cellId":"abc123"}],"access":"Private","tenant":{"type":"RspcTenantEnterprise","enterpriseId":"ent_9f2Kd8QpLzXw"},"ownedByCaller":true,"editable":true,"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `RnbkUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RnbkUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/RnbkView","description":"The resource as it stands after the change."}}},"RnbkView":{"oneOf":[{"$ref":"#/components/schemas/RnbkViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RnbkViewAttributes":"#/components/schemas/RnbkViewAttributes"}}},"RnbkViewAttributes":{"title":"RnbkViewAttributes","description":"Questions and notes in order, each question saved without its answer.","examples":[{"type":"RnbkViewAttributes","reportNotebookId":"rnbk_9f2Kd8QpLzXw","reportSpaceId":"rspc_9f2Kd8QpLzXw","title":"example","cells":[{"type":"RnbkCellHidden","cellId":"abc123"}],"access":"Private","tenant":{"type":"RspcTenantEnterprise","enterpriseId":"ent_9f2Kd8QpLzXw"},"ownedByCaller":true,"editable":true,"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","reportNotebookId","reportSpaceId","title","access","tenant","ownedByCaller","editable","createdAt","updatedAt"],"properties":{"type":{"description":"Always `RnbkViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RnbkViewAttributes"]},"reportNotebookId":{"$ref":"#/components/schemas/RnbkId","description":"Identifier of a saved notebook."},"reportSpaceId":{"$ref":"#/components/schemas/RspcId","description":"Identifier of a report space."},"title":{"type":"string"},"cells":{"type":"array","items":{"$ref":"#/components/schemas/RnbkCell"}},"access":{"$ref":"#/components/schemas/RspcAccess"},"tenant":{"$ref":"#/components/schemas/RspcTenant"},"ownedByCaller":{"type":"boolean"},"editable":{"description":"Whether the caller may change, move or delete it.","type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"RoleCmd":{"oneOf":[{"$ref":"#/components/schemas/RoleCmdCreate"},{"$ref":"#/components/schemas/RoleCmdCreateGrouping"}],"discriminator":{"propertyName":"type","mapping":{"RoleCmdCreate":"#/components/schemas/RoleCmdCreate","RoleCmdCreateGrouping":"#/components/schemas/RoleCmdCreateGrouping"}}},"RoleCmdCreate":{"title":"RoleCmdCreate","description":"Define a role carrying its own grants.","examples":[{"type":"RoleCmdCreate","name":"Ada Lovelace","ownerDomain":{"type":"UserDomainAnonymous","restrictedTo":{"type":"UserDomainCustomer","customerId":"cust_9f2Kd8QpLzXw"}},"grants":[{"type":"RoleGrantAttributes","resource":"BlockedCard","actions":["Create"]}]}],"type":"object","required":["type","name","ownerDomain"],"properties":{"type":{"description":"Always `RoleCmdCreate`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RoleCmdCreate"]},"name":{"type":"string"},"ownerDomain":{"$ref":"#/components/schemas/UserPermissionDomain","description":"The domain that owns this role. Carries the party it is restricted to."},"grants":{"type":"array","items":{"$ref":"#/components/schemas/RoleGrant"}}}},"RoleCmdCreateGrouping":{"title":"RoleCmdCreateGrouping","description":"Define a role as the union of other roles.","examples":[{"type":"RoleCmdCreateGrouping","name":"Ada Lovelace","ownerDomain":{"type":"UserDomainAnonymous","restrictedTo":{"type":"UserDomainCustomer","customerId":"cust_9f2Kd8QpLzXw"}},"roles":["role_9f2Kd8QpLzXw"]}],"type":"object","required":["type","name","ownerDomain"],"properties":{"type":{"description":"Always `RoleCmdCreateGrouping`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RoleCmdCreateGrouping"]},"name":{"type":"string"},"ownerDomain":{"$ref":"#/components/schemas/UserPermissionDomain","description":"The domain that owns this role. Carries the party it is restricted to."},"roles":{"type":"array","items":{"$ref":"#/components/schemas/RoleId"}}}},"RoleColumn":{"title":"RoleColumn","type":"string"},"RoleCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/RoleCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RoleCreateRspAttributes":"#/components/schemas/RoleCreateRspAttributes"}}},"RoleCreateRspAttributes":{"title":"RoleCreateRspAttributes","examples":[{"type":"RoleCreateRspAttributes","created":{"type":"RoleViewBuiltIn","roleId":"role_9f2Kd8QpLzXw","name":"Ada Lovelace","grants":[{"type":"RoleGrantAttributes","resource":"BlockedCard","actions":["Create"]}],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `RoleCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RoleCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/RoleView","description":"The resource that was created."}}},"RoleGrant":{"description":"What a role permits: a set of actions on one resource.","oneOf":[{"$ref":"#/components/schemas/RoleGrantAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RoleGrantAttributes":"#/components/schemas/RoleGrantAttributes"}}},"RoleGrantAttributes":{"title":"RoleGrantAttributes","description":"What a role permits: a set of actions on one resource.","examples":[{"type":"RoleGrantAttributes","resource":"BlockedCard","actions":["Create"]}],"type":"object","required":["type","resource"],"properties":{"type":{"description":"Always `RoleGrantAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RoleGrantAttributes"]},"resource":{"$ref":"#/components/schemas/PermissionResource","description":"The resource this grant is over."},"actions":{"description":"The actions this grant allows on the resource.","type":"array","items":{"$ref":"#/components/schemas/PermissionAction"}}}},"RoleId":{"title":"RoleId","description":"Identifier of a role.","examples":["role_9f2Kd8QpLzXw"],"type":"string"},"RolePage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/RolePageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RolePageAttributes":"#/components/schemas/RolePageAttributes"}}},"RolePageAttributes":{"title":"RolePageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"RolePageAttributes","data":[{"type":"RoleViewBuiltIn","roleId":"role_9f2Kd8QpLzXw","name":"Ada Lovelace","grants":[{"type":"RoleGrantAttributes","resource":"BlockedCard","actions":["Create"]}],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `RolePageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RolePageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/RoleView"}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"RoleSort":{"title":"RoleSort","type":"string","enum":["createdAt","-createdAt","updatedAt","-updatedAt"]},"RoleType":{"title":"RoleType","type":"string","enum":["BuiltIn","UserDefined","Grouping","Unknown"]},"RoleUpdate":{"oneOf":[{"$ref":"#/components/schemas/RoleUpdateGrants"},{"$ref":"#/components/schemas/RoleUpdateGrouping"},{"$ref":"#/components/schemas/RoleUpdateRename"}],"discriminator":{"propertyName":"type","mapping":{"RoleUpdateGrants":"#/components/schemas/RoleUpdateGrants","RoleUpdateGrouping":"#/components/schemas/RoleUpdateGrouping","RoleUpdateRename":"#/components/schemas/RoleUpdateRename"}}},"RoleUpdateGrants":{"title":"RoleUpdateGrants","description":"Replace the grants this role carries. Send the full set you want, this is a replace, not a merge.","examples":[{"type":"RoleUpdateGrants","name":"Ada Lovelace","grants":[{"type":"RoleGrantAttributes","resource":"BlockedCard","actions":["Create"]}]}],"type":"object","required":["type","grants"],"properties":{"type":{"description":"Always `RoleUpdateGrants`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RoleUpdateGrants"]},"name":{"description":"Rename it at the same time, if you want to. Omit to keep the current name.","type":"string"},"grants":{"description":"Every grant the role should carry. At least one, a role that permits nothing should be deleted.","type":"array","minItems":1,"items":{"$ref":"#/components/schemas/RoleGrant"}}}},"RoleUpdateGrouping":{"title":"RoleUpdateGrouping","description":"Replace the roles this grouping unions. Send the full set you want. Only for a role that groups others.","examples":[{"type":"RoleUpdateGrouping","name":"Ada Lovelace","roles":["role_9f2Kd8QpLzXw"]}],"type":"object","required":["type","roles"],"properties":{"type":{"description":"Always `RoleUpdateGrouping`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RoleUpdateGrouping"]},"name":{"description":"Rename it at the same time, if you want to. Omit to keep the current name.","type":"string"},"roles":{"description":"Every role the grouping should union. At least one, an empty grouping grants nothing.","type":"array","minItems":1,"items":{"$ref":"#/components/schemas/RoleId"}}}},"RoleUpdateRename":{"title":"RoleUpdateRename","description":"Rename the role, leaving what it grants alone.","examples":[{"type":"RoleUpdateRename","name":"Ada Lovelace"}],"type":"object","required":["type","name"],"properties":{"type":{"description":"Always `RoleUpdateRename`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RoleUpdateRename"]},"name":{"type":"string"}}},"RoleUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/RoleUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RoleUpdateRspAttributes":"#/components/schemas/RoleUpdateRspAttributes"}}},"RoleUpdateRspAttributes":{"title":"RoleUpdateRspAttributes","examples":[{"type":"RoleUpdateRspAttributes","updated":{"type":"RoleViewBuiltIn","roleId":"role_9f2Kd8QpLzXw","name":"Ada Lovelace","grants":[{"type":"RoleGrantAttributes","resource":"BlockedCard","actions":["Create"]}],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `RoleUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RoleUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/RoleView","description":"The resource as it stands after the change."}}},"RoleView":{"oneOf":[{"$ref":"#/components/schemas/RoleViewBuiltIn"},{"$ref":"#/components/schemas/RoleViewDefined"},{"$ref":"#/components/schemas/RoleViewGrouping"}],"discriminator":{"propertyName":"type","mapping":{"RoleViewBuiltIn":"#/components/schemas/RoleViewBuiltIn","RoleViewDefined":"#/components/schemas/RoleViewDefined","RoleViewGrouping":"#/components/schemas/RoleViewGrouping"}}},"RoleViewBuiltIn":{"title":"RoleViewBuiltIn","description":"A role the platform defines, carrying its own grants and available everywhere.","examples":[{"type":"RoleViewBuiltIn","roleId":"role_9f2Kd8QpLzXw","name":"Ada Lovelace","grants":[{"type":"RoleGrantAttributes","resource":"BlockedCard","actions":["Create"]}],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","roleId","name","createdAt","updatedAt"],"properties":{"type":{"description":"Always `RoleViewBuiltIn`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RoleViewBuiltIn"]},"roleId":{"$ref":"#/components/schemas/RoleId"},"name":{"type":"string"},"grants":{"description":"The grants this role carries.","type":"array","items":{"$ref":"#/components/schemas/RoleGrant"}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"RoleViewDefined":{"title":"RoleViewDefined","description":"A role a domain defines, carrying its own grants.","examples":[{"type":"RoleViewDefined","roleId":"role_9f2Kd8QpLzXw","name":"Ada Lovelace","grants":[{"type":"RoleGrantAttributes","resource":"BlockedCard","actions":["Create"]}],"ownerDomain":{"type":"UserDomainAnonymous","restrictedTo":{"type":"UserDomainCustomer","customerId":"cust_9f2Kd8QpLzXw"}},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","roleId","name","ownerDomain","createdAt","updatedAt"],"properties":{"type":{"description":"Always `RoleViewDefined`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RoleViewDefined"]},"roleId":{"$ref":"#/components/schemas/RoleId"},"name":{"type":"string"},"grants":{"description":"The grants this role carries.","type":"array","items":{"$ref":"#/components/schemas/RoleGrant"}},"ownerDomain":{"$ref":"#/components/schemas/UserPermissionDomain","description":"The domain that owns this role."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"RoleViewGrouping":{"title":"RoleViewGrouping","description":"A role that is the union of other roles.","examples":[{"type":"RoleViewGrouping","roleId":"role_9f2Kd8QpLzXw","name":"Ada Lovelace","groupedRoles":["role_9f2Kd8QpLzXw"],"ownerDomain":{"type":"UserDomainAnonymous","restrictedTo":{"type":"UserDomainCustomer","customerId":"cust_9f2Kd8QpLzXw"}},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","roleId","name","ownerDomain","createdAt","updatedAt"],"properties":{"type":{"description":"Always `RoleViewGrouping`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RoleViewGrouping"]},"roleId":{"$ref":"#/components/schemas/RoleId"},"name":{"type":"string"},"groupedRoles":{"description":"The roles this one groups. Their grants are what it permits; read them to resolve it.","type":"array","items":{"$ref":"#/components/schemas/RoleId"}},"ownerDomain":{"$ref":"#/components/schemas/UserPermissionDomain","description":"The domain that owns this role."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"RpinCmd":{"oneOf":[{"$ref":"#/components/schemas/RpinCmdCreate"}],"discriminator":{"propertyName":"type","mapping":{"RpinCmdCreate":"#/components/schemas/RpinCmdCreate"}}},"RpinCmdCreate":{"title":"RpinCmdCreate","description":"Pin a dashboard the caller can read. Pinning one already pinned answers its pin; past five pins it is refused.","examples":[{"type":"RpinCmdCreate","reportDashboardId":"rdsh_9f2Kd8QpLzXw","position":1250}],"type":"object","required":["type","reportDashboardId"],"properties":{"type":{"description":"Always `RpinCmdCreate`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RpinCmdCreate"]},"reportDashboardId":{"$ref":"#/components/schemas/RdshId","description":"Identifier of a saved dashboard."},"position":{"description":"Its place in the list, from 0. Absent for the end.","type":"integer","format":"int32"}}},"RpinColumn":{"title":"RpinColumn","type":"string","enum":["ReportPinId","ReportDashboardId","Position","CreatedAt","UpdatedAt"]},"RpinCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/RpinCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RpinCreateRspAttributes":"#/components/schemas/RpinCreateRspAttributes"}}},"RpinCreateRspAttributes":{"title":"RpinCreateRspAttributes","examples":[{"type":"RpinCreateRspAttributes","created":{"type":"RpinViewAttributes","reportPinId":"rpin_9f2Kd8QpLzXw","reportDashboardId":"rdsh_9f2Kd8QpLzXw","position":1250,"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `RpinCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RpinCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/RpinView","description":"The resource that was created."}}},"RpinId":{"title":"RpinId","description":"Identifier of a pinned dashboard.","examples":["rpin_9f2Kd8QpLzXw"],"type":"string"},"RpinPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/RpinPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RpinPageAttributes":"#/components/schemas/RpinPageAttributes"}}},"RpinPageAttributes":{"title":"RpinPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"RpinPageAttributes","data":[{"type":"RpinViewAttributes","reportPinId":"rpin_9f2Kd8QpLzXw","reportDashboardId":"rdsh_9f2Kd8QpLzXw","position":1250,"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `RpinPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RpinPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/RpinView","description":"A dashboard the caller keeps to hand. Pins are the caller's own, under the tenant it signed in to."}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"RpinUpdate":{"oneOf":[{"$ref":"#/components/schemas/RpinUpdateMove"}],"discriminator":{"propertyName":"type","mapping":{"RpinUpdateMove":"#/components/schemas/RpinUpdateMove"}}},"RpinUpdateMove":{"title":"RpinUpdateMove","description":"Move it to another place in the caller's list, the others closing up around it.","examples":[{"type":"RpinUpdateMove","position":1250}],"type":"object","required":["type","position"],"properties":{"type":{"description":"Always `RpinUpdateMove`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RpinUpdateMove"]},"position":{"type":"integer","format":"int32"}}},"RpinUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/RpinUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RpinUpdateRspAttributes":"#/components/schemas/RpinUpdateRspAttributes"}}},"RpinUpdateRspAttributes":{"title":"RpinUpdateRspAttributes","examples":[{"type":"RpinUpdateRspAttributes","updated":{"type":"RpinViewAttributes","reportPinId":"rpin_9f2Kd8QpLzXw","reportDashboardId":"rdsh_9f2Kd8QpLzXw","position":1250,"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `RpinUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RpinUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/RpinView","description":"The resource as it stands after the change."}}},"RpinView":{"oneOf":[{"$ref":"#/components/schemas/RpinViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RpinViewAttributes":"#/components/schemas/RpinViewAttributes"}}},"RpinViewAttributes":{"title":"RpinViewAttributes","description":"A dashboard the caller keeps to hand. Pins are the caller's own, under the tenant it signed in to.","examples":[{"type":"RpinViewAttributes","reportPinId":"rpin_9f2Kd8QpLzXw","reportDashboardId":"rdsh_9f2Kd8QpLzXw","position":1250,"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","reportPinId","reportDashboardId","position","createdAt","updatedAt"],"properties":{"type":{"description":"Always `RpinViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RpinViewAttributes"]},"reportPinId":{"$ref":"#/components/schemas/RpinId"},"reportDashboardId":{"$ref":"#/components/schemas/RdshId","description":"Identifier of a saved dashboard."},"position":{"description":"Its place in the caller's list, from 0.","type":"integer","format":"int32"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"RpolAction":{"description":"The action the rule takes when it matches. Read only: a rule's template and values decide it.","oneOf":[{"$ref":"#/components/schemas/RpolActionAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RpolActionAttributes":"#/components/schemas/RpolActionAttributes"}}},"RpolActionAttributes":{"title":"RpolActionAttributes","description":"The action a rule takes when it matches, one of its area's `actions`.","examples":[{"type":"RpolActionAttributes","name":"Ada Lovelace"}],"type":"object","required":["type","name"],"properties":{"type":{"description":"Always `RpolActionAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RpolActionAttributes"]},"name":{"description":"The action's name, as the area's description names it.","type":"string"}}},"RpolArgument":{"description":"The value of one parameter of a rule's template.","oneOf":[{"$ref":"#/components/schemas/RpolArgumentAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RpolArgumentAttributes":"#/components/schemas/RpolArgumentAttributes"}}},"RpolArgumentAttributes":{"title":"RpolArgumentAttributes","description":"The value of one parameter of a rule's template.","examples":[{"type":"RpolArgumentAttributes","parameterId":"abc123","value":{"type":"RpolValueAmount","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"}}}],"type":"object","required":["type","parameterId","value"],"properties":{"type":{"description":"Always `RpolArgumentAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RpolArgumentAttributes"]},"parameterId":{"description":"The parameter's id, as the area's description names it.","type":"string"},"value":{"$ref":"#/components/schemas/RpolValue"}}},"RpolChange":{"title":"RpolChange","description":"What the version changed.","type":"string","enum":["Created","Updated","Paused","Resumed","Retired","RolledBack","Submitted","Approved","Rejected","Unknown"]},"RpolCmd":{"oneOf":[{"$ref":"#/components/schemas/RpolCmdCreate"}],"discriminator":{"propertyName":"type","mapping":{"RpolCmdCreate":"#/components/schemas/RpolCmdCreate"}}},"RpolCmdCreate":{"title":"RpolCmdCreate","description":"Make a rule policy: a draft at version 1, owned by the caller's tenant or, with `owner`, by a tenant beneath it. The rule is checked against its template, and the lists it names against its owner, before anything is stored; a rule that fails is refused with 400 and every reason.","examples":[{"type":"RpolCmdCreate","domain":"example","owner":{"type":"RpolOwnerEnterprise","enterpriseId":"ent_9f2Kd8QpLzXw"},"rule":{"type":"RpolRuleAttributes","templateId":"abc123","arguments":[{"type":"RpolArgumentAttributes","parameterId":"abc123","value":{"type":"RpolValueAmount","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"}}}],"action":{"type":"RpolActionAttributes","name":"Ada Lovelace"}},"mode":"Shadow","description":"A short description.","effectiveFrom":"2026-08-19T04:21:07Z","effectiveUntil":"2026-08-19T04:21:07Z","reasonCode":"NewTypology","reason":"Requested by the customer."}],"type":"object","required":["type","domain","rule","reasonCode"],"properties":{"type":{"description":"Always `RpolCmdCreate`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RpolCmdCreate"]},"domain":{"description":"The area the rule is for, as `ruleAreaId` names it.","type":"string"},"owner":{"$ref":"#/components/schemas/RpolOwner","description":"The tenant that owns the policy. Absent for the caller's own tenant. A platform caller names none, and acts for a tenant with its headers."},"rule":{"$ref":"#/components/schemas/RpolRule"},"mode":{"$ref":"#/components/schemas/RpolMode","description":"Whether the rule acts or is only recorded. `Enforcing` where absent."},"description":{"type":"string"},"effectiveFrom":{"description":"When the rule takes effect. Now where absent.","type":"string","format":"date-time"},"effectiveUntil":{"description":"When the rule stops taking effect. It does not, where absent.","type":"string","format":"date-time"},"reasonCode":{"$ref":"#/components/schemas/RpolReason"},"reason":{"type":"string"}}},"RpolColumn":{"title":"RpolColumn","type":"string","enum":["RulePolicyId","Domain","State","Mode","Paused","RuleTemplateId","RuleActionName","TemplateVersion","Description","Version","EffectiveFrom","EffectiveUntil","RetiredAt","CreatedAt","CreatedBy","UpdatedAt","UpdatedBy","ApprovedBy","ApprovedAt","RejectedBy","RejectedAt"]},"RpolCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/RpolCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RpolCreateRspAttributes":"#/components/schemas/RpolCreateRspAttributes"}}},"RpolCreateRspAttributes":{"title":"RpolCreateRspAttributes","examples":[{"type":"RpolCreateRspAttributes","created":{"type":"RpolViewAttributes","rulePolicyId":"rpol_9f2Kd8QpLzXw","domain":"example","owner":{"type":"RpolOwnerEnterprise","enterpriseId":"ent_9f2Kd8QpLzXw"},"state":"Draft","mode":"Shadow","paused":true,"rule":{"type":"RpolRuleAttributes","templateId":"abc123","arguments":[{"type":"RpolArgumentAttributes","parameterId":"abc123","value":{"type":"RpolValueAmount","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"}}}],"action":{"type":"RpolActionAttributes","name":"Ada Lovelace"}},"templateVersion":1250,"description":"A short description.","version":1250,"effectiveFrom":"2026-08-19T04:21:07Z","effectiveUntil":"2026-08-19T04:21:07Z","retiredAt":"2026-08-19T04:21:07Z","createdAt":"2026-08-19T04:21:07Z","createdBy":"example","updatedAt":"2026-08-19T04:21:07Z","updatedBy":"example","approvedBy":"example","approvedAt":"2026-08-19T04:21:07Z","rejectedBy":"example","rejectedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `RpolCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RpolCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/RpolView","description":"The resource that was created."}}},"RpolId":{"title":"RpolId","description":"Identifier of a rule policy.","examples":["rpol_9f2Kd8QpLzXw"],"type":"string"},"RpolMode":{"title":"RpolMode","type":"string","enum":["Shadow","Enforcing","Unknown"]},"RpolOwner":{"oneOf":[{"$ref":"#/components/schemas/RpolOwnerEnterprise"},{"$ref":"#/components/schemas/RpolOwnerMarketplace"},{"$ref":"#/components/schemas/RpolOwnerMerchant"},{"$ref":"#/components/schemas/RpolOwnerPlatform"}],"discriminator":{"propertyName":"type","mapping":{"RpolOwnerEnterprise":"#/components/schemas/RpolOwnerEnterprise","RpolOwnerMarketplace":"#/components/schemas/RpolOwnerMarketplace","RpolOwnerMerchant":"#/components/schemas/RpolOwnerMerchant","RpolOwnerPlatform":"#/components/schemas/RpolOwnerPlatform"}}},"RpolOwnerEnterprise":{"title":"RpolOwnerEnterprise","description":"The tenant that owns a rule policy or a named list: the platform, or an enterprise, a marketplace or a merchant.","examples":[{"type":"RpolOwnerEnterprise","enterpriseId":"ent_9f2Kd8QpLzXw"}],"type":"object","required":["type","enterpriseId"],"properties":{"type":{"description":"Always `RpolOwnerEnterprise`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RpolOwnerEnterprise"]},"enterpriseId":{"$ref":"#/components/schemas/EntId","description":"Identifier of an enterprise."}}},"RpolOwnerMarketplace":{"title":"RpolOwnerMarketplace","description":"The tenant that owns a rule policy or a named list: the platform, or an enterprise, a marketplace or a merchant.","examples":[{"type":"RpolOwnerMarketplace","marketplaceId":"mktp_9f2Kd8QpLzXw"}],"type":"object","required":["type","marketplaceId"],"properties":{"type":{"description":"Always `RpolOwnerMarketplace`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RpolOwnerMarketplace"]},"marketplaceId":{"$ref":"#/components/schemas/MktpId","description":"Identifier of a marketplace."}}},"RpolOwnerMerchant":{"title":"RpolOwnerMerchant","description":"The tenant that owns a rule policy or a named list: the platform, or an enterprise, a marketplace or a merchant.","examples":[{"type":"RpolOwnerMerchant","merchantId":"mcht_9f2Kd8QpLzXw"}],"type":"object","required":["type","merchantId"],"properties":{"type":{"description":"Always `RpolOwnerMerchant`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RpolOwnerMerchant"]},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"Identifier of a merchant."}}},"RpolOwnerPlatform":{"title":"RpolOwnerPlatform","description":"The platform, which no enterprise, marketplace or merchant bounds.","examples":[{"type":"RpolOwnerPlatform"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `RpolOwnerPlatform`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RpolOwnerPlatform"]}}},"RpolOwnerType":{"title":"RpolOwnerType","type":"string","enum":["Platform","Enterprise","Marketplace","Merchant","Unknown"]},"RpolPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/RpolPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RpolPageAttributes":"#/components/schemas/RpolPageAttributes"}}},"RpolPageAttributes":{"title":"RpolPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"RpolPageAttributes","data":[{"type":"RpolViewAttributes","rulePolicyId":"rpol_9f2Kd8QpLzXw","domain":"example","owner":{"type":"RpolOwnerEnterprise","enterpriseId":"ent_9f2Kd8QpLzXw"},"state":"Draft","mode":"Shadow","paused":true,"rule":{"type":"RpolRuleAttributes","templateId":"abc123","arguments":[{"type":"RpolArgumentAttributes","parameterId":"abc123","value":{"type":"RpolValueAmount","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"}}}],"action":{"type":"RpolActionAttributes","name":"Ada Lovelace"}},"templateVersion":1250,"description":"A short description.","version":1250,"effectiveFrom":"2026-08-19T04:21:07Z","effectiveUntil":"2026-08-19T04:21:07Z","retiredAt":"2026-08-19T04:21:07Z","createdAt":"2026-08-19T04:21:07Z","createdBy":"example","updatedAt":"2026-08-19T04:21:07Z","updatedBy":"example","approvedBy":"example","approvedAt":"2026-08-19T04:21:07Z","rejectedBy":"example","rejectedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `RpolPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RpolPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/RpolView","description":"A rule, held by a tenant. It is made from one of its area's templates, and each change is a version of its own: a version is made by one person and approved by another, and only an approved version is part of a ruleset. The tenant that owns it manages it, as do the tenants above it; the tenants beneath it read it."}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"RpolReason":{"title":"RpolReason","type":"string","enum":["NewTypology","Tuning","RegulatoryChange","IncidentResponse","Correction","Rollback","ScheduledReview","Import","Unknown"]},"RpolRule":{"description":"A rule: the template it is made from, and the value of each of the template's parameters. A parameter left out takes the template's default. The action is the one the template and its values take, so it is returned and never sent.","oneOf":[{"$ref":"#/components/schemas/RpolRuleAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RpolRuleAttributes":"#/components/schemas/RpolRuleAttributes"}}},"RpolRuleAttributes":{"title":"RpolRuleAttributes","description":"A rule: the template it is made from, and the value of each of the template's parameters. A parameter left out takes the template's default. The action is the one the template and its values take, so it is returned and never sent.","examples":[{"type":"RpolRuleAttributes","templateId":"abc123","arguments":[{"type":"RpolArgumentAttributes","parameterId":"abc123","value":{"type":"RpolValueAmount","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"}}}],"action":{"type":"RpolActionAttributes","name":"Ada Lovelace"}}],"type":"object","required":["type","templateId"],"properties":{"type":{"description":"Always `RpolRuleAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RpolRuleAttributes"]},"templateId":{"description":"The template's id, as the area's description names it.","type":"string"},"arguments":{"type":"array","items":{"$ref":"#/components/schemas/RpolArgument"}},"action":{"$ref":"#/components/schemas/RpolAction"}}},"RpolState":{"title":"RpolState","type":"string","enum":["Draft","PendingApproval","Approved","Rejected","Unknown"]},"RpolUpdate":{"oneOf":[{"$ref":"#/components/schemas/RpolUpdateApprove"},{"$ref":"#/components/schemas/RpolUpdatePause"},{"$ref":"#/components/schemas/RpolUpdateReject"},{"$ref":"#/components/schemas/RpolUpdateResume"},{"$ref":"#/components/schemas/RpolUpdateRetire"},{"$ref":"#/components/schemas/RpolUpdateRevise"},{"$ref":"#/components/schemas/RpolUpdateRollBack"},{"$ref":"#/components/schemas/RpolUpdateSetMode"},{"$ref":"#/components/schemas/RpolUpdateSubmit"}],"discriminator":{"propertyName":"type","mapping":{"RpolUpdateApprove":"#/components/schemas/RpolUpdateApprove","RpolUpdatePause":"#/components/schemas/RpolUpdatePause","RpolUpdateReject":"#/components/schemas/RpolUpdateReject","RpolUpdateResume":"#/components/schemas/RpolUpdateResume","RpolUpdateRetire":"#/components/schemas/RpolUpdateRetire","RpolUpdateRevise":"#/components/schemas/RpolUpdateRevise","RpolUpdateRollBack":"#/components/schemas/RpolUpdateRollBack","RpolUpdateSetMode":"#/components/schemas/RpolUpdateSetMode","RpolUpdateSubmit":"#/components/schemas/RpolUpdateSubmit"}}},"RpolUpdateApprove":{"title":"RpolUpdateApprove","description":"Approve the submitted version. Someone other than the person who made it approves it, which is refused with 403 otherwise.","examples":[{"type":"RpolUpdateApprove","expectedVersion":1250,"reasonCode":"NewTypology","reason":"Requested by the customer."}],"type":"object","required":["type","expectedVersion","reasonCode"],"properties":{"type":{"description":"Always `RpolUpdateApprove`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RpolUpdateApprove"]},"expectedVersion":{"type":"integer","format":"int32"},"reasonCode":{"$ref":"#/components/schemas/RpolReason"},"reason":{"type":"string"}}},"RpolUpdatePause":{"title":"RpolUpdatePause","description":"Switch the rule off without retiring it. A version of its own, which is a draft that has to be approved.","examples":[{"type":"RpolUpdatePause","expectedVersion":1250,"reasonCode":"NewTypology","reason":"Requested by the customer."}],"type":"object","required":["type","expectedVersion","reasonCode"],"properties":{"type":{"description":"Always `RpolUpdatePause`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RpolUpdatePause"]},"expectedVersion":{"type":"integer","format":"int32"},"reasonCode":{"$ref":"#/components/schemas/RpolReason"},"reason":{"type":"string"}}},"RpolUpdateReject":{"title":"RpolUpdateReject","description":"Reject the submitted version. Someone other than the person who made it rejects it, which is refused with 403 otherwise.","examples":[{"type":"RpolUpdateReject","expectedVersion":1250,"reasonCode":"NewTypology","reason":"Requested by the customer."}],"type":"object","required":["type","expectedVersion","reasonCode"],"properties":{"type":{"description":"Always `RpolUpdateReject`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RpolUpdateReject"]},"expectedVersion":{"type":"integer","format":"int32"},"reasonCode":{"$ref":"#/components/schemas/RpolReason"},"reason":{"type":"string"}}},"RpolUpdateResume":{"title":"RpolUpdateResume","description":"Switch a paused rule on again. A version of its own, which is a draft that has to be approved.","examples":[{"type":"RpolUpdateResume","expectedVersion":1250,"reasonCode":"NewTypology","reason":"Requested by the customer."}],"type":"object","required":["type","expectedVersion","reasonCode"],"properties":{"type":{"description":"Always `RpolUpdateResume`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RpolUpdateResume"]},"expectedVersion":{"type":"integer","format":"int32"},"reasonCode":{"$ref":"#/components/schemas/RpolReason"},"reason":{"type":"string"}}},"RpolUpdateRetire":{"title":"RpolUpdateRetire","description":"Retire the rule, so no ruleset names it once the version is approved.","examples":[{"type":"RpolUpdateRetire","expectedVersion":1250,"reasonCode":"NewTypology","reason":"Requested by the customer."}],"type":"object","required":["type","expectedVersion","reasonCode"],"properties":{"type":{"description":"Always `RpolUpdateRetire`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RpolUpdateRetire"]},"expectedVersion":{"type":"integer","format":"int32"},"reasonCode":{"$ref":"#/components/schemas/RpolReason"},"reason":{"type":"string"}}},"RpolUpdateRevise":{"title":"RpolUpdateRevise","description":"Make the next version of the policy, holding the rule stated again. The policy keeps its template, so the rule names it. The version is a draft that has to be submitted and approved. Settings left out are kept.","examples":[{"type":"RpolUpdateRevise","expectedVersion":1250,"rule":{"type":"RpolRuleAttributes","templateId":"abc123","arguments":[{"type":"RpolArgumentAttributes","parameterId":"abc123","value":{"type":"RpolValueAmount","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"}}}],"action":{"type":"RpolActionAttributes","name":"Ada Lovelace"}},"mode":"Shadow","description":"A short description.","effectiveFrom":"2026-08-19T04:21:07Z","effectiveUntil":"2026-08-19T04:21:07Z","reasonCode":"NewTypology","reason":"Requested by the customer."}],"type":"object","required":["type","expectedVersion","rule","reasonCode"],"properties":{"type":{"description":"Always `RpolUpdateRevise`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RpolUpdateRevise"]},"expectedVersion":{"description":"The version the caller last read. A change to any other version is refused with 409.","type":"integer","format":"int32"},"rule":{"$ref":"#/components/schemas/RpolRule"},"mode":{"$ref":"#/components/schemas/RpolMode"},"description":{"type":"string"},"effectiveFrom":{"type":"string","format":"date-time"},"effectiveUntil":{"type":"string","format":"date-time"},"reasonCode":{"$ref":"#/components/schemas/RpolReason"},"reason":{"type":"string"}}},"RpolUpdateRollBack":{"title":"RpolUpdateRollBack","description":"Make the next version of the policy from an earlier version's rule and settings, which this version replaces without erasing: the history keeps every version. A draft that has to be submitted and approved as any version is.","examples":[{"type":"RpolUpdateRollBack","expectedVersion":1250,"toVersion":1250,"reasonCode":"NewTypology","reason":"Requested by the customer."}],"type":"object","required":["type","expectedVersion","toVersion","reasonCode"],"properties":{"type":{"description":"Always `RpolUpdateRollBack`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RpolUpdateRollBack"]},"expectedVersion":{"type":"integer","format":"int32"},"toVersion":{"type":"integer","format":"int32"},"reasonCode":{"$ref":"#/components/schemas/RpolReason"},"reason":{"type":"string"}}},"RpolUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/RpolUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RpolUpdateRspAttributes":"#/components/schemas/RpolUpdateRspAttributes"}}},"RpolUpdateRspAttributes":{"title":"RpolUpdateRspAttributes","examples":[{"type":"RpolUpdateRspAttributes","updated":{"type":"RpolViewAttributes","rulePolicyId":"rpol_9f2Kd8QpLzXw","domain":"example","owner":{"type":"RpolOwnerEnterprise","enterpriseId":"ent_9f2Kd8QpLzXw"},"state":"Draft","mode":"Shadow","paused":true,"rule":{"type":"RpolRuleAttributes","templateId":"abc123","arguments":[{"type":"RpolArgumentAttributes","parameterId":"abc123","value":{"type":"RpolValueAmount","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"}}}],"action":{"type":"RpolActionAttributes","name":"Ada Lovelace"}},"templateVersion":1250,"description":"A short description.","version":1250,"effectiveFrom":"2026-08-19T04:21:07Z","effectiveUntil":"2026-08-19T04:21:07Z","retiredAt":"2026-08-19T04:21:07Z","createdAt":"2026-08-19T04:21:07Z","createdBy":"example","updatedAt":"2026-08-19T04:21:07Z","updatedBy":"example","approvedBy":"example","approvedAt":"2026-08-19T04:21:07Z","rejectedBy":"example","rejectedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `RpolUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RpolUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/RpolView","description":"The resource as it stands after the change."}}},"RpolUpdateSetMode":{"title":"RpolUpdateSetMode","description":"Change whether the rule acts or is only recorded, keeping its rule. A version of its own, which is a draft that has to be approved.","examples":[{"type":"RpolUpdateSetMode","expectedVersion":1250,"mode":"Shadow","reasonCode":"NewTypology","reason":"Requested by the customer."}],"type":"object","required":["type","expectedVersion","mode","reasonCode"],"properties":{"type":{"description":"Always `RpolUpdateSetMode`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RpolUpdateSetMode"]},"expectedVersion":{"type":"integer","format":"int32"},"mode":{"$ref":"#/components/schemas/RpolMode"},"reasonCode":{"$ref":"#/components/schemas/RpolReason"},"reason":{"type":"string"}}},"RpolUpdateSubmit":{"title":"RpolUpdateSubmit","description":"Submit the draft for approval. Only the person who made it submits it.","examples":[{"type":"RpolUpdateSubmit","expectedVersion":1250,"reasonCode":"NewTypology","reason":"Requested by the customer."}],"type":"object","required":["type","expectedVersion","reasonCode"],"properties":{"type":{"description":"Always `RpolUpdateSubmit`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RpolUpdateSubmit"]},"expectedVersion":{"type":"integer","format":"int32"},"reasonCode":{"$ref":"#/components/schemas/RpolReason"},"reason":{"type":"string"}}},"RpolValue":{"oneOf":[{"$ref":"#/components/schemas/RpolValueAmount"},{"$ref":"#/components/schemas/RpolValueFlag"},{"$ref":"#/components/schemas/RpolValueLists"},{"$ref":"#/components/schemas/RpolValueNumber"},{"$ref":"#/components/schemas/RpolValueNumbers"},{"$ref":"#/components/schemas/RpolValuePercent"},{"$ref":"#/components/schemas/RpolValueText"},{"$ref":"#/components/schemas/RpolValueTexts"},{"$ref":"#/components/schemas/RpolValueWindow"}],"discriminator":{"propertyName":"type","mapping":{"RpolValueAmount":"#/components/schemas/RpolValueAmount","RpolValueFlag":"#/components/schemas/RpolValueFlag","RpolValueLists":"#/components/schemas/RpolValueLists","RpolValueNumber":"#/components/schemas/RpolValueNumber","RpolValueNumbers":"#/components/schemas/RpolValueNumbers","RpolValuePercent":"#/components/schemas/RpolValuePercent","RpolValueText":"#/components/schemas/RpolValueText","RpolValueTexts":"#/components/schemas/RpolValueTexts","RpolValueWindow":"#/components/schemas/RpolValueWindow"}}},"RpolValueAmount":{"title":"RpolValueAmount","description":"An amount of money in one currency.","examples":[{"type":"RpolValueAmount","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"}}],"type":"object","required":["type","amount"],"properties":{"type":{"description":"Always `RpolValueAmount`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RpolValueAmount"]},"amount":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"An amount in minor current units of a given currency."}}},"RpolValueFlag":{"title":"RpolValueFlag","description":"Yes or no.","examples":[{"type":"RpolValueFlag","flag":true}],"type":"object","required":["type","flag"],"properties":{"type":{"description":"Always `RpolValueFlag`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RpolValueFlag"]},"flag":{"type":"boolean"}}},"RpolValueLists":{"title":"RpolValueLists","description":"One or more named lists, by id. The lists must be ones the rule's owner may name: its own, or those of a tenant above it.","examples":[{"type":"RpolValueLists","namedListIds":["nlst_9f2Kd8QpLzXw"]}],"type":"object","required":["type","namedListIds"],"properties":{"type":{"description":"Always `RpolValueLists`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RpolValueLists"]},"namedListIds":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/NlstId"}}}},"RpolValueNumber":{"title":"RpolValueNumber","description":"A number.","examples":[{"type":"RpolValueNumber","number":12.5}],"type":"object","required":["type","number"],"properties":{"type":{"description":"Always `RpolValueNumber`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RpolValueNumber"]},"number":{"type":"number"}}},"RpolValueNumbers":{"title":"RpolValueNumbers","description":"Several numbers.","examples":[{"type":"RpolValueNumbers","numbers":[12.5]}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `RpolValueNumbers`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RpolValueNumbers"]},"numbers":{"type":"array","items":{"type":"number"}}}},"RpolValuePercent":{"title":"RpolValuePercent","description":"A percentage from 0 to 100.","examples":[{"type":"RpolValuePercent","percent":12.5}],"type":"object","required":["type","percent"],"properties":{"type":{"description":"Always `RpolValuePercent`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RpolValuePercent"]},"percent":{"type":"number"}}},"RpolValueText":{"title":"RpolValueText","description":"Text, such as a name or a code.","examples":[{"type":"RpolValueText","text":"example"}],"type":"object","required":["type","text"],"properties":{"type":{"description":"Always `RpolValueText`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RpolValueText"]},"text":{"type":"string"}}},"RpolValueTexts":{"title":"RpolValueTexts","description":"Several pieces of text.","examples":[{"type":"RpolValueTexts","texts":["example"]}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `RpolValueTexts`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RpolValueTexts"]},"texts":{"type":"array","items":{"type":"string"}}}},"RpolValueWindow":{"title":"RpolValueWindow","description":"A length of time counted back from the moment a rule is evaluated, such as the last 30 days.","examples":[{"type":"RpolValueWindow","amount":1250,"unit":"Seconds"}],"type":"object","required":["type","amount","unit"],"properties":{"type":{"description":"Always `RpolValueWindow`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RpolValueWindow"]},"amount":{"type":"integer","format":"int64"},"unit":{"$ref":"#/components/schemas/RpolWindowUnit"}}},"RpolVersion":{"description":"One version of a rule policy, as it was when it was made, with what changed, why, by whom and when.","oneOf":[{"$ref":"#/components/schemas/RpolVersionAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RpolVersionAttributes":"#/components/schemas/RpolVersionAttributes"}}},"RpolVersionAttributes":{"title":"RpolVersionAttributes","description":"One version of a rule policy, as it was when it was made, with what changed, why, by whom and when.","examples":[{"type":"RpolVersionAttributes","version":1250,"state":"Draft","mode":"Shadow","paused":true,"rule":{"type":"RpolRuleAttributes","templateId":"abc123","arguments":[{"type":"RpolArgumentAttributes","parameterId":"abc123","value":{"type":"RpolValueAmount","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"}}}],"action":{"type":"RpolActionAttributes","name":"Ada Lovelace"}},"templateVersion":1250,"description":"A short description.","effectiveFrom":"2026-08-19T04:21:07Z","effectiveUntil":"2026-08-19T04:21:07Z","retiredAt":"2026-08-19T04:21:07Z","change":"Created","reasonCode":"NewTypology","reason":"Requested by the customer.","changedBy":"example","changedAt":"2026-08-19T04:21:07Z","approvedBy":"example","approvedAt":"2026-08-19T04:21:07Z","rejectedBy":"example","rejectedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","version","state","mode","paused","rule","templateVersion","effectiveFrom","change","reasonCode","changedBy","changedAt"],"properties":{"type":{"description":"Always `RpolVersionAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RpolVersionAttributes"]},"version":{"description":"The version's number, from 1.","type":"integer","format":"int32"},"state":{"$ref":"#/components/schemas/RpolState"},"mode":{"$ref":"#/components/schemas/RpolMode"},"paused":{"type":"boolean"},"rule":{"$ref":"#/components/schemas/RpolRule"},"templateVersion":{"type":"integer","format":"int32"},"description":{"type":"string"},"effectiveFrom":{"type":"string","format":"date-time"},"effectiveUntil":{"type":"string","format":"date-time"},"retiredAt":{"type":"string","format":"date-time"},"change":{"$ref":"#/components/schemas/RpolChange"},"reasonCode":{"$ref":"#/components/schemas/RpolReason"},"reason":{"type":"string"},"changedBy":{"type":"string"},"changedAt":{"type":"string","format":"date-time"},"approvedBy":{"type":"string"},"approvedAt":{"type":"string","format":"date-time"},"rejectedBy":{"type":"string"},"rejectedAt":{"type":"string","format":"date-time"}}},"RpolVersionPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/RpolVersionPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RpolVersionPageAttributes":"#/components/schemas/RpolVersionPageAttributes"}}},"RpolVersionPageAttributes":{"title":"RpolVersionPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"RpolVersionPageAttributes","data":[{"type":"RpolVersionAttributes","version":1250,"state":"Draft","mode":"Shadow","paused":true,"rule":{"type":"RpolRuleAttributes","templateId":"abc123","arguments":[{"type":"RpolArgumentAttributes","parameterId":"abc123","value":{"type":"RpolValueAmount","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"}}}],"action":{"type":"RpolActionAttributes","name":"Ada Lovelace"}},"templateVersion":1250,"description":"A short description.","effectiveFrom":"2026-08-19T04:21:07Z","effectiveUntil":"2026-08-19T04:21:07Z","retiredAt":"2026-08-19T04:21:07Z","change":"Created","reasonCode":"NewTypology","reason":"Requested by the customer.","changedBy":"example","changedAt":"2026-08-19T04:21:07Z","approvedBy":"example","approvedAt":"2026-08-19T04:21:07Z","rejectedBy":"example","rejectedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `RpolVersionPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RpolVersionPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/RpolVersion"}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"RpolView":{"oneOf":[{"$ref":"#/components/schemas/RpolViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RpolViewAttributes":"#/components/schemas/RpolViewAttributes"}}},"RpolViewAttributes":{"title":"RpolViewAttributes","description":"A rule, held by a tenant. It is made from one of its area's templates, and each change is a version of its own: a version is made by one person and approved by another, and only an approved version is part of a ruleset. The tenant that owns it manages it, as do the tenants above it; the tenants beneath it read it.","examples":[{"type":"RpolViewAttributes","rulePolicyId":"rpol_9f2Kd8QpLzXw","domain":"example","owner":{"type":"RpolOwnerEnterprise","enterpriseId":"ent_9f2Kd8QpLzXw"},"state":"Draft","mode":"Shadow","paused":true,"rule":{"type":"RpolRuleAttributes","templateId":"abc123","arguments":[{"type":"RpolArgumentAttributes","parameterId":"abc123","value":{"type":"RpolValueAmount","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"}}}],"action":{"type":"RpolActionAttributes","name":"Ada Lovelace"}},"templateVersion":1250,"description":"A short description.","version":1250,"effectiveFrom":"2026-08-19T04:21:07Z","effectiveUntil":"2026-08-19T04:21:07Z","retiredAt":"2026-08-19T04:21:07Z","createdAt":"2026-08-19T04:21:07Z","createdBy":"example","updatedAt":"2026-08-19T04:21:07Z","updatedBy":"example","approvedBy":"example","approvedAt":"2026-08-19T04:21:07Z","rejectedBy":"example","rejectedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","rulePolicyId","domain","owner","state","mode","paused","rule","templateVersion","version","effectiveFrom","createdAt","createdBy","updatedAt","updatedBy"],"properties":{"type":{"description":"Always `RpolViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RpolViewAttributes"]},"rulePolicyId":{"$ref":"#/components/schemas/RpolId"},"domain":{"description":"The area the rule belongs to, as `ruleAreaId` names it.","type":"string"},"owner":{"$ref":"#/components/schemas/RpolOwner"},"state":{"$ref":"#/components/schemas/RpolState","description":"The state of the current version."},"mode":{"$ref":"#/components/schemas/RpolMode"},"paused":{"description":"Whether the rule is switched off without being retired.","type":"boolean"},"rule":{"$ref":"#/components/schemas/RpolRule"},"templateVersion":{"description":"The version of its template the rule was made with, which it keeps for as long as the policy holds it.","type":"integer","format":"int32"},"description":{"type":"string"},"version":{"description":"The current version, which a change names as `expectedVersion`.","type":"integer","format":"int32"},"effectiveFrom":{"description":"When the rule takes effect.","type":"string","format":"date-time"},"effectiveUntil":{"description":"When the rule stops taking effect. Absent for one that does not.","type":"string","format":"date-time"},"retiredAt":{"description":"When the rule was retired. Absent for one that is not.","type":"string","format":"date-time"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"description":"Who made the policy, keyed as a person or an API key is: `user_` or `staff_` or `key_`, and an id.","type":"string"},"updatedAt":{"type":"string","format":"date-time"},"updatedBy":{"description":"Who made the current version.","type":"string"},"approvedBy":{"type":"string"},"approvedAt":{"type":"string","format":"date-time"},"rejectedBy":{"type":"string"},"rejectedAt":{"type":"string","format":"date-time"}}},"RpolWindowUnit":{"title":"RpolWindowUnit","type":"string","enum":["Seconds","Minutes","Hours","Days","Weeks","Unknown"]},"RprtCmd":{"oneOf":[{"$ref":"#/components/schemas/RprtCmdPayout"},{"$ref":"#/components/schemas/RprtCmdRefunds"},{"$ref":"#/components/schemas/RprtCmdSettlement"},{"$ref":"#/components/schemas/RprtCmdTransactions"}],"discriminator":{"propertyName":"type","mapping":{"RprtCmdPayout":"#/components/schemas/RprtCmdPayout","RprtCmdRefunds":"#/components/schemas/RprtCmdRefunds","RprtCmdSettlement":"#/components/schemas/RprtCmdSettlement","RprtCmdTransactions":"#/components/schemas/RprtCmdTransactions"}}},"RprtCmdPayout":{"title":"RprtCmdPayout","description":"One payout's payments and refunds.","examples":[{"type":"RprtCmdPayout","merchantId":"mcht_9f2Kd8QpLzXw","payoutId":"payout_9f2Kd8QpLzXw","emailTo":["ada@example.com"],"includeSettlementReport":true}],"type":"object","required":["type","payoutId"],"properties":{"type":{"description":"Always `RprtCmdPayout`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RprtCmdPayout"]},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"The payout's merchant. Omit it, the payout names it."},"payoutId":{"$ref":"#/components/schemas/PayoutId","description":"Identifier of a payout."},"emailTo":{"description":"Also email the report to these addresses. The platform does not report send failures.","type":"array","items":{"type":"string"}},"includeSettlementReport":{"description":"Attach the settlement report to that email as well. Only meaningful with `emailTo`.","type":"boolean"}}},"RprtCmdRefunds":{"title":"RprtCmdRefunds","description":"Refunds made over a period.","examples":[{"type":"RprtCmdRefunds","merchantId":"mcht_9f2Kd8QpLzXw","from":"2026-08-19T04:21:07Z","to":"2026-08-19T04:21:07Z","timeZone":"example"}],"type":"object","required":["type","merchantId","from","to","timeZone"],"properties":{"type":{"description":"Always `RprtCmdRefunds`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RprtCmdRefunds"]},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"Identifier of a merchant."},"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"timeZone":{"description":"Render timestamps at this offset from UTC, `+11:00`. This sets the day boundaries.","type":"string"}}},"RprtCmdSettlement":{"title":"RprtCmdSettlement","description":"A merchant's settlement, for one payout or over a period.","examples":[{"type":"RprtCmdSettlement","merchantId":"mcht_9f2Kd8QpLzXw","scope":{"type":"RprtSettlementScopePayout","payoutId":"payout_9f2Kd8QpLzXw"},"transactionId":["tran_9f2Kd8QpLzXw"],"orderReference":"your-own-reference","settlementType":"Net"}],"type":"object","required":["type","merchantId","scope"],"properties":{"type":{"description":"Always `RprtCmdSettlement`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RprtCmdSettlement"]},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"Identifier of a merchant."},"scope":{"$ref":"#/components/schemas/RprtSettlementScope"},"transactionId":{"description":"Narrow to these transactions. Repeat to supply several.","type":"array","items":{"$ref":"#/components/schemas/TranId","description":"Identifier of a transaction."}},"orderReference":{"description":"Narrow to one of the merchant's own order references.","type":"string"},"settlementType":{"$ref":"#/components/schemas/MchtSettlementType","description":"Narrow to net or gross settlement."}}},"RprtCmdTransactions":{"title":"RprtCmdTransactions","description":"Transactions taken over a period.","examples":[{"type":"RprtCmdTransactions","merchantId":"mcht_9f2Kd8QpLzXw","from":"2026-08-19T04:21:07Z","to":"2026-08-19T04:21:07Z","timeZone":"example"}],"type":"object","required":["type","merchantId","from","to","timeZone"],"properties":{"type":{"description":"Always `RprtCmdTransactions`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RprtCmdTransactions"]},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"Identifier of a merchant."},"from":{"description":"Include transactions from this instant.","type":"string","format":"date-time"},"to":{"description":"Include transactions up to this instant.","type":"string","format":"date-time"},"timeZone":{"description":"Render timestamps at this offset from UTC, `+11:00`. This sets the day boundaries.","type":"string"}}},"RprtCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/RprtCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RprtCreateRspAttributes":"#/components/schemas/RprtCreateRspAttributes"}}},"RprtCreateRspAttributes":{"title":"RprtCreateRspAttributes","examples":[{"type":"RprtCreateRspAttributes","created":{"type":"RprtViewPayout","merchantId":"mcht_9f2Kd8QpLzXw","payoutId":"payout_9f2Kd8QpLzXw","facilitation":"example","amounts":{"type":"RprtPayoutAmountsAttributes","currency":"AUD","payout":1250,"gross":1250,"net":1250,"feesInclTax":1250,"feesTax":1250},"createdAt":"2026-08-19T04:21:07Z","arrivedAt":"2026-08-19T04:21:07Z","emailedTo":["ada@example.com"],"rows":[{"type":"RprtPaymentRowAttributes","direction":"example","transactionId":"tran_9f2Kd8QpLzXw","orderReference":"your-own-reference","paymentType":"example","net":1250,"feeInclTax":1250,"feeTax":1250,"customFields":{"yourKey":"example"},"at":"2026-08-19T04:21:07Z"}]}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `RprtCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RprtCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/RprtView"}}},"RprtFee":{"description":"The platform fee on this transaction and how it was arrived at.","oneOf":[{"$ref":"#/components/schemas/RprtFeeAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RprtFeeAttributes":"#/components/schemas/RprtFeeAttributes"}}},"RprtFeeAttributes":{"title":"RprtFeeAttributes","description":"How a platform fee was arrived at. Amounts in the enclosing row's currency.","examples":[{"type":"RprtFeeAttributes","total":1250,"fixed":1250,"percentage":"example","tax":1250}],"type":"object","required":["type","total","fixed","percentage","tax"],"properties":{"type":{"description":"Always `RprtFeeAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RprtFeeAttributes"]},"total":{"$ref":"#/components/schemas/MinorUnits","description":"The fee charged, including tax."},"fixed":{"$ref":"#/components/schemas/MinorUnits","description":"The fixed component."},"percentage":{"description":"The percentage component, as a decimal, `0.0175` is 1.75%.","type":"string"},"tax":{"$ref":"#/components/schemas/MinorUnits","description":"The tax within the fee."}}},"RprtPaymentRow":{"description":"One payment or refund inside a payout. All amounts in the payout's currency.","oneOf":[{"$ref":"#/components/schemas/RprtPaymentRowAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RprtPaymentRowAttributes":"#/components/schemas/RprtPaymentRowAttributes"}}},"RprtPaymentRowAttributes":{"title":"RprtPaymentRowAttributes","description":"One payment or refund inside a payout. All amounts in the payout's currency.","examples":[{"type":"RprtPaymentRowAttributes","direction":"example","transactionId":"tran_9f2Kd8QpLzXw","orderReference":"your-own-reference","paymentType":"example","net":1250,"feeInclTax":1250,"feeTax":1250,"customFields":{"yourKey":"example"},"at":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","direction","net","feeInclTax","feeTax","at"],"properties":{"type":{"description":"Always `RprtPaymentRowAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RprtPaymentRowAttributes"]},"direction":{"description":"`Payment` or `Refund`. The platform signs the totals by this.","type":"string"},"transactionId":{"$ref":"#/components/schemas/TranId","description":"The transaction this row is for, where there is one."},"orderReference":{"description":"The merchant's own order reference.","type":"string"},"paymentType":{"description":"What kind of payment it was.","type":"string"},"net":{"$ref":"#/components/schemas/MinorUnits","description":"What reached the merchant."},"feeInclTax":{"$ref":"#/components/schemas/MinorUnits","description":"The platform fee, including tax."},"feeTax":{"$ref":"#/components/schemas/MinorUnits","description":"The tax within that fee."},"customFields":{"$ref":"#/components/schemas/MchtStringMap","description":"Values the merchant defined for its own order reporting."},"at":{"type":"string","format":"date-time"}}},"RprtPayoutAmounts":{"description":"What a payout's contents came to. All in the single currency given here.","oneOf":[{"$ref":"#/components/schemas/RprtPayoutAmountsAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RprtPayoutAmountsAttributes":"#/components/schemas/RprtPayoutAmountsAttributes"}}},"RprtPayoutAmountsAttributes":{"title":"RprtPayoutAmountsAttributes","description":"What a payout's contents came to. All in the single currency given here.","examples":[{"type":"RprtPayoutAmountsAttributes","currency":"AUD","payout":1250,"gross":1250,"net":1250,"feesInclTax":1250,"feesTax":1250}],"type":"object","required":["type","currency","gross","net","feesInclTax","feesTax"],"properties":{"type":{"description":"Always `RprtPayoutAmountsAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RprtPayoutAmountsAttributes"]},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"payout":{"$ref":"#/components/schemas/MinorUnits","description":"The payout itself, as the platform recorded it. Absent on a payout that has not been valued."},"gross":{"$ref":"#/components/schemas/MinorUnits","description":"Before fees, netting refunds off."},"net":{"$ref":"#/components/schemas/MinorUnits","description":"After fees."},"feesInclTax":{"$ref":"#/components/schemas/MinorUnits","description":"Platform fees, including tax."},"feesTax":{"$ref":"#/components/schemas/MinorUnits","description":"The tax within those fees."}}},"RprtRefundRow":{"description":"One refund, flattened for reporting. All amounts in the currency given here.","oneOf":[{"$ref":"#/components/schemas/RprtRefundRowAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RprtRefundRowAttributes":"#/components/schemas/RprtRefundRowAttributes"}}},"RprtRefundRowAttributes":{"title":"RprtRefundRowAttributes","description":"One refund, flattened for reporting. All amounts in the currency given here.","examples":[{"type":"RprtRefundRowAttributes","refundId":"rfnd_9f2Kd8QpLzXw","transactionId":"tran_9f2Kd8QpLzXw","orderReference":"your-own-reference","customerEmail":"ada@example.com","currency":"AUD","amount":1250,"payoutId":"payout_9f2Kd8QpLzXw","paidOutAt":"2026-08-19T04:21:07Z","paidOutAmount":1250,"at":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","refundId","currency","amount","at"],"properties":{"type":{"description":"Always `RprtRefundRowAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RprtRefundRowAttributes"]},"refundId":{"type":"string"},"transactionId":{"$ref":"#/components/schemas/TranId","description":"The transaction refunded, where the refund is of one."},"orderReference":{"description":"The merchant's own order reference.","type":"string"},"customerEmail":{"type":"string"},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"amount":{"$ref":"#/components/schemas/MinorUnits","description":"An amount in the minor units of the currency given by the enclosing object's `currency` field."},"payoutId":{"$ref":"#/components/schemas/PayoutId","description":"The payout the refund was deducted from."},"paidOutAt":{"type":"string","format":"date-time"},"paidOutAmount":{"$ref":"#/components/schemas/MinorUnits","description":"An amount in the minor units of the currency given by the enclosing object's `currency` field."},"at":{"description":"When the refund was made.","type":"string","format":"date-time"}}},"RprtSettlementAmounts":{"description":"What a settlement period came to. All in the single currency given here.","oneOf":[{"$ref":"#/components/schemas/RprtSettlementAmountsAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RprtSettlementAmountsAttributes":"#/components/schemas/RprtSettlementAmountsAttributes"}}},"RprtSettlementAmountsAttributes":{"title":"RprtSettlementAmountsAttributes","description":"What a settlement period came to. All in the single currency given here.","examples":[{"type":"RprtSettlementAmountsAttributes","currency":"AUD","gross":1250,"net":1250,"feesInclTax":1250,"feesTax":1250}],"type":"object","required":["type","currency","gross","net","feesInclTax","feesTax"],"properties":{"type":{"description":"Always `RprtSettlementAmountsAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RprtSettlementAmountsAttributes"]},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"gross":{"$ref":"#/components/schemas/MinorUnits","description":"Before platform fees."},"net":{"$ref":"#/components/schemas/MinorUnits","description":"After them, what settles to the merchant."},"feesInclTax":{"$ref":"#/components/schemas/MinorUnits","description":"Platform fees, including tax."},"feesTax":{"$ref":"#/components/schemas/MinorUnits","description":"The tax within those fees."}}},"RprtSettlementPayout":{"description":"The payout this settlement produced, where the report is of one.","oneOf":[{"$ref":"#/components/schemas/RprtSettlementPayoutAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RprtSettlementPayoutAttributes":"#/components/schemas/RprtSettlementPayoutAttributes"}}},"RprtSettlementPayoutAttributes":{"title":"RprtSettlementPayoutAttributes","description":"The payout a settlement report settled into. All in the single currency given here.","examples":[{"type":"RprtSettlementPayoutAttributes","payoutId":"payout_9f2Kd8QpLzXw","reference":"your-own-reference","status":"Active","settlementType":"Net","currency":"AUD","amount":1250,"openingBalance":1250,"closingBalance":1250,"activeFrom":"2026-08-19T04:21:07Z","activeTo":"2026-08-19T04:21:07Z","paidOn":"2026-08-19","failureReason":"Requested by the customer."}],"type":"object","required":["type","payoutId","status","settlementType","currency","amount","openingBalance","closingBalance"],"properties":{"type":{"description":"Always `RprtSettlementPayoutAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RprtSettlementPayoutAttributes"]},"payoutId":{"$ref":"#/components/schemas/PayoutId","description":"Identifier of a payout."},"reference":{"description":"The reference the merchant sees against the deposit.","type":"string"},"status":{"type":"string"},"settlementType":{"$ref":"#/components/schemas/MchtSettlementType"},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"amount":{"$ref":"#/components/schemas/MinorUnits","description":"An amount in the minor units of the currency given by the enclosing object's `currency` field."},"openingBalance":{"$ref":"#/components/schemas/MinorUnits","description":"An amount in the minor units of the currency given by the enclosing object's `currency` field."},"closingBalance":{"$ref":"#/components/schemas/MinorUnits","description":"An amount in the minor units of the currency given by the enclosing object's `currency` field."},"activeFrom":{"description":"The earliest entry the payout covers.","type":"string","format":"date-time"},"activeTo":{"description":"The latest entry the payout covers.","type":"string","format":"date-time"},"paidOn":{"description":"The day the funds were paid.","type":"string","format":"date"},"failureReason":{"description":"Why the payout failed, where it did.","type":"string"}}},"RprtSettlementRow":{"description":"One line of a settlement report. All amounts in the currency given here.","oneOf":[{"$ref":"#/components/schemas/RprtSettlementRowAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RprtSettlementRowAttributes":"#/components/schemas/RprtSettlementRowAttributes"}}},"RprtSettlementRowAttributes":{"title":"RprtSettlementRowAttributes","description":"One line of a settlement report. All amounts in the currency given here.","examples":[{"type":"RprtSettlementRowAttributes","entryDate":"2026-08-19","entryAt":"2026-08-19T04:21:07Z","entryType":"example","description":"A short description.","settlementDate":"2026-08-19","merchantId":"mcht_9f2Kd8QpLzXw","merchantName":"Ada Lovelace","cardHolderName":"Ada Lovelace","cardNumber":"example","transactionType":"example","orderType":"example","orderReference":"your-own-reference","orderDescription":"A short description.","orderMetadata":{"yourKey":{}},"orderId":"ordr_9f2Kd8QpLzXw","transactionId":"tran_9f2Kd8QpLzXw","refundId":"rfnd_9f2Kd8QpLzXw","payoutId":"payout_9f2Kd8QpLzXw","payoutReference":"your-own-reference","billingCategory":"example","feeSummary":"example","currency":"AUD","transactionAmount":1250,"gross":1250,"net":1250,"feesInclTax":1250,"feesTax":1250,"customFields":{"yourKey":"example"}}],"type":"object","required":["type","entryDate","entryAt","entryType","merchantId","merchantName","currency","gross","net","feesInclTax","feesTax"],"properties":{"type":{"description":"Always `RprtSettlementRowAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RprtSettlementRowAttributes"]},"entryDate":{"description":"The day the entry was made.","type":"string","format":"date"},"entryAt":{"description":"The instant it was made.","type":"string","format":"date-time"},"entryType":{"description":"What kind of movement, the platform's vocabulary, which grows.","type":"string"},"description":{"description":"What the entry is, in words.","type":"string"},"settlementDate":{"description":"The day it settles.","type":"string","format":"date"},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"Identifier of a merchant."},"merchantName":{"description":"Business name of the merchant, so a spreadsheet reads without a second call.","type":"string"},"cardHolderName":{"description":"The name on the card, where the entry came from a card payment.","type":"string"},"cardNumber":{"description":"The masked card number, where it did.","type":"string"},"transactionType":{"description":"What kind of transaction it was.","type":"string"},"orderType":{"description":"What kind of order it came from.","type":"string"},"orderReference":{"description":"The merchant's own order reference.","type":"string"},"orderDescription":{"description":"What the order was for.","type":"string"},"orderMetadata":{"$ref":"#/components/schemas/Metadata","description":"Free-form data carried from the order."},"orderId":{"type":"string"},"transactionId":{"$ref":"#/components/schemas/TranId","description":"Identifier of a transaction."},"refundId":{"type":"string"},"payoutId":{"$ref":"#/components/schemas/PayoutId","description":"The payout this entry landed in."},"payoutReference":{"description":"The reference the merchant sees against that payout.","type":"string"},"billingCategory":{"description":"The merchant's billing category for this entry.","type":"string"},"feeSummary":{"description":"How the fees on this entry were arrived at, as the platform prints it.","type":"string"},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"transactionAmount":{"$ref":"#/components/schemas/MinorUnits","description":"The transaction's own amount, where the entry relates to one."},"gross":{"$ref":"#/components/schemas/MinorUnits","description":"Before fees."},"net":{"$ref":"#/components/schemas/MinorUnits","description":"After them."},"feesInclTax":{"$ref":"#/components/schemas/MinorUnits","description":"Platform fees, including tax."},"feesTax":{"$ref":"#/components/schemas/MinorUnits","description":"The tax within those fees."},"customFields":{"$ref":"#/components/schemas/MchtStringMap","description":"Values the merchant defined for its own reporting."}}},"RprtSettlementScope":{"oneOf":[{"$ref":"#/components/schemas/RprtSettlementScopePayout"},{"$ref":"#/components/schemas/RprtSettlementScopePeriod"}],"discriminator":{"propertyName":"type","mapping":{"RprtSettlementScopePayout":"#/components/schemas/RprtSettlementScopePayout","RprtSettlementScopePeriod":"#/components/schemas/RprtSettlementScopePeriod"}}},"RprtSettlementScopePayout":{"title":"RprtSettlementScopePayout","description":"One payout's settlement.","examples":[{"type":"RprtSettlementScopePayout","payoutId":"payout_9f2Kd8QpLzXw"}],"type":"object","required":["type","payoutId"],"properties":{"type":{"description":"Always `RprtSettlementScopePayout`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RprtSettlementScopePayout"]},"payoutId":{"$ref":"#/components/schemas/PayoutId","description":"Identifier of a payout."}}},"RprtSettlementScopePeriod":{"title":"RprtSettlementScopePeriod","description":"A currency's settlement over a period. The platform enforces a maximum span.","examples":[{"type":"RprtSettlementScopePeriod","currency":"AUD","from":"2026-08-19T04:21:07Z","to":"2026-08-19T04:21:07Z","timeZone":"example"}],"type":"object","required":["type","currency","from","to","timeZone"],"properties":{"type":{"description":"Always `RprtSettlementScopePeriod`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RprtSettlementScopePeriod"]},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"timeZone":{"description":"Render timestamps at this offset from UTC, `+11:00`. This sets the day boundaries.","type":"string"}}},"RprtTransactionRow":{"description":"One transaction, flattened for reporting. All amounts in the currency given here.","oneOf":[{"$ref":"#/components/schemas/RprtTransactionRowAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RprtTransactionRowAttributes":"#/components/schemas/RprtTransactionRowAttributes"}}},"RprtTransactionRowAttributes":{"title":"RprtTransactionRowAttributes","description":"One transaction, flattened for reporting. All amounts in the currency given here.","examples":[{"type":"RprtTransactionRowAttributes","transactionId":"tran_9f2Kd8QpLzXw","orderReference":"your-own-reference","customerEmail":"ada@example.com","customerName":"Ada Lovelace","paymentType":"example","orderType":"example","status":"Active","currency":"AUD","amount":1250,"surcharge":1250,"refunded":1250,"fee":{"type":"RprtFeeAttributes","total":1250,"fixed":1250,"percentage":"example","tax":1250},"payoutId":"payout_9f2Kd8QpLzXw","paidOutAt":"2026-08-19T04:21:07Z","paidOutAmount":1250,"at":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","transactionId","paymentType","status","currency","amount","surcharge","refunded","at"],"properties":{"type":{"description":"Always `RprtTransactionRowAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RprtTransactionRowAttributes"]},"transactionId":{"$ref":"#/components/schemas/TranId","description":"Identifier of a transaction."},"orderReference":{"description":"The merchant's own order reference, where the transaction came from an order.","type":"string"},"customerEmail":{"description":"The customer's email, from the customer record or the order.","type":"string"},"customerName":{"description":"The customer's name, where the platform has one.","type":"string"},"paymentType":{"description":"What kind of payment, the platform's vocabulary, which grows.","type":"string"},"orderType":{"description":"What kind of order it came from, where it came from one.","type":"string"},"status":{"type":"string"},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"amount":{"$ref":"#/components/schemas/MinorUnits","description":"An amount in the minor units of the currency given by the enclosing object's `currency` field."},"surcharge":{"$ref":"#/components/schemas/MinorUnits","description":"An amount in the minor units of the currency given by the enclosing object's `currency` field."},"refunded":{"$ref":"#/components/schemas/MinorUnits","description":"An amount in the minor units of the currency given by the enclosing object's `currency` field."},"fee":{"$ref":"#/components/schemas/RprtFee"},"payoutId":{"$ref":"#/components/schemas/PayoutId","description":"The payout that carried this transaction to the merchant."},"paidOutAt":{"description":"When that payout was made.","type":"string","format":"date-time"},"paidOutAmount":{"$ref":"#/components/schemas/MinorUnits","description":"How much of this transaction was in that payout."},"at":{"description":"When the transaction was taken.","type":"string","format":"date-time"}}},"RprtView":{"description":"The resource that was created.","oneOf":[{"$ref":"#/components/schemas/RprtViewPayout"},{"$ref":"#/components/schemas/RprtViewRefunds"},{"$ref":"#/components/schemas/RprtViewSettlement"},{"$ref":"#/components/schemas/RprtViewTransactions"}],"discriminator":{"propertyName":"type","mapping":{"RprtViewPayout":"#/components/schemas/RprtViewPayout","RprtViewRefunds":"#/components/schemas/RprtViewRefunds","RprtViewSettlement":"#/components/schemas/RprtViewSettlement","RprtViewTransactions":"#/components/schemas/RprtViewTransactions"}}},"RprtViewPayout":{"title":"RprtViewPayout","description":"One payout's payments and refunds, with the fee totals the payout itself does not carry.","examples":[{"type":"RprtViewPayout","merchantId":"mcht_9f2Kd8QpLzXw","payoutId":"payout_9f2Kd8QpLzXw","facilitation":"example","amounts":{"type":"RprtPayoutAmountsAttributes","currency":"AUD","payout":1250,"gross":1250,"net":1250,"feesInclTax":1250,"feesTax":1250},"createdAt":"2026-08-19T04:21:07Z","arrivedAt":"2026-08-19T04:21:07Z","emailedTo":["ada@example.com"],"rows":[{"type":"RprtPaymentRowAttributes","direction":"example","transactionId":"tran_9f2Kd8QpLzXw","orderReference":"your-own-reference","paymentType":"example","net":1250,"feeInclTax":1250,"feeTax":1250,"customFields":{"yourKey":"example"},"at":"2026-08-19T04:21:07Z"}]}],"type":"object","required":["type","merchantId","payoutId","facilitation","amounts","createdAt"],"properties":{"type":{"description":"Always `RprtViewPayout`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RprtViewPayout"]},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"Identifier of a merchant."},"payoutId":{"$ref":"#/components/schemas/PayoutId","description":"Identifier of a payout."},"facilitation":{"description":"Who facilitates the payment, the platform's own funds flow, or a connected gateway account.","type":"string"},"amounts":{"$ref":"#/components/schemas/RprtPayoutAmounts"},"createdAt":{"description":"When the payout was raised.","type":"string","format":"date-time"},"arrivedAt":{"description":"When the destination bank acknowledged the funds.","type":"string","format":"date-time"},"emailedTo":{"description":"Where the report was emailed. Empty unless `emailTo` was given on the request.","type":"array","items":{"type":"string"}},"rows":{"type":"array","items":{"$ref":"#/components/schemas/RprtPaymentRow"}}}},"RprtViewRefunds":{"title":"RprtViewRefunds","description":"Refunds over a period: how many, and a flattened row for each.","examples":[{"type":"RprtViewRefunds","merchantId":"mcht_9f2Kd8QpLzXw","total":1250,"rows":[{"type":"RprtRefundRowAttributes","refundId":"rfnd_9f2Kd8QpLzXw","transactionId":"tran_9f2Kd8QpLzXw","orderReference":"your-own-reference","customerEmail":"ada@example.com","currency":"AUD","amount":1250,"payoutId":"payout_9f2Kd8QpLzXw","paidOutAt":"2026-08-19T04:21:07Z","paidOutAmount":1250,"at":"2026-08-19T04:21:07Z"}]}],"type":"object","required":["type","merchantId","total"],"properties":{"type":{"description":"Always `RprtViewRefunds`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RprtViewRefunds"]},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"Identifier of a merchant."},"total":{"type":"integer","format":"int64"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/RprtRefundRow"}}}},"RprtViewSettlement":{"title":"RprtViewSettlement","description":"A merchant's settlement over a period or for one payout, with the aggregates and the payout it settled.","examples":[{"type":"RprtViewSettlement","merchantId":"mcht_9f2Kd8QpLzXw","amounts":{"type":"RprtSettlementAmountsAttributes","currency":"AUD","gross":1250,"net":1250,"feesInclTax":1250,"feesTax":1250},"payout":{"type":"RprtSettlementPayoutAttributes","payoutId":"payout_9f2Kd8QpLzXw","reference":"your-own-reference","status":"Active","settlementType":"Net","currency":"AUD","amount":1250,"openingBalance":1250,"closingBalance":1250,"activeFrom":"2026-08-19T04:21:07Z","activeTo":"2026-08-19T04:21:07Z","paidOn":"2026-08-19","failureReason":"Requested by the customer."},"totalRecords":1250,"includedColumns":["example"],"createdAt":"2026-08-19T04:21:07Z","rows":[{"type":"RprtSettlementRowAttributes","entryDate":"2026-08-19","entryAt":"2026-08-19T04:21:07Z","entryType":"example","description":"A short description.","settlementDate":"2026-08-19","merchantId":"mcht_9f2Kd8QpLzXw","merchantName":"Ada Lovelace","cardHolderName":"Ada Lovelace","cardNumber":"example","transactionType":"example","orderType":"example","orderReference":"your-own-reference","orderDescription":"A short description.","orderMetadata":{"yourKey":{}},"orderId":"ordr_9f2Kd8QpLzXw","transactionId":"tran_9f2Kd8QpLzXw","refundId":"rfnd_9f2Kd8QpLzXw","payoutId":"payout_9f2Kd8QpLzXw","payoutReference":"your-own-reference","billingCategory":"example","feeSummary":"example","currency":"AUD","transactionAmount":1250,"gross":1250,"net":1250,"feesInclTax":1250,"feesTax":1250,"customFields":{"yourKey":"example"}}]}],"type":"object","required":["type","merchantId","amounts","totalRecords","createdAt"],"properties":{"type":{"description":"Always `RprtViewSettlement`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RprtViewSettlement"]},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"Identifier of a merchant."},"amounts":{"$ref":"#/components/schemas/RprtSettlementAmounts"},"payout":{"$ref":"#/components/schemas/RprtSettlementPayout"},"totalRecords":{"description":"Rows in the report. The platform's own count.","type":"integer","format":"int64"},"includedColumns":{"description":"Which columns the merchant's settings say to include. A row still carries every field; this says which the merchant asked for.","type":"array","items":{"type":"string"}},"createdAt":{"description":"When the report was produced.","type":"string","format":"date-time"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/RprtSettlementRow"}}}},"RprtViewTransactions":{"title":"RprtViewTransactions","description":"Transactions over a period: how many, and a flattened row for each.","examples":[{"type":"RprtViewTransactions","merchantId":"mcht_9f2Kd8QpLzXw","total":1250,"rows":[{"type":"RprtTransactionRowAttributes","transactionId":"tran_9f2Kd8QpLzXw","orderReference":"your-own-reference","customerEmail":"ada@example.com","customerName":"Ada Lovelace","paymentType":"example","orderType":"example","status":"Active","currency":"AUD","amount":1250,"surcharge":1250,"refunded":1250,"fee":{"type":"RprtFeeAttributes","total":1250,"fixed":1250,"percentage":"example","tax":1250},"payoutId":"payout_9f2Kd8QpLzXw","paidOutAt":"2026-08-19T04:21:07Z","paidOutAmount":1250,"at":"2026-08-19T04:21:07Z"}]}],"type":"object","required":["type","merchantId","total"],"properties":{"type":{"description":"Always `RprtViewTransactions`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RprtViewTransactions"]},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"Identifier of a merchant."},"total":{"description":"Transactions in the period. This is the platform's own count, not the length of `rows`.","type":"integer","format":"int64"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/RprtTransactionRow"}}}},"Rqbat":{"description":"The resource that was created.","oneOf":[{"$ref":"#/components/schemas/RqbatAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RqbatAttributes":"#/components/schemas/RqbatAttributes"}}},"RqbatAnswer":{"oneOf":[{"$ref":"#/components/schemas/RqbatAnswered"},{"$ref":"#/components/schemas/RqbatRefused"}],"discriminator":{"propertyName":"type","mapping":{"RqbatAnswered":"#/components/schemas/RqbatAnswered","RqbatRefused":"#/components/schemas/RqbatRefused"}}},"RqbatAnswered":{"title":"RqbatAnswered","description":"The question's answer.","examples":[{"type":"RqbatAnswered","result":{"type":"RqryResultAttributes","reportDatasetId":"abc123","columns":[{"type":"RqryColumnAttributes","role":"Time","name":"Ada Lovelace","grain":"example","axis":"Rows"}],"rows":[{"type":"RqryRowAttributes","level":"Detail","depth":1250,"cells":["example"]}],"truncated":true,"next":"example","asOf":"2026-08-19T04:21:07Z","timezone":"example","labels":[{"type":"RqryLabelsAttributes","dimension":"example","values":[{"type":"RdsetValueAttributes","value":"example","label":"example"}]}],"currentAsOf":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","result"],"properties":{"type":{"description":"Always `RqbatAnswered`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RqbatAnswered"]},"result":{"$ref":"#/components/schemas/RqryResult","description":"A report's answer. Nothing is stored, so keep it."}}},"RqbatAttributes":{"title":"RqbatAttributes","description":"The answers to a batch, in the order the questions were asked.","examples":[{"type":"RqbatAttributes","answers":[{"type":"RqbatAnswered","result":{"type":"RqryResultAttributes","reportDatasetId":"abc123","columns":[{"type":"RqryColumnAttributes","role":"Time","name":"Ada Lovelace","grain":"example","axis":"Rows"}],"rows":[{"type":"RqryRowAttributes","level":"Detail","depth":1250,"cells":["example"]}],"truncated":true,"next":"example","asOf":"2026-08-19T04:21:07Z","timezone":"example","labels":[{"type":"RqryLabelsAttributes","dimension":"example","values":[{"type":"RdsetValueAttributes","value":"example","label":"example"}]}],"currentAsOf":"2026-08-19T04:21:07Z"}}]}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `RqbatAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RqbatAttributes"]},"answers":{"type":"array","items":{"$ref":"#/components/schemas/RqbatAnswer"}}}},"RqbatCmd":{"description":"Several questions asked together. Each is answered or refused on its own, so one bad tile never blanks a dashboard.","oneOf":[{"$ref":"#/components/schemas/RqbatCmdRun"}],"discriminator":{"propertyName":"type","mapping":{"RqbatCmdRun":"#/components/schemas/RqbatCmdRun"}}},"RqbatCmdRun":{"title":"RqbatCmdRun","description":"Several questions asked together. Each is answered or refused on its own, so one bad tile never blanks a dashboard.","examples":[{"type":"RqbatCmdRun","questions":[{"type":"RqryCmdRun","reportDatasetId":"abc123","measures":["example"],"dimensions":["example"],"time":{"type":"RqryTimeSliceAttributes","grain":"example","range":{"type":"RqryRangeBetween","from":"2026-08-19","to":"2026-08-19"},"compare":"PreviousPeriod"},"filters":[{"type":"RqryFilterAbove","dimension":"example","value":"example"}],"sort":[{"type":"RqrySortDimension","dimension":"example","ascending":true}],"limit":25,"page":"example","segments":["example"],"measureFilters":[{"type":"RqryMeasureFilterAbove","measure":"example","value":"example"}],"top":{"type":"RqryTopAttributes","dimension":"example","count":42,"measure":"example"},"narrowTo":{"type":"RqryNarrowCustomers","customerIds":["cust_9f2Kd8QpLzXw"]},"asAt":"2026-08-19T04:21:07Z","pivot":{"type":"RqryPivotAttributes","rows":["example"],"columns":["example"],"subtotals":true},"timezone":"example"}]}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `RqbatCmdRun`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RqbatCmdRun"]},"questions":{"description":"At most 20.","type":"array","items":{"$ref":"#/components/schemas/RqryCmdRun"}}}},"RqbatCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/RqbatCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RqbatCreateRspAttributes":"#/components/schemas/RqbatCreateRspAttributes"}}},"RqbatCreateRspAttributes":{"title":"RqbatCreateRspAttributes","examples":[{"type":"RqbatCreateRspAttributes","created":{"type":"RqbatAttributes","answers":[{"type":"RqbatAnswered","result":{"type":"RqryResultAttributes","reportDatasetId":"abc123","columns":[{"type":"RqryColumnAttributes","role":"Time","name":"Ada Lovelace","grain":"example","axis":"Rows"}],"rows":[{"type":"RqryRowAttributes","level":"Detail","depth":1250,"cells":["example"]}],"truncated":true,"next":"example","asOf":"2026-08-19T04:21:07Z","timezone":"example","labels":[{"type":"RqryLabelsAttributes","dimension":"example","values":[{"type":"RdsetValueAttributes","value":"example","label":"example"}]}],"currentAsOf":"2026-08-19T04:21:07Z"}}]}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `RqbatCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RqbatCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/Rqbat"}}},"RqbatRefused":{"title":"RqbatRefused","description":"Why the question was refused. `status` is the HTTP status the question would have answered alone.","examples":[{"type":"RqbatRefused","status":1250,"message":"example"}],"type":"object","required":["type","status","message"],"properties":{"type":{"description":"Always `RqbatRefused`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RqbatRefused"]},"status":{"type":"integer","format":"int32"},"message":{"type":"string"}}},"Rqplan":{"description":"The resource that was created.","oneOf":[{"$ref":"#/components/schemas/RqplanAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RqplanAttributes":"#/components/schemas/RqplanAttributes"}}},"RqplanAttributes":{"title":"RqplanAttributes","description":"The SQL a question compiles to, the source the router chose, and the planner's cost estimate.","examples":[{"type":"RqplanAttributes","sql":"example","plan":"example","estimatedCost":12.5,"sources":["example"],"timezone":"example","rollup":{"type":"RqplanRollupAttributes","relation":"example","grain":"example","timezone":"example"},"resolvedSql":"example","withoutCube":{"type":"RqplanWithoutCubeExplained","sql":"example","resolvedSql":"example","estimatedCost":12.5,"sources":["example"]}}],"type":"object","required":["type","sql","plan","timezone"],"properties":{"type":{"description":"Always `RqplanAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RqplanAttributes"]},"sql":{"description":"The statement as it runs, its values bound as `?` parameters.","type":"string"},"plan":{"description":"`rollup`, a rollup alone; `split`, a rollup and then the live view; `lambda`, the wide table and then the live view; `view`, the live view alone.","type":"string"},"estimatedCost":{"type":"number","format":"double"},"sources":{"type":"array","items":{"type":"string"}},"timezone":{"description":"The timezone the question would be answered in, an IANA name or an offset.","type":"string"},"rollup":{"$ref":"#/components/schemas/RqplanRollup"},"resolvedSql":{"description":"The statement with every value written in as a Postgres literal (the tenant scope, range bounds, filter values, timezone and limits), in a read-only transaction that publishes the scope and timezone the views read and is rolled back, ready to paste into psql. Absent when a value has no literal written for it. It holds tenant ids and filter values, so treat it as the data it reads.","type":"string"},"withoutCube":{"$ref":"#/components/schemas/RqplanWithoutCube"}}},"RqplanCmd":{"description":"What a question would run, without running it.","oneOf":[{"$ref":"#/components/schemas/RqplanCmdExplain"}],"discriminator":{"propertyName":"type","mapping":{"RqplanCmdExplain":"#/components/schemas/RqplanCmdExplain"}}},"RqplanCmdExplain":{"title":"RqplanCmdExplain","description":"What a question would run, without running it.","examples":[{"type":"RqplanCmdExplain","question":{"type":"RqryCmdRun","reportDatasetId":"abc123","measures":["example"],"dimensions":["example"],"time":{"type":"RqryTimeSliceAttributes","grain":"example","range":{"type":"RqryRangeBetween","from":"2026-08-19","to":"2026-08-19"},"compare":"PreviousPeriod"},"filters":[{"type":"RqryFilterAbove","dimension":"example","value":"example"}],"sort":[{"type":"RqrySortDimension","dimension":"example","ascending":true}],"limit":25,"page":"example","segments":["example"],"measureFilters":[{"type":"RqryMeasureFilterAbove","measure":"example","value":"example"}],"top":{"type":"RqryTopAttributes","dimension":"example","count":42,"measure":"example"},"narrowTo":{"type":"RqryNarrowCustomers","customerIds":["cust_9f2Kd8QpLzXw"]},"asAt":"2026-08-19T04:21:07Z","pivot":{"type":"RqryPivotAttributes","rows":["example"],"columns":["example"],"subtotals":true},"timezone":"example"}}],"type":"object","required":["type","question"],"properties":{"type":{"description":"Always `RqplanCmdExplain`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RqplanCmdExplain"]},"question":{"$ref":"#/components/schemas/RqryCmdRun"}}},"RqplanCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/RqplanCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RqplanCreateRspAttributes":"#/components/schemas/RqplanCreateRspAttributes"}}},"RqplanCreateRspAttributes":{"title":"RqplanCreateRspAttributes","examples":[{"type":"RqplanCreateRspAttributes","created":{"type":"RqplanAttributes","sql":"example","plan":"example","estimatedCost":12.5,"sources":["example"],"timezone":"example","rollup":{"type":"RqplanRollupAttributes","relation":"example","grain":"example","timezone":"example"},"resolvedSql":"example","withoutCube":{"type":"RqplanWithoutCubeExplained","sql":"example","resolvedSql":"example","estimatedCost":12.5,"sources":["example"]}}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `RqplanCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RqplanCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/Rqplan"}}},"RqplanRollup":{"description":"The pre-summed table the plan reads, with the grain and timezone it was summed at. Absent for a plan that reads none.","oneOf":[{"$ref":"#/components/schemas/RqplanRollupAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RqplanRollupAttributes":"#/components/schemas/RqplanRollupAttributes"}}},"RqplanRollupAttributes":{"title":"RqplanRollupAttributes","examples":[{"type":"RqplanRollupAttributes","relation":"example","grain":"example","timezone":"example"}],"type":"object","required":["type","relation","grain","timezone"],"properties":{"type":{"description":"Always `RqplanRollupAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RqplanRollupAttributes"]},"relation":{"type":"string"},"grain":{"type":"string"},"timezone":{"description":"The IANA timezone its buckets were summed in: UTC for the half-hour rollup, which serves every timezone whose offsets are whole half hours.","type":"string"}}},"RqplanWithoutCube":{"description":"The same question as if no cube served it, read straight from its analytics view at the same scope, narrowing and timezone: what the cube saves it. It is explained, never run.","oneOf":[{"$ref":"#/components/schemas/RqplanWithoutCubeExplained"},{"$ref":"#/components/schemas/RqplanWithoutCubeSameAsRun"}],"discriminator":{"propertyName":"type","mapping":{"RqplanWithoutCubeExplained":"#/components/schemas/RqplanWithoutCubeExplained","RqplanWithoutCubeSameAsRun":"#/components/schemas/RqplanWithoutCubeSameAsRun"}}},"RqplanWithoutCubeExplained":{"title":"RqplanWithoutCubeExplained","description":"The question read straight from its analytics view, which differs from the plan as run.","examples":[{"type":"RqplanWithoutCubeExplained","sql":"example","resolvedSql":"example","estimatedCost":12.5,"sources":["example"]}],"type":"object","required":["type","sql"],"properties":{"type":{"description":"Always `RqplanWithoutCubeExplained`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RqplanWithoutCubeExplained"]},"sql":{"description":"The statement, its values bound as `?` parameters.","type":"string"},"resolvedSql":{"description":"The statement with every value written in as a Postgres literal (the tenant scope, range bounds, filter values, timezone and limits), in a read-only transaction that publishes the scope and timezone the views read and is rolled back, ready to paste into psql. Absent when a value has no literal written for it. It holds tenant ids and filter values, so treat it as the data it reads.","type":"string"},"estimatedCost":{"type":"number","format":"double"},"sources":{"type":"array","items":{"type":"string"}}}},"RqplanWithoutCubeSameAsRun":{"title":"RqplanWithoutCubeSameAsRun","description":"The question already reads its analytics view alone, so the plan as run is the plan without the cube.","examples":[{"type":"RqplanWithoutCubeSameAsRun","plan":"example"}],"type":"object","required":["type","plan"],"properties":{"type":{"description":"Always `RqplanWithoutCubeSameAsRun`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RqplanWithoutCubeSameAsRun"]},"plan":{"description":"The plan as run, `view`.","type":"string"}}},"RqryCmd":{"oneOf":[{"$ref":"#/components/schemas/RqryCmdRun"}],"discriminator":{"propertyName":"type","mapping":{"RqryCmdRun":"#/components/schemas/RqryCmdRun"}}},"RqryCmdRun":{"title":"RqryCmdRun","description":"Ask a dataset a question. With measures, the answer is one row per combination of the dimensions and time buckets; with none, it is one row per record, in the dataset's row columns.","examples":[{"type":"RqryCmdRun","reportDatasetId":"abc123","measures":["example"],"dimensions":["example"],"time":{"type":"RqryTimeSliceAttributes","grain":"example","range":{"type":"RqryRangeBetween","from":"2026-08-19","to":"2026-08-19"},"compare":"PreviousPeriod"},"filters":[{"type":"RqryFilterAbove","dimension":"example","value":"example"}],"sort":[{"type":"RqrySortDimension","dimension":"example","ascending":true}],"limit":25,"page":"example","segments":["example"],"measureFilters":[{"type":"RqryMeasureFilterAbove","measure":"example","value":"example"}],"top":{"type":"RqryTopAttributes","dimension":"example","count":42,"measure":"example"},"narrowTo":{"type":"RqryNarrowCustomers","customerIds":["cust_9f2Kd8QpLzXw"]},"asAt":"2026-08-19T04:21:07Z","pivot":{"type":"RqryPivotAttributes","rows":["example"],"columns":["example"],"subtotals":true},"timezone":"example"}],"type":"object","required":["type","reportDatasetId"],"properties":{"type":{"description":"Always `RqryCmdRun`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RqryCmdRun"]},"reportDatasetId":{"type":"string"},"measures":{"description":"What to add up, by name from the dataset's `measures`.","type":"array","items":{"type":"string"}},"dimensions":{"description":"What to group by, by name from the dataset's `dimensions`.","type":"array","items":{"type":"string"}},"time":{"$ref":"#/components/schemas/RqryTimeSlice"},"filters":{"description":"Every filter must hold. A value is written as text whatever the dimension's kind: `12.50`, `2026-09-01`.","type":"array","items":{"$ref":"#/components/schemas/RqryFilter"}},"sort":{"type":"array","items":{"$ref":"#/components/schemas/RqrySort"}},"limit":{"description":"At most this many rows.","type":"integer","format":"int32"},"page":{"description":"`next` from the previous answer, to continue the same row-mode question. It is opaque and forward only, and a question changed in anything but `limit` refuses it with 400.","type":"string"},"segments":{"description":"Named filters from the dataset's `segments`, applied as well as `filters`.","type":"array","items":{"type":"string"}},"measureFilters":{"description":"Every one must hold of a group for it to be kept, tested after grouping. Each names one of `measures`; a value is a decimal written as text. Absent for none.","type":"array","items":{"$ref":"#/components/schemas/RqryMeasureFilter"}},"top":{"$ref":"#/components/schemas/RqryTop"},"narrowTo":{"$ref":"#/components/schemas/RqryNarrow"},"asAt":{"description":"Read each balance as at this instant: its latest snapshot before it, and every earlier one for a highest or lowest. Only balance measures have a value at an instant, and the question takes no `time`. Absent for all time.","type":"string","format":"date-time"},"pivot":{"$ref":"#/components/schemas/RqryPivot"},"timezone":{"description":"The timezone the question is answered in, an IANA name such as `Australia/Perth` or an offset such as `+10:00`, which keeps no daylight saving: where its buckets start, how its dates, periods and relative ranges are read, and which local day or hour a date part names. Absent for the asker's own, which the dataset's `timezone` gives: the timezone every active merchant the asker reads keeps, or the dataset's where they keep several.","type":"string"}}},"RqryColumn":{"oneOf":[{"$ref":"#/components/schemas/RqryColumnAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RqryColumnAttributes":"#/components/schemas/RqryColumnAttributes"}}},"RqryColumnAttributes":{"title":"RqryColumnAttributes","examples":[{"type":"RqryColumnAttributes","role":"Time","name":"Ada Lovelace","grain":"example","axis":"Rows"}],"type":"object","required":["type","role"],"properties":{"type":{"description":"Always `RqryColumnAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RqryColumnAttributes"]},"role":{"$ref":"#/components/schemas/RqryColumnRole"},"name":{"description":"The dimension or measure's name. Absent for the time column.","type":"string"},"grain":{"description":"For the time column, the grain it is bucketed by.","type":"string"},"axis":{"$ref":"#/components/schemas/RqryPivotAxis"}}},"RqryColumnRole":{"title":"RqryColumnRole","type":"string","enum":["Time","Dimension","Measure","Previous","Change","Target","Status","Label","RowStatus","Unknown"]},"RqryComparison":{"title":"RqryComparison","description":"Also answer for an earlier range, adding a previous column for each measure, and a change column for each but a date.","type":"string","enum":["PreviousPeriod","SamePeriodLastYear","PreviousBucket","Unknown"]},"RqryCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/RqryCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RqryCreateRspAttributes":"#/components/schemas/RqryCreateRspAttributes"}}},"RqryCreateRspAttributes":{"title":"RqryCreateRspAttributes","examples":[{"type":"RqryCreateRspAttributes","created":{"type":"RqryResultAttributes","reportDatasetId":"abc123","columns":[{"type":"RqryColumnAttributes","role":"Time","name":"Ada Lovelace","grain":"example","axis":"Rows"}],"rows":[{"type":"RqryRowAttributes","level":"Detail","depth":1250,"cells":["example"]}],"truncated":true,"next":"example","asOf":"2026-08-19T04:21:07Z","timezone":"example","labels":[{"type":"RqryLabelsAttributes","dimension":"example","values":[{"type":"RdsetValueAttributes","value":"example","label":"example"}]}],"currentAsOf":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `RqryCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RqryCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/RqryResult","description":"The resource that was created."}}},"RqryFilter":{"oneOf":[{"$ref":"#/components/schemas/RqryFilterAbove"},{"$ref":"#/components/schemas/RqryFilterAbsent"},{"$ref":"#/components/schemas/RqryFilterAtLeast"},{"$ref":"#/components/schemas/RqryFilterAtMost"},{"$ref":"#/components/schemas/RqryFilterBelow"},{"$ref":"#/components/schemas/RqryFilterBetween"},{"$ref":"#/components/schemas/RqryFilterContains"},{"$ref":"#/components/schemas/RqryFilterEquals"},{"$ref":"#/components/schemas/RqryFilterIn"},{"$ref":"#/components/schemas/RqryFilterNotEquals"},{"$ref":"#/components/schemas/RqryFilterNotIn"}],"discriminator":{"propertyName":"type","mapping":{"RqryFilterAbove":"#/components/schemas/RqryFilterAbove","RqryFilterAbsent":"#/components/schemas/RqryFilterAbsent","RqryFilterAtLeast":"#/components/schemas/RqryFilterAtLeast","RqryFilterAtMost":"#/components/schemas/RqryFilterAtMost","RqryFilterBelow":"#/components/schemas/RqryFilterBelow","RqryFilterBetween":"#/components/schemas/RqryFilterBetween","RqryFilterContains":"#/components/schemas/RqryFilterContains","RqryFilterEquals":"#/components/schemas/RqryFilterEquals","RqryFilterIn":"#/components/schemas/RqryFilterIn","RqryFilterNotEquals":"#/components/schemas/RqryFilterNotEquals","RqryFilterNotIn":"#/components/schemas/RqryFilterNotIn"}}},"RqryFilterAbove":{"title":"RqryFilterAbove","description":"Keeps every row whose value is above this one. Only a dimension whose `operators` lists `Above` takes it; a row with no value is not kept.","examples":[{"type":"RqryFilterAbove","dimension":"example","value":"example"}],"type":"object","required":["type","dimension","value"],"properties":{"type":{"description":"Always `RqryFilterAbove`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RqryFilterAbove"]},"dimension":{"type":"string"},"value":{"type":"string"}}},"RqryFilterAbsent":{"title":"RqryFilterAbsent","examples":[{"type":"RqryFilterAbsent","dimension":"example"}],"type":"object","required":["type","dimension"],"properties":{"type":{"description":"Always `RqryFilterAbsent`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RqryFilterAbsent"]},"dimension":{"type":"string"}}},"RqryFilterAtLeast":{"title":"RqryFilterAtLeast","description":"Keeps every row whose value is this one or above. Only a dimension whose `operators` lists `AtLeast` takes it; a row with no value is not kept.","examples":[{"type":"RqryFilterAtLeast","dimension":"example","value":"example"}],"type":"object","required":["type","dimension","value"],"properties":{"type":{"description":"Always `RqryFilterAtLeast`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RqryFilterAtLeast"]},"dimension":{"type":"string"},"value":{"type":"string"}}},"RqryFilterAtMost":{"title":"RqryFilterAtMost","description":"Keeps every row whose value is this one or below. Only a dimension whose `operators` lists `AtMost` takes it; a row with no value is not kept.","examples":[{"type":"RqryFilterAtMost","dimension":"example","value":"example"}],"type":"object","required":["type","dimension","value"],"properties":{"type":{"description":"Always `RqryFilterAtMost`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RqryFilterAtMost"]},"dimension":{"type":"string"},"value":{"type":"string"}}},"RqryFilterBelow":{"title":"RqryFilterBelow","description":"Keeps every row whose value is below this one. Only a dimension whose `operators` lists `Below` takes it; a row with no value is not kept.","examples":[{"type":"RqryFilterBelow","dimension":"example","value":"example"}],"type":"object","required":["type","dimension","value"],"properties":{"type":{"description":"Always `RqryFilterBelow`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RqryFilterBelow"]},"dimension":{"type":"string"},"value":{"type":"string"}}},"RqryFilterBetween":{"title":"RqryFilterBetween","description":"Both ends inclusive.","examples":[{"type":"RqryFilterBetween","dimension":"example","from":"example","to":"example"}],"type":"object","required":["type","dimension","from","to"],"properties":{"type":{"description":"Always `RqryFilterBetween`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RqryFilterBetween"]},"dimension":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"}}},"RqryFilterContains":{"title":"RqryFilterContains","description":"Keeps every row whose value holds this text, ignoring case. Only a dimension whose `matchesText` is true may be searched, and a search of a column needs a time slice to bound the rows it tests.","examples":[{"type":"RqryFilterContains","dimension":"example","text":"example"}],"type":"object","required":["type","dimension","text"],"properties":{"type":{"description":"Always `RqryFilterContains`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RqryFilterContains"]},"dimension":{"type":"string"},"text":{"type":"string"}}},"RqryFilterEquals":{"title":"RqryFilterEquals","examples":[{"type":"RqryFilterEquals","dimension":"example","value":"example"}],"type":"object","required":["type","dimension","value"],"properties":{"type":{"description":"Always `RqryFilterEquals`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RqryFilterEquals"]},"dimension":{"type":"string"},"value":{"type":"string"}}},"RqryFilterIn":{"title":"RqryFilterIn","examples":[{"type":"RqryFilterIn","dimension":"example","values":["example"]}],"type":"object","required":["type","dimension"],"properties":{"type":{"description":"Always `RqryFilterIn`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RqryFilterIn"]},"dimension":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}}},"RqryFilterNotEquals":{"title":"RqryFilterNotEquals","description":"Keeps every row whose value is not this one, including a row with no value.","examples":[{"type":"RqryFilterNotEquals","dimension":"example","value":"example"}],"type":"object","required":["type","dimension","value"],"properties":{"type":{"description":"Always `RqryFilterNotEquals`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RqryFilterNotEquals"]},"dimension":{"type":"string"},"value":{"type":"string"}}},"RqryFilterNotIn":{"title":"RqryFilterNotIn","description":"Keeps every row whose value is none of these, including a row with no value.","examples":[{"type":"RqryFilterNotIn","dimension":"example","values":["example"]}],"type":"object","required":["type","dimension"],"properties":{"type":{"description":"Always `RqryFilterNotIn`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RqryFilterNotIn"]},"dimension":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}}},"RqryLabels":{"description":"The labels of one dimension's values in an answer.","oneOf":[{"$ref":"#/components/schemas/RqryLabelsAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RqryLabelsAttributes":"#/components/schemas/RqryLabelsAttributes"}}},"RqryLabelsAttributes":{"title":"RqryLabelsAttributes","description":"The labels of one dimension's values in an answer.","examples":[{"type":"RqryLabelsAttributes","dimension":"example","values":[{"type":"RdsetValueAttributes","value":"example","label":"example"}]}],"type":"object","required":["type","dimension"],"properties":{"type":{"description":"Always `RqryLabelsAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RqryLabelsAttributes"]},"dimension":{"type":"string"},"values":{"type":"array","items":{"$ref":"#/components/schemas/RdsetValue"}}}},"RqryMeasureFilter":{"oneOf":[{"$ref":"#/components/schemas/RqryMeasureFilterAbove"},{"$ref":"#/components/schemas/RqryMeasureFilterAtLeast"},{"$ref":"#/components/schemas/RqryMeasureFilterAtMost"},{"$ref":"#/components/schemas/RqryMeasureFilterBelow"},{"$ref":"#/components/schemas/RqryMeasureFilterNotEqual"}],"discriminator":{"propertyName":"type","mapping":{"RqryMeasureFilterAbove":"#/components/schemas/RqryMeasureFilterAbove","RqryMeasureFilterAtLeast":"#/components/schemas/RqryMeasureFilterAtLeast","RqryMeasureFilterAtMost":"#/components/schemas/RqryMeasureFilterAtMost","RqryMeasureFilterBelow":"#/components/schemas/RqryMeasureFilterBelow","RqryMeasureFilterNotEqual":"#/components/schemas/RqryMeasureFilterNotEqual"}}},"RqryMeasureFilterAbove":{"title":"RqryMeasureFilterAbove","examples":[{"type":"RqryMeasureFilterAbove","measure":"example","value":"example"}],"type":"object","required":["type","measure","value"],"properties":{"type":{"description":"Always `RqryMeasureFilterAbove`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RqryMeasureFilterAbove"]},"measure":{"type":"string"},"value":{"type":"string"}}},"RqryMeasureFilterAtLeast":{"title":"RqryMeasureFilterAtLeast","examples":[{"type":"RqryMeasureFilterAtLeast","measure":"example","value":"example"}],"type":"object","required":["type","measure","value"],"properties":{"type":{"description":"Always `RqryMeasureFilterAtLeast`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RqryMeasureFilterAtLeast"]},"measure":{"type":"string"},"value":{"type":"string"}}},"RqryMeasureFilterAtMost":{"title":"RqryMeasureFilterAtMost","examples":[{"type":"RqryMeasureFilterAtMost","measure":"example","value":"example"}],"type":"object","required":["type","measure","value"],"properties":{"type":{"description":"Always `RqryMeasureFilterAtMost`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RqryMeasureFilterAtMost"]},"measure":{"type":"string"},"value":{"type":"string"}}},"RqryMeasureFilterBelow":{"title":"RqryMeasureFilterBelow","examples":[{"type":"RqryMeasureFilterBelow","measure":"example","value":"example"}],"type":"object","required":["type","measure","value"],"properties":{"type":{"description":"Always `RqryMeasureFilterBelow`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RqryMeasureFilterBelow"]},"measure":{"type":"string"},"value":{"type":"string"}}},"RqryMeasureFilterNotEqual":{"title":"RqryMeasureFilterNotEqual","examples":[{"type":"RqryMeasureFilterNotEqual","measure":"example","value":"example"}],"type":"object","required":["type","measure","value"],"properties":{"type":{"description":"Always `RqryMeasureFilterNotEqual`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RqryMeasureFilterNotEqual"]},"measure":{"type":"string"},"value":{"type":"string"}}},"RqryNarrow":{"description":"Ask as tenants beneath the caller, as a marketplace views a report as some of its merchants. Every tenant must be one the caller may read, and the answer stays within the caller's own tenants. Absent to ask as the caller.","oneOf":[{"$ref":"#/components/schemas/RqryNarrowCustomers"},{"$ref":"#/components/schemas/RqryNarrowEnterprises"},{"$ref":"#/components/schemas/RqryNarrowMarketplaces"},{"$ref":"#/components/schemas/RqryNarrowMerchants"}],"discriminator":{"propertyName":"type","mapping":{"RqryNarrowCustomers":"#/components/schemas/RqryNarrowCustomers","RqryNarrowEnterprises":"#/components/schemas/RqryNarrowEnterprises","RqryNarrowMarketplaces":"#/components/schemas/RqryNarrowMarketplaces","RqryNarrowMerchants":"#/components/schemas/RqryNarrowMerchants"}}},"RqryNarrowCustomers":{"title":"RqryNarrowCustomers","description":"Only these customers.","examples":[{"type":"RqryNarrowCustomers","customerIds":["cust_9f2Kd8QpLzXw"]}],"type":"object","required":["type","customerIds"],"properties":{"type":{"description":"Always `RqryNarrowCustomers`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RqryNarrowCustomers"]},"customerIds":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/CustId","description":"Identifier of a customer."}}}},"RqryNarrowEnterprises":{"title":"RqryNarrowEnterprises","description":"Only these enterprises.","examples":[{"type":"RqryNarrowEnterprises","enterpriseIds":["ent_9f2Kd8QpLzXw"]}],"type":"object","required":["type","enterpriseIds"],"properties":{"type":{"description":"Always `RqryNarrowEnterprises`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RqryNarrowEnterprises"]},"enterpriseIds":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/EntId","description":"Identifier of an enterprise."}}}},"RqryNarrowMarketplaces":{"title":"RqryNarrowMarketplaces","description":"Only these marketplaces.","examples":[{"type":"RqryNarrowMarketplaces","marketplaceIds":["mktp_9f2Kd8QpLzXw"]}],"type":"object","required":["type","marketplaceIds"],"properties":{"type":{"description":"Always `RqryNarrowMarketplaces`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RqryNarrowMarketplaces"]},"marketplaceIds":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/MktpId","description":"Identifier of a marketplace."}}}},"RqryNarrowMerchants":{"title":"RqryNarrowMerchants","description":"Only these merchants.","examples":[{"type":"RqryNarrowMerchants","merchantIds":["mcht_9f2Kd8QpLzXw"]}],"type":"object","required":["type","merchantIds"],"properties":{"type":{"description":"Always `RqryNarrowMerchants`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RqryNarrowMerchants"]},"merchantIds":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/MchtId","description":"Identifier of a merchant."}}}},"RqryPivot":{"description":"Lay the answer out as a grid: `rows` and `columns` each name some of `dimensions`, together each of them once. The answer stays one row per cell of the grid, each row saying its level, with a total and, with `subtotals`, a subtotal per leading row dimension. Absent for none.","oneOf":[{"$ref":"#/components/schemas/RqryPivotAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RqryPivotAttributes":"#/components/schemas/RqryPivotAttributes"}}},"RqryPivotAttributes":{"title":"RqryPivotAttributes","examples":[{"type":"RqryPivotAttributes","rows":["example"],"columns":["example"],"subtotals":true}],"type":"object","required":["type","subtotals"],"properties":{"type":{"description":"Always `RqryPivotAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RqryPivotAttributes"]},"rows":{"description":"The dimensions down the side, outermost first. The time bucket, when there is one, is always the first row key.","type":"array","items":{"type":"string"}},"columns":{"description":"The dimensions across the top. Each must have few values: together at most 50.","type":"array","items":{"type":"string"}},"subtotals":{"description":"Also answer a subtotal for each leading prefix of `rows`. The grand total is always answered.","type":"boolean"}}},"RqryPivotAxis":{"title":"RqryPivotAxis","description":"In a pivot, which side of the grid a key column lies on. Absent for a measure and outside a pivot.","type":"string","enum":["Rows","Columns","Unknown"]},"RqryRange":{"oneOf":[{"$ref":"#/components/schemas/RqryRangeBetween"},{"$ref":"#/components/schemas/RqryRangeCurrent"},{"$ref":"#/components/schemas/RqryRangeLast"},{"$ref":"#/components/schemas/RqryRangePeriod"},{"$ref":"#/components/schemas/RqryRangePrevious"}],"discriminator":{"propertyName":"type","mapping":{"RqryRangeBetween":"#/components/schemas/RqryRangeBetween","RqryRangeCurrent":"#/components/schemas/RqryRangeCurrent","RqryRangeLast":"#/components/schemas/RqryRangeLast","RqryRangePeriod":"#/components/schemas/RqryRangePeriod","RqryRangePrevious":"#/components/schemas/RqryRangePrevious"}}},"RqryRangeBetween":{"title":"RqryRangeBetween","description":"From one date to another, both inclusive, in the question's timezone.","examples":[{"type":"RqryRangeBetween","from":"2026-08-19","to":"2026-08-19"}],"type":"object","required":["type","from","to"],"properties":{"type":{"description":"Always `RqryRangeBetween`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RqryRangeBetween"]},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"}}},"RqryRangeCurrent":{"title":"RqryRangeCurrent","description":"The current period of `grain` so far.","examples":[{"type":"RqryRangeCurrent","grain":"example"}],"type":"object","required":["type","grain"],"properties":{"type":{"description":"Always `RqryRangeCurrent`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RqryRangeCurrent"]},"grain":{"type":"string"}}},"RqryRangeLast":{"title":"RqryRangeLast","description":"The last `count` whole periods of `grain` before the current one, ending where it starts.","examples":[{"type":"RqryRangeLast","count":42,"grain":"example"}],"type":"object","required":["type","count","grain"],"properties":{"type":{"description":"Always `RqryRangeLast`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RqryRangeLast"]},"count":{"type":"integer","format":"int32"},"grain":{"type":"string"}}},"RqryRangePeriod":{"title":"RqryRangePeriod","description":"From `startsAt` up to but not including `endsAt`, exactly: the first and last buckets are cut at the period's ends rather than widened to whole buckets, so a statement cycle that starts at 16:00 starts there. Buckets are still local time in the question's timezone.","examples":[{"type":"RqryRangePeriod","period":"example","startsAt":"2026-08-19T04:21:07Z","endsAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","startsAt","endsAt"],"properties":{"type":{"description":"Always `RqryRangePeriod`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RqryRangePeriod"]},"period":{"description":"A period the dataset declares in its `periods`, such as a statement cycle, or absent for bounds the caller names alone.","type":"string"},"startsAt":{"type":"string","format":"date-time"},"endsAt":{"type":"string","format":"date-time"}}},"RqryRangePrevious":{"title":"RqryRangePrevious","description":"The whole period of `grain` before the current one.","examples":[{"type":"RqryRangePrevious","grain":"example"}],"type":"object","required":["type","grain"],"properties":{"type":{"description":"Always `RqryRangePrevious`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RqryRangePrevious"]},"grain":{"type":"string"}}},"RqryResult":{"oneOf":[{"$ref":"#/components/schemas/RqryResultAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RqryResultAttributes":"#/components/schemas/RqryResultAttributes"}}},"RqryResultAttributes":{"title":"RqryResultAttributes","description":"A report's answer. Nothing is stored, so keep it.","examples":[{"type":"RqryResultAttributes","reportDatasetId":"abc123","columns":[{"type":"RqryColumnAttributes","role":"Time","name":"Ada Lovelace","grain":"example","axis":"Rows"}],"rows":[{"type":"RqryRowAttributes","level":"Detail","depth":1250,"cells":["example"]}],"truncated":true,"next":"example","asOf":"2026-08-19T04:21:07Z","timezone":"example","labels":[{"type":"RqryLabelsAttributes","dimension":"example","values":[{"type":"RdsetValueAttributes","value":"example","label":"example"}]}],"currentAsOf":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","reportDatasetId","truncated","asOf","timezone"],"properties":{"type":{"description":"Always `RqryResultAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RqryResultAttributes"]},"reportDatasetId":{"type":"string"},"columns":{"description":"One per cell of every row, in the same order.","type":"array","items":{"$ref":"#/components/schemas/RqryColumn"}},"rows":{"description":"Every cell is text or absent: a number in plain decimal, a date or instant in ISO 8601. The column says which to expect.","type":"array","items":{"$ref":"#/components/schemas/RqryRow"}},"truncated":{"description":"Whether more rows matched than were returned.","type":"boolean"},"next":{"description":"Pass as `page`, with the same question, for the rows after these: a cursor, opaque and forward only. Absent when there is no more.","type":"string"},"asOf":{"description":"The instant the answer is complete to. Earlier than now when it was served from a pre-summed table.","type":"string","format":"date-time"},"timezone":{"description":"The timezone the answer was bucketed in, an IANA name or an offset: the question's own, or the default it took.","type":"string"},"labels":{"description":"What to show a person for the values of each dimension column that has names, such as a merchant's name for its id or a day's name for its number: the labels `/report-datasets/{id}/dimension-values` gives this caller. A value absent from its list is its own label.","type":"array","items":{"$ref":"#/components/schemas/RqryLabels"}},"currentAsOf":{"description":"How current the figures are: the oldest refresh of the pre-summed tables that answered, or the time of the question where the live data answered. A pre-summed table further behind than its dataset serves (an hour unless the dataset says otherwise) never answers, so an answer older than that is out of date.","type":"string","format":"date-time"}}},"RqryRow":{"oneOf":[{"$ref":"#/components/schemas/RqryRowAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RqryRowAttributes":"#/components/schemas/RqryRowAttributes"}}},"RqryRowAttributes":{"title":"RqryRowAttributes","examples":[{"type":"RqryRowAttributes","level":"Detail","depth":1250,"cells":["example"]}],"type":"object","required":["type","level"],"properties":{"type":{"description":"Always `RqryRowAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RqryRowAttributes"]},"level":{"$ref":"#/components/schemas/RqryRowLevel"},"depth":{"description":"For a subtotal or a row total, how many of the leading row dimensions it is still grouped by.","type":"integer","format":"int32"},"cells":{"type":"array","items":{"type":"string"}}}},"RqryRowLevel":{"title":"RqryRowLevel","type":"string","enum":["Detail","Subtotal","Total","RowTotal","Others","Unknown"]},"RqrySort":{"oneOf":[{"$ref":"#/components/schemas/RqrySortDimension"},{"$ref":"#/components/schemas/RqrySortMeasure"},{"$ref":"#/components/schemas/RqrySortTime"}],"discriminator":{"propertyName":"type","mapping":{"RqrySortDimension":"#/components/schemas/RqrySortDimension","RqrySortMeasure":"#/components/schemas/RqrySortMeasure","RqrySortTime":"#/components/schemas/RqrySortTime"}}},"RqrySortDimension":{"title":"RqrySortDimension","examples":[{"type":"RqrySortDimension","dimension":"example","ascending":true}],"type":"object","required":["type","dimension","ascending"],"properties":{"type":{"description":"Always `RqrySortDimension`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RqrySortDimension"]},"dimension":{"type":"string"},"ascending":{"type":"boolean"}}},"RqrySortMeasure":{"title":"RqrySortMeasure","description":"Orders by the measure. A money measure in several currencies, the question grouping by its currency, is ordered by currency first and by amount within each currency, since amounts in different currencies are no one scale.","examples":[{"type":"RqrySortMeasure","measure":"example","ascending":true}],"type":"object","required":["type","measure","ascending"],"properties":{"type":{"description":"Always `RqrySortMeasure`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RqrySortMeasure"]},"measure":{"type":"string"},"ascending":{"type":"boolean"}}},"RqrySortTime":{"title":"RqrySortTime","examples":[{"type":"RqrySortTime","ascending":true}],"type":"object","required":["type","ascending"],"properties":{"type":{"description":"Always `RqrySortTime`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RqrySortTime"]},"ascending":{"type":"boolean"}}},"RqryTimeSlice":{"description":"Bucket by time. Absent for a total over all time.","oneOf":[{"$ref":"#/components/schemas/RqryTimeSliceAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RqryTimeSliceAttributes":"#/components/schemas/RqryTimeSliceAttributes"}}},"RqryTimeSliceAttributes":{"title":"RqryTimeSliceAttributes","examples":[{"type":"RqryTimeSliceAttributes","grain":"example","range":{"type":"RqryRangeBetween","from":"2026-08-19","to":"2026-08-19"},"compare":"PreviousPeriod"}],"type":"object","required":["type","grain","range"],"properties":{"type":{"description":"Always `RqryTimeSliceAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RqryTimeSliceAttributes"]},"grain":{"description":"A grain the dataset offers, by name.","type":"string"},"range":{"$ref":"#/components/schemas/RqryRange"},"compare":{"$ref":"#/components/schemas/RqryComparison"}}},"RqryTop":{"description":"Keep only the values of one dimension with the most of a measure, and fold the rest into an `Others` row.","oneOf":[{"$ref":"#/components/schemas/RqryTopAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RqryTopAttributes":"#/components/schemas/RqryTopAttributes"}}},"RqryTopAttributes":{"title":"RqryTopAttributes","examples":[{"type":"RqryTopAttributes","dimension":"example","count":42,"measure":"example"}],"type":"object","required":["type","dimension","count","measure"],"properties":{"type":{"description":"Always `RqryTopAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RqryTopAttributes"]},"dimension":{"description":"One of the question's `dimensions`, whose values are ranked.","type":"string"},"count":{"description":"How many values to keep, from 1 to 100, within each combination of the other dimensions.","type":"integer","format":"int32"},"measure":{"description":"One of the question's `measures`, largest first, summed over the whole range.","type":"string"}}},"Rrng":{"description":"A time range a person picks by name rather than by dates, such as `this_month`, with the range a question asks for it. Send `range` unchanged as a question's `time.range`.","oneOf":[{"$ref":"#/components/schemas/RrngAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RrngAttributes":"#/components/schemas/RrngAttributes"}}},"RrngAttributes":{"title":"RrngAttributes","description":"A time range a person picks by name rather than by dates, such as `this_month`, with the range a question asks for it. Send `range` unchanged as a question's `time.range`.","examples":[{"type":"RrngAttributes","reportRangeId":"abc123","label":"example","group":"Day","range":{"type":"RqryRangeBetween","from":"2026-08-19","to":"2026-08-19"},"maxDays":1250,"periodGrain":"example"}],"type":"object","required":["type","reportRangeId","label","group"],"properties":{"type":{"description":"Always `RrngAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RrngAttributes"]},"reportRangeId":{"description":"The range's name, which is also its id, such as `last_30_days`. It never changes, so a link or a saved filter can name it.","type":"string"},"label":{"description":"How the range reads inside a sentence, such as `the last 30 days`; a picker capitalises it.","type":"string"},"group":{"$ref":"#/components/schemas/RrngGroup"},"range":{"$ref":"#/components/schemas/RqryRange","description":"The range a question asks with it. Absent for `all_time`, which asks with no time slice."},"maxDays":{"description":"The most local days the range can span, to hold against a grain's `RdsetRuleMaxRange` before asking. Absent for `all_time`.","type":"integer","format":"int32"},"periodGrain":{"description":"The grain the range is one whole period of, such as `month` for `this_month`, so its answer can be a single figure. Absent for a range of several periods.","type":"string"}}},"RrngColumn":{"title":"RrngColumn","type":"string","enum":["ReportRangeId","Label","Group","MaxDays","PeriodGrain"]},"RrngGroup":{"title":"RrngGroup","description":"Where a picker lists it. The list is in display order, each group's ranges together.","type":"string","enum":["Day","Rolling","Calendar","AllTime","Unknown"]},"RrngPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/RrngPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RrngPageAttributes":"#/components/schemas/RrngPageAttributes"}}},"RrngPageAttributes":{"title":"RrngPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"RrngPageAttributes","data":[{"type":"RrngAttributes","reportRangeId":"abc123","label":"example","group":"Day","range":{"type":"RqryRangeBetween","from":"2026-08-19","to":"2026-08-19"},"maxDays":1250,"periodGrain":"example"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `RrngPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RrngPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/Rrng"}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"RspcAccess":{"title":"RspcAccess","type":"string","enum":["Private","Shared","System","Unknown"]},"RspcCmd":{"oneOf":[{"$ref":"#/components/schemas/RspcCmdCreate"},{"$ref":"#/components/schemas/RspcCmdDefault"}],"discriminator":{"propertyName":"type","mapping":{"RspcCmdCreate":"#/components/schemas/RspcCmdCreate","RspcCmdDefault":"#/components/schemas/RspcCmdDefault"}}},"RspcCmdCreate":{"title":"RspcCmdCreate","description":"Save a space under the caller's own tenant, owned by the caller.","examples":[{"type":"RspcCmdCreate","name":"Ada Lovelace","access":"Private","parentReportSpaceId":"rspc_9f2Kd8QpLzXw"}],"type":"object","required":["type","name","access"],"properties":{"type":{"description":"Always `RspcCmdCreate`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RspcCmdCreate"]},"name":{"type":"string"},"access":{"$ref":"#/components/schemas/RspcAccess","description":"`Private` for the caller alone, or `Shared` for its tenant, which needs `Reports_Manage`."},"parentReportSpaceId":{"$ref":"#/components/schemas/RspcId","description":"The space to put it in, which must be the caller's to change and of the same access. Absent for the top."}}},"RspcCmdDefault":{"title":"RspcCmdDefault","description":"Return the caller's default space, making it the first time it is asked for: the one to save into when no space is chosen. Asking again returns the same space, so a client never makes a second `My reports`.","examples":[{"type":"RspcCmdDefault"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `RspcCmdDefault`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RspcCmdDefault"]}}},"RspcColumn":{"title":"RspcColumn","type":"string","enum":["ReportSpaceId","Name","Access","ParentReportSpaceId","OwnedByCaller","Editable","IsDefault","CreatedAt","UpdatedAt","Icon"]},"RspcCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/RspcCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RspcCreateRspAttributes":"#/components/schemas/RspcCreateRspAttributes"}}},"RspcCreateRspAttributes":{"title":"RspcCreateRspAttributes","examples":[{"type":"RspcCreateRspAttributes","created":{"type":"RspcViewAttributes","reportSpaceId":"rspc_9f2Kd8QpLzXw","name":"Ada Lovelace","access":"Private","parentReportSpaceId":"rspc_9f2Kd8QpLzXw","tenant":{"type":"RspcTenantEnterprise","enterpriseId":"ent_9f2Kd8QpLzXw"},"ownedByCaller":true,"editable":true,"isDefault":true,"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z","icon":"example"}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `RspcCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RspcCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/RspcView","description":"The resource that was created."}}},"RspcId":{"title":"RspcId","examples":["rspc_9f2Kd8QpLzXw"],"type":"string"},"RspcPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/RspcPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RspcPageAttributes":"#/components/schemas/RspcPageAttributes"}}},"RspcPageAttributes":{"title":"RspcPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"RspcPageAttributes","data":[{"type":"RspcViewAttributes","reportSpaceId":"rspc_9f2Kd8QpLzXw","name":"Ada Lovelace","access":"Private","parentReportSpaceId":"rspc_9f2Kd8QpLzXw","tenant":{"type":"RspcTenantEnterprise","enterpriseId":"ent_9f2Kd8QpLzXw"},"ownedByCaller":true,"editable":true,"isDefault":true,"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z","icon":"example"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `RspcPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RspcPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/RspcView","description":"A folder of saved charts, dashboards and notebooks. Everything in it is seen by whoever sees the space."}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"RspcTenant":{"oneOf":[{"$ref":"#/components/schemas/RspcTenantEnterprise"},{"$ref":"#/components/schemas/RspcTenantMarketplace"},{"$ref":"#/components/schemas/RspcTenantMerchant"},{"$ref":"#/components/schemas/RspcTenantPlatform"}],"discriminator":{"propertyName":"type","mapping":{"RspcTenantEnterprise":"#/components/schemas/RspcTenantEnterprise","RspcTenantMarketplace":"#/components/schemas/RspcTenantMarketplace","RspcTenantMerchant":"#/components/schemas/RspcTenantMerchant","RspcTenantPlatform":"#/components/schemas/RspcTenantPlatform"}}},"RspcTenantEnterprise":{"title":"RspcTenantEnterprise","description":"The tenant an item was saved under: the platform, or the enterprise, marketplace or merchant its saver signed in as.","examples":[{"type":"RspcTenantEnterprise","enterpriseId":"ent_9f2Kd8QpLzXw"}],"type":"object","required":["type","enterpriseId"],"properties":{"type":{"description":"Always `RspcTenantEnterprise`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RspcTenantEnterprise"]},"enterpriseId":{"$ref":"#/components/schemas/EntId","description":"Identifier of an enterprise."}}},"RspcTenantMarketplace":{"title":"RspcTenantMarketplace","description":"The tenant an item was saved under: the platform, or the enterprise, marketplace or merchant its saver signed in as.","examples":[{"type":"RspcTenantMarketplace","marketplaceId":"mktp_9f2Kd8QpLzXw"}],"type":"object","required":["type","marketplaceId"],"properties":{"type":{"description":"Always `RspcTenantMarketplace`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RspcTenantMarketplace"]},"marketplaceId":{"$ref":"#/components/schemas/MktpId","description":"Identifier of a marketplace."}}},"RspcTenantMerchant":{"title":"RspcTenantMerchant","description":"The tenant an item was saved under: the platform, or the enterprise, marketplace or merchant its saver signed in as.","examples":[{"type":"RspcTenantMerchant","merchantId":"mcht_9f2Kd8QpLzXw"}],"type":"object","required":["type","merchantId"],"properties":{"type":{"description":"Always `RspcTenantMerchant`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RspcTenantMerchant"]},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"Identifier of a merchant."}}},"RspcTenantPlatform":{"title":"RspcTenantPlatform","description":"The platform, which no enterprise, marketplace or merchant bounds.","examples":[{"type":"RspcTenantPlatform"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `RspcTenantPlatform`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RspcTenantPlatform"]}}},"RspcUpdate":{"oneOf":[{"$ref":"#/components/schemas/RspcUpdateMove"},{"$ref":"#/components/schemas/RspcUpdateMoveToTop"},{"$ref":"#/components/schemas/RspcUpdateRename"},{"$ref":"#/components/schemas/RspcUpdateShare"}],"discriminator":{"propertyName":"type","mapping":{"RspcUpdateMove":"#/components/schemas/RspcUpdateMove","RspcUpdateMoveToTop":"#/components/schemas/RspcUpdateMoveToTop","RspcUpdateRename":"#/components/schemas/RspcUpdateRename","RspcUpdateShare":"#/components/schemas/RspcUpdateShare"}}},"RspcUpdateMove":{"title":"RspcUpdateMove","description":"Put the space in another of the same tenant and access. It cannot be put inside itself.","examples":[{"type":"RspcUpdateMove","parentReportSpaceId":"rspc_9f2Kd8QpLzXw"}],"type":"object","required":["type","parentReportSpaceId"],"properties":{"type":{"description":"Always `RspcUpdateMove`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RspcUpdateMove"]},"parentReportSpaceId":{"$ref":"#/components/schemas/RspcId","description":"Identifier of a report space."}}},"RspcUpdateMoveToTop":{"title":"RspcUpdateMoveToTop","description":"Put the space at the top, in no other.","examples":[{"type":"RspcUpdateMoveToTop"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `RspcUpdateMoveToTop`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RspcUpdateMoveToTop"]}}},"RspcUpdateRename":{"title":"RspcUpdateRename","description":"Give the space a new name. The System space keeps its own.","examples":[{"type":"RspcUpdateRename","name":"Ada Lovelace"}],"type":"object","required":["type","name"],"properties":{"type":{"description":"Always `RspcUpdateRename`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RspcUpdateRename"]},"name":{"type":"string"}}},"RspcUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/RspcUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RspcUpdateRspAttributes":"#/components/schemas/RspcUpdateRspAttributes"}}},"RspcUpdateRspAttributes":{"title":"RspcUpdateRspAttributes","examples":[{"type":"RspcUpdateRspAttributes","updated":{"type":"RspcViewAttributes","reportSpaceId":"rspc_9f2Kd8QpLzXw","name":"Ada Lovelace","access":"Private","parentReportSpaceId":"rspc_9f2Kd8QpLzXw","tenant":{"type":"RspcTenantEnterprise","enterpriseId":"ent_9f2Kd8QpLzXw"},"ownedByCaller":true,"editable":true,"isDefault":true,"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z","icon":"example"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `RspcUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RspcUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/RspcView","description":"The resource as it stands after the change."}}},"RspcUpdateShare":{"title":"RspcUpdateShare","description":"Share a private space at the top, and every space in it, with the tenant it was saved under, which needs `Reports_Manage`. Everyone in that tenant sees what it holds from then on, and changing it needs `Reports_Manage`. The default space stays private, and a space is refused while a dashboard in it shows a chart from a private space outside it.","examples":[{"type":"RspcUpdateShare"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `RspcUpdateShare`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RspcUpdateShare"]}}},"RspcView":{"oneOf":[{"$ref":"#/components/schemas/RspcViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"RspcViewAttributes":"#/components/schemas/RspcViewAttributes"}}},"RspcViewAttributes":{"title":"RspcViewAttributes","description":"A folder of saved charts, dashboards and notebooks. Everything in it is seen by whoever sees the space.","examples":[{"type":"RspcViewAttributes","reportSpaceId":"rspc_9f2Kd8QpLzXw","name":"Ada Lovelace","access":"Private","parentReportSpaceId":"rspc_9f2Kd8QpLzXw","tenant":{"type":"RspcTenantEnterprise","enterpriseId":"ent_9f2Kd8QpLzXw"},"ownedByCaller":true,"editable":true,"isDefault":true,"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z","icon":"example"}],"type":"object","required":["type","reportSpaceId","name","access","tenant","ownedByCaller","editable","isDefault","createdAt","updatedAt"],"properties":{"type":{"description":"Always `RspcViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["RspcViewAttributes"]},"reportSpaceId":{"$ref":"#/components/schemas/RspcId","description":"Identifier of a report space."},"name":{"type":"string"},"access":{"$ref":"#/components/schemas/RspcAccess"},"parentReportSpaceId":{"$ref":"#/components/schemas/RspcId","description":"The space this one sits in, of the same tenant and access. Absent at the top."},"tenant":{"$ref":"#/components/schemas/RspcTenant"},"ownedByCaller":{"description":"Whether the caller saved it.","type":"boolean"},"editable":{"description":"Whether the caller may rename, move or delete it, and save or change what it holds.","type":"boolean"},"isDefault":{"description":"Whether it is its owner's default space, `My reports` until renamed: private, at the top, one per person per tenant. `RspcCmdDefault` finds it, and a private space deleted at the top hands what it held to it.","type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"icon":{"description":"The picture a client shows beside a System section's heading: `acquiring`, `lending` or `platform`. Absent for any other space.","type":"string"}}},"SdbiId":{"title":"SdbiId","description":"Identifier of the corrections staged for a loan statement, which is the statement's own identifier.","examples":["lstmt_9f2Kd8QpLzXw"],"type":"string"},"SdbiItem":{"description":"The references staged for one of the statement's transactions.","oneOf":[{"$ref":"#/components/schemas/SdbiItemAttributes"}],"discriminator":{"propertyName":"type","mapping":{"SdbiItemAttributes":"#/components/schemas/SdbiItemAttributes"}}},"SdbiItemAttributes":{"title":"SdbiItemAttributes","description":"The references staged for one of the statement's transactions.","examples":[{"type":"SdbiItemAttributes","issuerTransactionId":"itxn_9f2Kd8QpLzXw","references":{"type":"SdbiReferencesAttributes","pk":"example","ds":"example","ks":"example","ae":"example","ik":"example","bd":"example","pr":"example","au":"example","ak":"example","rz":"example"},"travellerName":"Ada Lovelace","travelAgencyInvoiceNumber":"example"}],"type":"object","required":["type","issuerTransactionId","references"],"properties":{"type":{"description":"Always `SdbiItemAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SdbiItemAttributes"]},"issuerTransactionId":{"$ref":"#/components/schemas/ItxnId","description":"The statement's transaction. Read it at `/issuer-transactions/{issuerTransactionId}`."},"references":{"$ref":"#/components/schemas/SdbiReferences"},"travellerName":{"type":"string"},"travelAgencyInvoiceNumber":{"type":"string"}}},"SdbiReferences":{"description":"The ten data-based invoicing references of a transaction. A reference left out is a reference left blank.","oneOf":[{"$ref":"#/components/schemas/SdbiReferencesAttributes"}],"discriminator":{"propertyName":"type","mapping":{"SdbiReferencesAttributes":"#/components/schemas/SdbiReferencesAttributes"}}},"SdbiReferencesAttributes":{"title":"SdbiReferencesAttributes","description":"The ten data-based invoicing references of a transaction. A reference left out is a reference left blank.","examples":[{"type":"SdbiReferencesAttributes","pk":"example","ds":"example","ks":"example","ae":"example","ik":"example","bd":"example","pr":"example","au":"example","ak":"example","rz":"example"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `SdbiReferencesAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SdbiReferencesAttributes"]},"pk":{"type":"string"},"ds":{"type":"string"},"ks":{"type":"string"},"ae":{"type":"string"},"ik":{"type":"string"},"bd":{"description":"As the file writes it, `20260331`, or as a date, `2026-03-31`.","type":"string"},"pr":{"type":"string"},"au":{"type":"string"},"ak":{"type":"string"},"rz":{"type":"string"}}},"SdbiReplace":{"description":"Stage the references of the statement's transactions, replacing anything already staged. Answers with the batch as staged.","oneOf":[{"$ref":"#/components/schemas/SdbiReplaceAttributes"}],"discriminator":{"propertyName":"type","mapping":{"SdbiReplaceAttributes":"#/components/schemas/SdbiReplaceAttributes"}}},"SdbiReplaceAttributes":{"title":"SdbiReplaceAttributes","description":"Stage the references of the statement's transactions, replacing anything already staged. Answers with the batch as staged.","examples":[{"type":"SdbiReplaceAttributes","items":[{"type":"SdbiItemAttributes","issuerTransactionId":"itxn_9f2Kd8QpLzXw","references":{"type":"SdbiReferencesAttributes","pk":"example","ds":"example","ks":"example","ae":"example","ik":"example","bd":"example","pr":"example","au":"example","ak":"example","rz":"example"},"travellerName":"Ada Lovelace","travelAgencyInvoiceNumber":"example"}]}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `SdbiReplaceAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SdbiReplaceAttributes"]},"items":{"type":"array","items":{"$ref":"#/components/schemas/SdbiItem"}}}},"SdbiUpdate":{"oneOf":[{"$ref":"#/components/schemas/SdbiUpdateAdd"},{"$ref":"#/components/schemas/SdbiUpdateApply"}],"discriminator":{"propertyName":"type","mapping":{"SdbiUpdateAdd":"#/components/schemas/SdbiUpdateAdd","SdbiUpdateApply":"#/components/schemas/SdbiUpdateApply"}}},"SdbiUpdateAdd":{"title":"SdbiUpdateAdd","description":"Add to what is staged: a transaction already staged takes the new references, and the others stay. A single-transaction edit is one item. A transaction that is not the statement's is refused.","examples":[{"type":"SdbiUpdateAdd","items":[{"type":"SdbiItemAttributes","issuerTransactionId":"itxn_9f2Kd8QpLzXw","references":{"type":"SdbiReferencesAttributes","pk":"example","ds":"example","ks":"example","ae":"example","ik":"example","bd":"example","pr":"example","au":"example","ak":"example","rz":"example"},"travellerName":"Ada Lovelace","travelAgencyInvoiceNumber":"example"}]}],"type":"object","required":["type","items"],"properties":{"type":{"description":"Always `SdbiUpdateAdd`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SdbiUpdateAdd"]},"items":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/SdbiItem"}}}},"SdbiUpdateApply":{"title":"SdbiUpdateApply","description":"Apply the staged references to the statement's transactions, take the batch off the stage and have the statement's documents made again. Answers with the batch as it now stands, which is empty.","examples":[{"type":"SdbiUpdateApply"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `SdbiUpdateApply`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SdbiUpdateApply"]}}},"SdbiUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/SdbiUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"SdbiUpdateRspAttributes":"#/components/schemas/SdbiUpdateRspAttributes"}}},"SdbiUpdateRspAttributes":{"title":"SdbiUpdateRspAttributes","examples":[{"type":"SdbiUpdateRspAttributes","updated":{"type":"SdbiViewAttributes","statementDbiBatchId":"lstmt_9f2Kd8QpLzXw","items":[{"type":"SdbiItemAttributes","issuerTransactionId":"itxn_9f2Kd8QpLzXw","references":{"type":"SdbiReferencesAttributes","pk":"example","ds":"example","ks":"example","ae":"example","ik":"example","bd":"example","pr":"example","au":"example","ak":"example","rz":"example"},"travellerName":"Ada Lovelace","travelAgencyInvoiceNumber":"example"}],"stagedAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `SdbiUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SdbiUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/SdbiView","description":"The resource as it stands after the change."}}},"SdbiView":{"oneOf":[{"$ref":"#/components/schemas/SdbiViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"SdbiViewAttributes":"#/components/schemas/SdbiViewAttributes"}}},"SdbiViewAttributes":{"title":"SdbiViewAttributes","description":"The corrections staged against a statement's transactions, until they are applied and the statement's documents are made again. A statement with nothing staged reads as an empty batch.","examples":[{"type":"SdbiViewAttributes","statementDbiBatchId":"lstmt_9f2Kd8QpLzXw","items":[{"type":"SdbiItemAttributes","issuerTransactionId":"itxn_9f2Kd8QpLzXw","references":{"type":"SdbiReferencesAttributes","pk":"example","ds":"example","ks":"example","ae":"example","ik":"example","bd":"example","pr":"example","au":"example","ak":"example","rz":"example"},"travellerName":"Ada Lovelace","travelAgencyInvoiceNumber":"example"}],"stagedAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","statementDbiBatchId"],"properties":{"type":{"description":"Always `SdbiViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SdbiViewAttributes"]},"statementDbiBatchId":{"$ref":"#/components/schemas/SdbiId"},"items":{"type":"array","items":{"$ref":"#/components/schemas/SdbiItem"}},"stagedAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"SdocDelivery":{"oneOf":[{"$ref":"#/components/schemas/SdocDeliveryAttributes"}],"discriminator":{"propertyName":"type","mapping":{"SdocDeliveryAttributes":"#/components/schemas/SdocDeliveryAttributes"}}},"SdocDeliveryAttributes":{"title":"SdocDeliveryAttributes","description":"Where one e-mail about a document got to.","examples":[{"type":"SdocDeliveryAttributes","status":"Pending","attempts":1250,"sentAt":"2026-08-19T04:21:07Z","error":"example"}],"type":"object","required":["type","status","attempts"],"properties":{"type":{"description":"Always `SdocDeliveryAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SdocDeliveryAttributes"]},"status":{"$ref":"#/components/schemas/SdocDeliveryStatus"},"attempts":{"type":"integer","format":"int32"},"sentAt":{"type":"string","format":"date-time"},"error":{"type":"string"}}},"SdocDeliveryStatus":{"title":"SdocDeliveryStatus","type":"string","enum":["Pending","Sent","Failed","Skipped","Unknown"]},"SdocFormat":{"title":"SdocFormat","type":"string","enum":["Csv","Pdf","Xml","Cdf3","DailyFlex","Unknown"]},"SdocId":{"title":"SdocId","description":"Identifier of a statement document.","examples":["sdoc_9f2Kd8QpLzXw"],"type":"string"},"SdocOrigin":{"title":"SdocOrigin","type":"string","enum":["Generated","ImportedFromApg","Unknown"]},"SdocStatus":{"title":"SdocStatus","type":"string","enum":["Pending","Generating","Generated","Failed","Archived","Destroyed","NotRequired","Unknown"]},"SdocView":{"description":"One document made for a statement, and where it got to. Read the file itself at the statement's `documents/{format}`; the bucket the platform stores it in is not published.","oneOf":[{"$ref":"#/components/schemas/SdocViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"SdocViewAttributes":"#/components/schemas/SdocViewAttributes"}}},"SdocViewAttributes":{"title":"SdocViewAttributes","description":"One document made for a statement, and where it got to. Read the file itself at the statement's `documents/{format}`; the bucket the platform stores it in is not published.","examples":[{"type":"SdocViewAttributes","statementDocumentId":"sdoc_9f2Kd8QpLzXw","format":"Csv","status":"Pending","fileName":"Ada Lovelace","sizeBytes":1250,"expiresAt":"2026-08-19T04:21:07Z","errorMessage":"example","attempts":1250,"email":{"type":"SdocDeliveryAttributes","status":"Pending","attempts":1250,"sentAt":"2026-08-19T04:21:07Z","error":"example"},"readyNotice":{"type":"SdocDeliveryAttributes","status":"Pending","attempts":1250,"sentAt":"2026-08-19T04:21:07Z","error":"example"},"origin":"Generated","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","statementDocumentId","format","status","attempts","origin","createdAt","updatedAt"],"properties":{"type":{"description":"Always `SdocViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SdocViewAttributes"]},"statementDocumentId":{"$ref":"#/components/schemas/SdocId"},"format":{"$ref":"#/components/schemas/SdocFormat"},"status":{"$ref":"#/components/schemas/SdocStatus"},"fileName":{"description":"The name the document is delivered under. Absent until it has been packaged.","type":"string"},"sizeBytes":{"description":"The length in bytes of the encrypted zip the document is delivered in, which is what APG records.","type":"integer","format":"int64"},"expiresAt":{"type":"string","format":"date-time"},"errorMessage":{"type":"string"},"attempts":{"description":"How many times the sweep has taken the document.","type":"integer","format":"int32"},"email":{"$ref":"#/components/schemas/SdocDelivery","description":"The statement mail carrying this document. Absent means the document is not e-mailed."},"readyNotice":{"$ref":"#/components/schemas/SdocDelivery","description":"The statement's one \"ready to download\" notice, tracked on each of its documents. Absent means none is owed."},"origin":{"$ref":"#/components/schemas/SdocOrigin"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"SessBuiltInMethod":{"title":"SessBuiltInMethod","type":"string","enum":["Password","EmailLink","Otp","Unknown"]},"SessCapability":{"description":"An action the holder of this session may take on a resource.","oneOf":[{"$ref":"#/components/schemas/SessCapabilityAttributes"}],"discriminator":{"propertyName":"type","mapping":{"SessCapabilityAttributes":"#/components/schemas/SessCapabilityAttributes"}}},"SessCapabilityAttributes":{"title":"SessCapabilityAttributes","description":"An action the holder of this session may take on a resource.","examples":[{"type":"SessCapabilityAttributes","resource":"BlockedCard","actions":["Create"]}],"type":"object","required":["type","resource"],"properties":{"type":{"description":"Always `SessCapabilityAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessCapabilityAttributes"]},"resource":{"$ref":"#/components/schemas/PermissionResource","description":"The resource these capabilities are over."},"actions":{"description":"The actions the session holder may take on the resource.","type":"array","items":{"$ref":"#/components/schemas/PermissionAction"}}}},"SessCmd":{"oneOf":[{"$ref":"#/components/schemas/SessCmdChangePassword"},{"$ref":"#/components/schemas/SessCmdDiscover"},{"$ref":"#/components/schemas/SessCmdSendCustomerOtp"},{"$ref":"#/components/schemas/SessCmdSendEmailLink"},{"$ref":"#/components/schemas/SessCmdSendOtp"},{"$ref":"#/components/schemas/SessCmdSendPasswordReset"},{"$ref":"#/components/schemas/SessCmdSignInCustomer"},{"$ref":"#/components/schemas/SessCmdSignInCustomerOtp"},{"$ref":"#/components/schemas/SessCmdSignInEmailLink"},{"$ref":"#/components/schemas/SessCmdSignInFederated"},{"$ref":"#/components/schemas/SessCmdSignInOtp"},{"$ref":"#/components/schemas/SessCmdSignInPassword"},{"$ref":"#/components/schemas/SessCmdSignInPasswordReset"},{"$ref":"#/components/schemas/SessCmdStartFederated"}],"discriminator":{"propertyName":"type","mapping":{"SessCmdChangePassword":"#/components/schemas/SessCmdChangePassword","SessCmdDiscover":"#/components/schemas/SessCmdDiscover","SessCmdSendCustomerOtp":"#/components/schemas/SessCmdSendCustomerOtp","SessCmdSendEmailLink":"#/components/schemas/SessCmdSendEmailLink","SessCmdSendOtp":"#/components/schemas/SessCmdSendOtp","SessCmdSendPasswordReset":"#/components/schemas/SessCmdSendPasswordReset","SessCmdSignInCustomer":"#/components/schemas/SessCmdSignInCustomer","SessCmdSignInCustomerOtp":"#/components/schemas/SessCmdSignInCustomerOtp","SessCmdSignInEmailLink":"#/components/schemas/SessCmdSignInEmailLink","SessCmdSignInFederated":"#/components/schemas/SessCmdSignInFederated","SessCmdSignInOtp":"#/components/schemas/SessCmdSignInOtp","SessCmdSignInPassword":"#/components/schemas/SessCmdSignInPassword","SessCmdSignInPasswordReset":"#/components/schemas/SessCmdSignInPasswordReset","SessCmdStartFederated":"#/components/schemas/SessCmdStartFederated"}}},"SessCmdChangePassword":{"title":"SessCmdChangePassword","description":"Change your own password. The current one is the proof it is you; the new one takes effect immediately.","examples":[{"type":"SessCmdChangePassword","currentPassword":"example","newPassword":"example"}],"type":"object","required":["type","currentPassword","newPassword"],"properties":{"type":{"description":"Always `SessCmdChangePassword`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessCmdChangePassword"]},"currentPassword":{"type":"string"},"newPassword":{"type":"string"}}},"SessCmdDiscover":{"title":"SessCmdDiscover","description":"Ask how a given identifier should authenticate, before offering a form. Answers `SessViewMethod`.","examples":[{"type":"SessCmdDiscover","identifier":{"type":"SessIdEmail","emailAddress":"ada@example.com"},"scopes":[{"type":"SessScopeCustomer","refId":"abc123"}]}],"type":"object","required":["type","identifier"],"properties":{"type":{"description":"Always `SessCmdDiscover`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessCmdDiscover"]},"identifier":{"$ref":"#/components/schemas/SessIdentifier"},"scopes":{"description":"Restrict which of the user's permission domains the method is resolved from, so it matches the domain the session will start in. An empty list applies no restriction and the highest-precedence session-capable domain wins.","type":"array","items":{"$ref":"#/components/schemas/SessScope"}}}},"SessCmdSendCustomerOtp":{"title":"SessCmdSendCustomerOtp","description":"Send a customer one-time codes so they can sign in. Answers `SessViewCustomerOtpSent`.","examples":[{"type":"SessCmdSendCustomerOtp","subject":{"type":"SessCustomerOtpConsumer","emailAddress":"ada@example.com"}}],"type":"object","required":["type","subject"],"properties":{"type":{"description":"Always `SessCmdSendCustomerOtp`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessCmdSendCustomerOtp"]},"subject":{"$ref":"#/components/schemas/SessCustomerOtp"}}},"SessCmdSendEmailLink":{"title":"SessCmdSendEmailLink","description":"Send a sign-in link to an email address. Answers `SessViewLinkSent`, always, even for an unknown address.","examples":[{"type":"SessCmdSendEmailLink","emailAddress":"ada@example.com","selectedDomainHandle":"example"}],"type":"object","required":["type","emailAddress"],"properties":{"type":{"description":"Always `SessCmdSendEmailLink`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessCmdSendEmailLink"]},"emailAddress":{"type":"string"},"selectedDomainHandle":{"description":"The handle `SessViewMethod` returned, unchanged. Omit to start in the user's highest-precedence session-capable domain.","type":"string"}}},"SessCmdSendOtp":{"title":"SessCmdSendOtp","description":"Send a one-time code to the identifier's registered contact. Answers `SessViewOtpSent`.","examples":[{"type":"SessCmdSendOtp","identifier":{"type":"SessIdEmail","emailAddress":"ada@example.com"},"channel":"Email","selectedDomainHandle":"example"}],"type":"object","required":["type","identifier"],"properties":{"type":{"description":"Always `SessCmdSendOtp`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessCmdSendOtp"]},"identifier":{"$ref":"#/components/schemas/SessIdentifier"},"channel":{"$ref":"#/components/schemas/SessOtpChannel","description":"Where to send it. Omit to let the platform choose, email where the user has an address, otherwise phone."},"selectedDomainHandle":{"description":"The handle `SessViewMethod` returned, unchanged. Omit to start in the user's highest-precedence session-capable domain.","type":"string"}}},"SessCmdSendPasswordReset":{"title":"SessCmdSendPasswordReset","description":"Send a set-or-reset-password link. Answers `SessViewLinkSent`, always, even for an unknown address.","examples":[{"type":"SessCmdSendPasswordReset","emailAddress":"ada@example.com"}],"type":"object","required":["type","emailAddress"],"properties":{"type":{"description":"Always `SessCmdSendPasswordReset`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessCmdSendPasswordReset"]},"emailAddress":{"type":"string"}}},"SessCmdSignInCustomer":{"title":"SessCmdSignInCustomer","description":"Sign in on behalf of a customer, from your backend. Answers `SessViewIssued`, a session in the customer's or delegate's domain.","examples":[{"type":"SessCmdSignInCustomer","subject":{"type":"SessCustomerConsumer","customerId":"cust_9f2Kd8QpLzXw"}}],"type":"object","required":["type","subject"],"properties":{"type":{"description":"Always `SessCmdSignInCustomer`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessCmdSignInCustomer"]},"subject":{"$ref":"#/components/schemas/SessCustomer"}}},"SessCmdSignInCustomerOtp":{"title":"SessCmdSignInCustomerOtp","description":"Submit a customer's one-time codes. Answers `SessViewIssued`, `SessViewProspect` for a new B2B prospect, or `SessViewContactVerified` for a contact verification.","examples":[{"type":"SessCmdSignInCustomerOtp","answer":{"type":"SessCustomerCodeConsumer","emailAddress":"ada@example.com","emailVerificationCode":"ada@example.com","phoneVerificationCode":"+61400000000"}}],"type":"object","required":["type","answer"],"properties":{"type":{"description":"Always `SessCmdSignInCustomerOtp`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessCmdSignInCustomerOtp"]},"answer":{"$ref":"#/components/schemas/SessCustomerCode"}}},"SessCmdSignInEmailLink":{"title":"SessCmdSignInEmailLink","description":"Complete a sign-in from the emailed link. Answers `SessViewIssued`.","examples":[{"type":"SessCmdSignInEmailLink","emailAddress":"ada@example.com","oobCode":"example","selectedDomainHandle":"example","sessionToken":"tok_9f2Kd8QpLzXwR4mN"}],"type":"object","required":["type","emailAddress","oobCode"],"properties":{"type":{"description":"Always `SessCmdSignInEmailLink`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessCmdSignInEmailLink"]},"emailAddress":{"description":"The address the link was sent to. Re-entered when completing on another device.","type":"string"},"oobCode":{"description":"The one-time code carried in the link.","type":"string"},"selectedDomainHandle":{"description":"The handle `SessViewMethod` returned, if this device has it. Re-run discovery rather than guessing.","type":"string"},"sessionToken":{"description":"Your current bearer, when this sign-in answers a `SessViewReauthenticationRequired`.","type":"string"}}},"SessCmdSignInFederated":{"title":"SessCmdSignInFederated","description":"Complete a sign-in after the identity provider redirected back. Answers `SessViewIssued`.","examples":[{"type":"SessCmdSignInFederated","state":"example","callbackUri":"https://example.com/callback","sessionToken":"tok_9f2Kd8QpLzXwR4mN"}],"type":"object","required":["type","state","callbackUri"],"properties":{"type":{"description":"Always `SessCmdSignInFederated`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessCmdSignInFederated"]},"state":{"description":"The `state` query parameter the provider echoed back.","type":"string"},"callbackUri":{"description":"The full callback URL the provider redirected to, including its query string.","type":"string"},"sessionToken":{"description":"Your current bearer, when this sign-in answers a `SessViewReauthenticationRequired`.","type":"string"}}},"SessCmdSignInOtp":{"title":"SessCmdSignInOtp","description":"Submit the one-time code against the challenge. Answers `SessViewIssued`.","examples":[{"type":"SessCmdSignInOtp","challengeId":"lotp_9f2Kd8QpLzXw","code":"example","selectedDomainHandle":"example","sessionToken":"tok_9f2Kd8QpLzXwR4mN"}],"type":"object","required":["type","challengeId","code"],"properties":{"type":{"description":"Always `SessCmdSignInOtp`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessCmdSignInOtp"]},"challengeId":{"$ref":"#/components/schemas/SessOtpChallengeId","description":"The `challengeId` from `SessViewOtpSent`."},"code":{"description":"The code the user received.","type":"string"},"selectedDomainHandle":{"description":"The handle `SessViewMethod` returned, unchanged. Omit to start in the user's highest-precedence session-capable domain.","type":"string"},"sessionToken":{"description":"Your current bearer, when this sign-in answers a `SessViewReauthenticationRequired`.","type":"string"}}},"SessCmdSignInPassword":{"title":"SessCmdSignInPassword","description":"Sign in with a password. Answers `SessViewIssued`.","examples":[{"type":"SessCmdSignInPassword","identifier":{"type":"SessIdEmail","emailAddress":"ada@example.com"},"password":"example","selectedDomainHandle":"example","sessionToken":"tok_9f2Kd8QpLzXwR4mN"}],"type":"object","required":["type","identifier","password"],"properties":{"type":{"description":"Always `SessCmdSignInPassword`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessCmdSignInPassword"]},"identifier":{"$ref":"#/components/schemas/SessIdentifier"},"password":{"type":"string"},"selectedDomainHandle":{"description":"The handle `SessViewMethod` returned, unchanged. Omit to start in the user's highest-precedence session-capable domain.","type":"string"},"sessionToken":{"description":"Your current bearer, when this sign-in answers a `SessViewReauthenticationRequired`. The new session then carries both methods.","type":"string"}}},"SessCmdSignInPasswordReset":{"title":"SessCmdSignInPasswordReset","description":"Set a new password using the code from the link, and sign in. Answers `SessViewIssued`.","examples":[{"type":"SessCmdSignInPasswordReset","oobCode":"example","newPassword":"example"}],"type":"object","required":["type","oobCode","newPassword"],"properties":{"type":{"description":"Always `SessCmdSignInPasswordReset`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessCmdSignInPasswordReset"]},"oobCode":{"description":"The one-time code carried in the set-or-reset-password link.","type":"string"},"newPassword":{"type":"string"}}},"SessCmdStartFederated":{"title":"SessCmdStartFederated","description":"Begin a sign-in at the user's external identity provider. Answers `SessViewRedirect`.","examples":[{"type":"SessCmdStartFederated","selectedDomainHandle":"example"}],"type":"object","required":["type","selectedDomainHandle"],"properties":{"type":{"description":"Always `SessCmdStartFederated`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessCmdStartFederated"]},"selectedDomainHandle":{"description":"The handle `SessViewMethod` returned. Required, it names both the user and the domain, and the domain names the provider.","type":"string"}}},"SessColumn":{"title":"SessColumn","type":"string"},"SessCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/SessCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"SessCreateRspAttributes":"#/components/schemas/SessCreateRspAttributes"}}},"SessCreateRspAttributes":{"title":"SessCreateRspAttributes","examples":[{"type":"SessCreateRspAttributes","created":{"type":"SessViewAuthenticated","userId":"user_9f2Kd8QpLzXw","displayName":"Ada Lovelace","activeDomain":{"type":"SessDomainAttributes","domain":{"type":"UserDomainAnonymous","restrictedTo":{"type":"UserDomainCustomer","customerId":"cust_9f2Kd8QpLzXw"}},"description":"A short description."},"roleIds":["role_9f2Kd8QpLzXw"],"capabilities":[{"type":"SessCapabilityAttributes","resource":"BlockedCard","actions":["Create"]}],"rbacHash":"example","directDebitAccountKinds":["Au"],"expiresAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `SessCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/SessView","description":"The resource that was created."}}},"SessCustomer":{"oneOf":[{"$ref":"#/components/schemas/SessCustomerConsumer"},{"$ref":"#/components/schemas/SessCustomerDelegate"},{"$ref":"#/components/schemas/SessCustomerDelegateByReference"}],"discriminator":{"propertyName":"type","mapping":{"SessCustomerConsumer":"#/components/schemas/SessCustomerConsumer","SessCustomerDelegate":"#/components/schemas/SessCustomerDelegate","SessCustomerDelegateByReference":"#/components/schemas/SessCustomerDelegateByReference"}}},"SessCustomerCode":{"oneOf":[{"$ref":"#/components/schemas/SessCustomerCodeConsumer"},{"$ref":"#/components/schemas/SessCustomerCodeContactVerification"},{"$ref":"#/components/schemas/SessCustomerCodeDelegate"},{"$ref":"#/components/schemas/SessCustomerCodeDelegateByReference"},{"$ref":"#/components/schemas/SessCustomerCodeProspect"}],"discriminator":{"propertyName":"type","mapping":{"SessCustomerCodeConsumer":"#/components/schemas/SessCustomerCodeConsumer","SessCustomerCodeContactVerification":"#/components/schemas/SessCustomerCodeContactVerification","SessCustomerCodeDelegate":"#/components/schemas/SessCustomerCodeDelegate","SessCustomerCodeDelegateByReference":"#/components/schemas/SessCustomerCodeDelegateByReference","SessCustomerCodeProspect":"#/components/schemas/SessCustomerCodeProspect"}}},"SessCustomerCodeConsumer":{"title":"SessCustomerCodeConsumer","description":"A B2C consumer customer. Both codes are required.","examples":[{"type":"SessCustomerCodeConsumer","emailAddress":"ada@example.com","emailVerificationCode":"ada@example.com","phoneVerificationCode":"+61400000000"}],"type":"object","required":["type","emailAddress","emailVerificationCode","phoneVerificationCode"],"properties":{"type":{"description":"Always `SessCustomerCodeConsumer`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessCustomerCodeConsumer"]},"emailAddress":{"type":"string"},"emailVerificationCode":{"type":"string"},"phoneVerificationCode":{"type":"string"}}},"SessCustomerCodeContactVerification":{"title":"SessCustomerCodeContactVerification","description":"Answering codes sent to verify contact details already on record. Answers with proof tokens, not a session.","examples":[{"type":"SessCustomerCodeContactVerification","customerId":"cust_9f2Kd8QpLzXw","emailAddress":"ada@example.com","emailSentAt":"2026-08-19T04:21:07Z","emailVerificationCode":"ada@example.com","phoneNumber":"+61400000000","phoneSentAt":"2026-08-19T04:21:07Z","phoneVerificationCode":"+61400000000"}],"type":"object","required":["type","customerId","phoneNumber","phoneSentAt","phoneVerificationCode"],"properties":{"type":{"description":"Always `SessCustomerCodeContactVerification`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessCustomerCodeContactVerification"]},"customerId":{"$ref":"#/components/schemas/CustId","description":"Identifier of a customer."},"emailAddress":{"description":"Omit when only the phone number was verified.","type":"string"},"emailSentAt":{"description":"Exactly as returned by the send. It is signed into the proof token.","type":"string","format":"date-time"},"emailVerificationCode":{"type":"string"},"phoneNumber":{"description":"E.164 format, e.g. +61400000000.","type":"string"},"phoneSentAt":{"description":"Exactly as returned by the send. It is signed into the proof token.","type":"string","format":"date-time"},"phoneVerificationCode":{"type":"string"}}},"SessCustomerCodeDelegate":{"title":"SessCustomerCodeDelegate","description":"A B2B delegate, by the customer's system identifier.","examples":[{"type":"SessCustomerCodeDelegate","customerId":"cust_9f2Kd8QpLzXw","delegateEmailAddress":"ada@example.com","emailVerificationCode":"ada@example.com","phoneVerificationCode":"+61400000000"}],"type":"object","required":["type","customerId","delegateEmailAddress","emailVerificationCode"],"properties":{"type":{"description":"Always `SessCustomerCodeDelegate`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessCustomerCodeDelegate"]},"customerId":{"$ref":"#/components/schemas/CustId","description":"Identifier of a customer."},"delegateEmailAddress":{"type":"string"},"emailVerificationCode":{"type":"string"},"phoneVerificationCode":{"description":"Required only where a code was sent to a phone, that is, where `SessViewCustomerOtpSent` carried `phoneNumberLast4`.","type":"string"}}},"SessCustomerCodeDelegateByReference":{"title":"SessCustomerCodeDelegateByReference","description":"A B2B delegate, by your own reference for the customer.","examples":[{"type":"SessCustomerCodeDelegateByReference","referenceCustomerId":"your-own-reference","delegateEmailAddress":"ada@example.com","emailVerificationCode":"ada@example.com","phoneVerificationCode":"+61400000000"}],"type":"object","required":["type","referenceCustomerId","delegateEmailAddress","emailVerificationCode"],"properties":{"type":{"description":"Always `SessCustomerCodeDelegateByReference`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessCustomerCodeDelegateByReference"]},"referenceCustomerId":{"description":"Your own reference for the customer, unique within your merchant.","type":"string"},"delegateEmailAddress":{"type":"string"},"emailVerificationCode":{"type":"string"},"phoneVerificationCode":{"description":"Required only where a code was sent to a phone, that is, where `SessViewCustomerOtpSent` carried `phoneNumberLast4`.","type":"string"}}},"SessCustomerCodeProspect":{"title":"SessCustomerCodeProspect","description":"A prospective B2B delegate. Email code only, there is no customer on record yet.","examples":[{"type":"SessCustomerCodeProspect","emailAddress":"ada@example.com","emailVerificationCode":"ada@example.com"}],"type":"object","required":["type","emailAddress","emailVerificationCode"],"properties":{"type":{"description":"Always `SessCustomerCodeProspect`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessCustomerCodeProspect"]},"emailAddress":{"type":"string"},"emailVerificationCode":{"type":"string"}}},"SessCustomerConsumer":{"title":"SessCustomerConsumer","description":"A B2C consumer customer.","examples":[{"type":"SessCustomerConsumer","customerId":"cust_9f2Kd8QpLzXw"}],"type":"object","required":["type","customerId"],"properties":{"type":{"description":"Always `SessCustomerConsumer`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessCustomerConsumer"]},"customerId":{"$ref":"#/components/schemas/CustId","description":"Identifier of a customer."}}},"SessCustomerDelegate":{"title":"SessCustomerDelegate","description":"A B2B delegate, by the customer's system identifier.","examples":[{"type":"SessCustomerDelegate","customerId":"cust_9f2Kd8QpLzXw","delegateEmailAddress":"ada@example.com","delegatePhoneNumber":"+61400000000","delegateName":"Ada Lovelace","delegatePosition":"example"}],"type":"object","required":["type","customerId","delegateEmailAddress"],"properties":{"type":{"description":"Always `SessCustomerDelegate`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessCustomerDelegate"]},"customerId":{"$ref":"#/components/schemas/CustId","description":"Identifier of a customer."},"delegateEmailAddress":{"type":"string"},"delegatePhoneNumber":{"description":"Supplying this **changes** the delegate's phone number. Omit to leave it alone.","type":"string"},"delegateName":{"description":"Supplying this **changes** the delegate's name. Omit to leave it alone.","type":"string"},"delegatePosition":{"description":"Supplying this **changes** the delegate's position. Omit to leave it alone.","type":"string"}}},"SessCustomerDelegateByReference":{"title":"SessCustomerDelegateByReference","description":"A B2B delegate, by your own reference for the customer.","examples":[{"type":"SessCustomerDelegateByReference","referenceCustomerId":"your-own-reference","delegateEmailAddress":"ada@example.com","delegatePhoneNumber":"+61400000000","delegateName":"Ada Lovelace","delegatePosition":"example"}],"type":"object","required":["type","referenceCustomerId","delegateEmailAddress"],"properties":{"type":{"description":"Always `SessCustomerDelegateByReference`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessCustomerDelegateByReference"]},"referenceCustomerId":{"description":"Your own reference for the customer, unique within your merchant.","type":"string"},"delegateEmailAddress":{"type":"string"},"delegatePhoneNumber":{"description":"Supplying this **changes** the delegate's phone number. Omit to leave it alone.","type":"string"},"delegateName":{"description":"Supplying this **changes** the delegate's name. Omit to leave it alone.","type":"string"},"delegatePosition":{"description":"Supplying this **changes** the delegate's position. Omit to leave it alone.","type":"string"}}},"SessCustomerOtp":{"oneOf":[{"$ref":"#/components/schemas/SessCustomerOtpConsumer"},{"$ref":"#/components/schemas/SessCustomerOtpContactVerification"},{"$ref":"#/components/schemas/SessCustomerOtpDelegate"},{"$ref":"#/components/schemas/SessCustomerOtpDelegateByReference"},{"$ref":"#/components/schemas/SessCustomerOtpProspect"}],"discriminator":{"propertyName":"type","mapping":{"SessCustomerOtpConsumer":"#/components/schemas/SessCustomerOtpConsumer","SessCustomerOtpContactVerification":"#/components/schemas/SessCustomerOtpContactVerification","SessCustomerOtpDelegate":"#/components/schemas/SessCustomerOtpDelegate","SessCustomerOtpDelegateByReference":"#/components/schemas/SessCustomerOtpDelegateByReference","SessCustomerOtpProspect":"#/components/schemas/SessCustomerOtpProspect"}}},"SessCustomerOtpConsumer":{"title":"SessCustomerOtpConsumer","description":"A B2C consumer customer. Codes go to their email address and their phone.","examples":[{"type":"SessCustomerOtpConsumer","emailAddress":"ada@example.com"}],"type":"object","required":["type","emailAddress"],"properties":{"type":{"description":"Always `SessCustomerOtpConsumer`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessCustomerOtpConsumer"]},"emailAddress":{"type":"string"}}},"SessCustomerOtpContactVerification":{"title":"SessCustomerOtpContactVerification","description":"A customer verifying contact details already on their record. Answers with the timestamps the proof tokens are built from.","examples":[{"type":"SessCustomerOtpContactVerification","customerId":"cust_9f2Kd8QpLzXw","emailAddress":"ada@example.com","phoneNumber":"+61400000000","channel":"Email"}],"type":"object","required":["type","customerId","emailAddress","phoneNumber","channel"],"properties":{"type":{"description":"Always `SessCustomerOtpContactVerification`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessCustomerOtpContactVerification"]},"customerId":{"$ref":"#/components/schemas/CustId","description":"Identifier of a customer."},"emailAddress":{"type":"string"},"phoneNumber":{"description":"E.164 format, e.g. +61400000000.","type":"string"},"channel":{"$ref":"#/components/schemas/SessVerificationChannel"}}},"SessCustomerOtpDelegate":{"title":"SessCustomerOtpDelegate","description":"A B2B delegate, by the customer's system identifier.","examples":[{"type":"SessCustomerOtpDelegate","customerId":"cust_9f2Kd8QpLzXw","delegateEmailAddress":"ada@example.com"}],"type":"object","required":["type","customerId","delegateEmailAddress"],"properties":{"type":{"description":"Always `SessCustomerOtpDelegate`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessCustomerOtpDelegate"]},"customerId":{"$ref":"#/components/schemas/CustId","description":"Identifier of a customer."},"delegateEmailAddress":{"type":"string"}}},"SessCustomerOtpDelegateByReference":{"title":"SessCustomerOtpDelegateByReference","description":"A B2B delegate, by your own reference for the customer.","examples":[{"type":"SessCustomerOtpDelegateByReference","referenceCustomerId":"your-own-reference","delegateEmailAddress":"ada@example.com"}],"type":"object","required":["type","referenceCustomerId","delegateEmailAddress"],"properties":{"type":{"description":"Always `SessCustomerOtpDelegateByReference`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessCustomerOtpDelegateByReference"]},"referenceCustomerId":{"description":"Your own reference for the customer, unique within your merchant.","type":"string"},"delegateEmailAddress":{"type":"string"}}},"SessCustomerOtpProspect":{"title":"SessCustomerOtpProspect","description":"A prospective B2B delegate, an email address with no customer behind it yet.","examples":[{"type":"SessCustomerOtpProspect","emailAddress":"ada@example.com"}],"type":"object","required":["type","emailAddress"],"properties":{"type":{"description":"Always `SessCustomerOtpProspect`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessCustomerOtpProspect"]},"emailAddress":{"type":"string"}}},"SessDomain":{"oneOf":[{"$ref":"#/components/schemas/SessDomainAttributes"}],"discriminator":{"propertyName":"type","mapping":{"SessDomainAttributes":"#/components/schemas/SessDomainAttributes"}}},"SessDomainAttributes":{"title":"SessDomainAttributes","description":"A permission domain, and what the platform calls it.","examples":[{"type":"SessDomainAttributes","domain":{"type":"UserDomainAnonymous","restrictedTo":{"type":"UserDomainCustomer","customerId":"cust_9f2Kd8QpLzXw"}},"description":"A short description."}],"type":"object","required":["type","domain","description"],"properties":{"type":{"description":"Always `SessDomainAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessDomainAttributes"]},"domain":{"$ref":"#/components/schemas/UserPermissionDomain"},"description":{"description":"What the platform calls this domain, the merchant's or marketplace's name. This is how a user tells two apart.","type":"string"}}},"SessIdEmail":{"title":"SessIdEmail","description":"Identify by email address.","examples":[{"type":"SessIdEmail","emailAddress":"ada@example.com"}],"type":"object","required":["type","emailAddress"],"properties":{"type":{"description":"Always `SessIdEmail`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessIdEmail"]},"emailAddress":{"type":"string"}}},"SessIdPhone":{"title":"SessIdPhone","description":"Identify by phone number, in E.164 format such as `+61400000000`.","examples":[{"type":"SessIdPhone","phoneNumber":"+61400000000"}],"type":"object","required":["type","phoneNumber"],"properties":{"type":{"description":"Always `SessIdPhone`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessIdPhone"]},"phoneNumber":{"type":"string"}}},"SessIdentifier":{"oneOf":[{"$ref":"#/components/schemas/SessIdEmail"},{"$ref":"#/components/schemas/SessIdPhone"}],"discriminator":{"propertyName":"type","mapping":{"SessIdEmail":"#/components/schemas/SessIdEmail","SessIdPhone":"#/components/schemas/SessIdPhone"}}},"SessLinkPurpose":{"title":"SessLinkPurpose","description":"Which link was sent, a sign-in link, or a set/reset-password link.","type":"string","enum":["SignIn","PasswordReset","Unknown"]},"SessMethod":{"oneOf":[{"$ref":"#/components/schemas/SessMethodBuiltIn"},{"$ref":"#/components/schemas/SessMethodFederated"}],"discriminator":{"propertyName":"type","mapping":{"SessMethodBuiltIn":"#/components/schemas/SessMethodBuiltIn","SessMethodFederated":"#/components/schemas/SessMethodFederated"}}},"SessMethodBuiltIn":{"title":"SessMethodBuiltIn","description":"The user signs in against APG Pay's own credential store.","examples":[{"type":"SessMethodBuiltIn","methods":["Password"]}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `SessMethodBuiltIn`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessMethodBuiltIn"]},"methods":{"description":"Every built-in method this user can sign in with, in no particular order. Offer a chooser when there is more than one. Never empty, an identifier the platform does not know answers `[Password]`, which is the same answer a real password user gets.","type":"array","items":{"$ref":"#/components/schemas/SessBuiltInMethod"}}}},"SessMethodFederated":{"title":"SessMethodFederated","description":"The user signs in at an external OpenID Connect identity provider.","examples":[{"type":"SessMethodFederated","idpDisplayName":"Ada Lovelace"}],"type":"object","required":["type","idpDisplayName"],"properties":{"type":{"description":"Always `SessMethodFederated`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessMethodFederated"]},"idpDisplayName":{"description":"What to call the provider on the hand-off interstitial. This is why the method is a union rather than an enum value.","type":"string"}}},"SessOtpChallengeId":{"title":"SessOtpChallengeId","examples":["lotp_9f2Kd8QpLzXw"],"type":"string"},"SessOtpChannel":{"title":"SessOtpChannel","type":"string","enum":["Email","Phone","Unknown"]},"SessPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/SessPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"SessPageAttributes":"#/components/schemas/SessPageAttributes"}}},"SessPageAttributes":{"title":"SessPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"SessPageAttributes","data":[{"type":"SessViewAuthenticated","userId":"user_9f2Kd8QpLzXw","displayName":"Ada Lovelace","activeDomain":{"type":"SessDomainAttributes","domain":{"type":"UserDomainAnonymous","restrictedTo":{"type":"UserDomainCustomer","customerId":"cust_9f2Kd8QpLzXw"}},"description":"A short description."},"roleIds":["role_9f2Kd8QpLzXw"],"capabilities":[{"type":"SessCapabilityAttributes","resource":"BlockedCard","actions":["Create"]}],"rbacHash":"example","directDebitAccountKinds":["Au"],"expiresAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `SessPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/SessView"}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"SessScope":{"oneOf":[{"$ref":"#/components/schemas/SessScopeCustomer"},{"$ref":"#/components/schemas/SessScopeDelegate"},{"$ref":"#/components/schemas/SessScopeEnterprise"},{"$ref":"#/components/schemas/SessScopeMarketplace"},{"$ref":"#/components/schemas/SessScopeMerchant"},{"$ref":"#/components/schemas/SessScopeRoot"}],"discriminator":{"propertyName":"type","mapping":{"SessScopeCustomer":"#/components/schemas/SessScopeCustomer","SessScopeDelegate":"#/components/schemas/SessScopeDelegate","SessScopeEnterprise":"#/components/schemas/SessScopeEnterprise","SessScopeMarketplace":"#/components/schemas/SessScopeMarketplace","SessScopeMerchant":"#/components/schemas/SessScopeMerchant","SessScopeRoot":"#/components/schemas/SessScopeRoot"}}},"SessScopeCustomer":{"title":"SessScopeCustomer","description":"A customer domain.","examples":[{"type":"SessScopeCustomer","refId":"abc123"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `SessScopeCustomer`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessScopeCustomer"]},"refId":{"description":"Restrict to the customer identified by this value, its system identifier or the merchant's own reference for it.","type":"string"}}},"SessScopeDelegate":{"title":"SessScopeDelegate","description":"A customer-delegate domain.","examples":[{"type":"SessScopeDelegate","refId":"abc123"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `SessScopeDelegate`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessScopeDelegate"]},"refId":{"description":"Restrict to the delegate identified by this value, its system identifier.","type":"string"}}},"SessScopeEnterprise":{"title":"SessScopeEnterprise","description":"An enterprise domain.","examples":[{"type":"SessScopeEnterprise","refId":"abc123"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `SessScopeEnterprise`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessScopeEnterprise"]},"refId":{"description":"Restrict to the enterprise identified by this value, its system identifier or slug.","type":"string"}}},"SessScopeMarketplace":{"title":"SessScopeMarketplace","description":"A marketplace domain.","examples":[{"type":"SessScopeMarketplace","refId":"abc123"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `SessScopeMarketplace`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessScopeMarketplace"]},"refId":{"description":"Restrict to the marketplace identified by this value, its system identifier or slug.","type":"string"}}},"SessScopeMerchant":{"title":"SessScopeMerchant","description":"A merchant domain.","examples":[{"type":"SessScopeMerchant","refId":"abc123"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `SessScopeMerchant`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessScopeMerchant"]},"refId":{"description":"Restrict to the merchant identified by this value, its system identifier or slug.","type":"string"}}},"SessScopeRoot":{"title":"SessScopeRoot","description":"The root domain.","examples":[{"type":"SessScopeRoot"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `SessScopeRoot`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessScopeRoot"]}}},"SessUpdate":{"oneOf":[{"$ref":"#/components/schemas/SessUpdateRefresh"},{"$ref":"#/components/schemas/SessUpdateSelectDomain"}],"discriminator":{"propertyName":"type","mapping":{"SessUpdateRefresh":"#/components/schemas/SessUpdateRefresh","SessUpdateSelectDomain":"#/components/schemas/SessUpdateSelectDomain"}}},"SessUpdateRefresh":{"title":"SessUpdateRefresh","description":"Trade a refresh token for a new bearer. The refresh token is rotated.","examples":[{"type":"SessUpdateRefresh","refreshToken":"tok_9f2Kd8QpLzXwR4mN"}],"type":"object","required":["type","refreshToken"],"properties":{"type":{"description":"Always `SessUpdateRefresh`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessUpdateRefresh"]},"refreshToken":{"type":"string"}}},"SessUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/SessUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"SessUpdateRspAttributes":"#/components/schemas/SessUpdateRspAttributes"}}},"SessUpdateRspAttributes":{"title":"SessUpdateRspAttributes","examples":[{"type":"SessUpdateRspAttributes","updated":{"type":"SessViewAuthenticated","userId":"user_9f2Kd8QpLzXw","displayName":"Ada Lovelace","activeDomain":{"type":"SessDomainAttributes","domain":{"type":"UserDomainAnonymous","restrictedTo":{"type":"UserDomainCustomer","customerId":"cust_9f2Kd8QpLzXw"}},"description":"A short description."},"roleIds":["role_9f2Kd8QpLzXw"],"capabilities":[{"type":"SessCapabilityAttributes","resource":"BlockedCard","actions":["Create"]}],"rbacHash":"example","directDebitAccountKinds":["Au"],"expiresAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `SessUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/SessView","description":"The resource as it stands after the change."}}},"SessUpdateSelectDomain":{"title":"SessUpdateSelectDomain","description":"Re-scope the current session to another of the user's domains.","examples":[{"type":"SessUpdateSelectDomain","domain":{"type":"UserDomainAnonymous","restrictedTo":{"type":"UserDomainCustomer","customerId":"cust_9f2Kd8QpLzXw"}}}],"type":"object","required":["type","domain"],"properties":{"type":{"description":"Always `SessUpdateSelectDomain`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessUpdateSelectDomain"]},"domain":{"$ref":"#/components/schemas/UserPermissionDomain"}}},"SessVerificationChannel":{"title":"SessVerificationChannel","description":"Which of the two to send to. `Both` is the usual choice, the answer requires the phone code either way.","type":"string","enum":["Email","Phone","Both","Unknown"]},"SessView":{"oneOf":[{"$ref":"#/components/schemas/SessViewAuthenticated"},{"$ref":"#/components/schemas/SessViewContactVerificationSent"},{"$ref":"#/components/schemas/SessViewContactVerified"},{"$ref":"#/components/schemas/SessViewCustomerOtpSent"},{"$ref":"#/components/schemas/SessViewIssued"},{"$ref":"#/components/schemas/SessViewLinkSent"},{"$ref":"#/components/schemas/SessViewMethod"},{"$ref":"#/components/schemas/SessViewOtpSent"},{"$ref":"#/components/schemas/SessViewPasswordChanged"},{"$ref":"#/components/schemas/SessViewProspect"},{"$ref":"#/components/schemas/SessViewReauthenticationRequired"},{"$ref":"#/components/schemas/SessViewRedirect"}],"discriminator":{"propertyName":"type","mapping":{"SessViewAuthenticated":"#/components/schemas/SessViewAuthenticated","SessViewContactVerificationSent":"#/components/schemas/SessViewContactVerificationSent","SessViewContactVerified":"#/components/schemas/SessViewContactVerified","SessViewCustomerOtpSent":"#/components/schemas/SessViewCustomerOtpSent","SessViewIssued":"#/components/schemas/SessViewIssued","SessViewLinkSent":"#/components/schemas/SessViewLinkSent","SessViewMethod":"#/components/schemas/SessViewMethod","SessViewOtpSent":"#/components/schemas/SessViewOtpSent","SessViewPasswordChanged":"#/components/schemas/SessViewPasswordChanged","SessViewProspect":"#/components/schemas/SessViewProspect","SessViewReauthenticationRequired":"#/components/schemas/SessViewReauthenticationRequired","SessViewRedirect":"#/components/schemas/SessViewRedirect"}}},"SessViewAuthenticated":{"title":"SessViewAuthenticated","description":"A session that has been authenticated, and what it can do.","examples":[{"type":"SessViewAuthenticated","userId":"user_9f2Kd8QpLzXw","displayName":"Ada Lovelace","activeDomain":{"type":"SessDomainAttributes","domain":{"type":"UserDomainAnonymous","restrictedTo":{"type":"UserDomainCustomer","customerId":"cust_9f2Kd8QpLzXw"}},"description":"A short description."},"roleIds":["role_9f2Kd8QpLzXw"],"capabilities":[{"type":"SessCapabilityAttributes","resource":"BlockedCard","actions":["Create"]}],"rbacHash":"example","directDebitAccountKinds":["Au"],"expiresAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","userId","displayName","activeDomain","rbacHash","expiresAt"],"properties":{"type":{"description":"Always `SessViewAuthenticated`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessViewAuthenticated"]},"userId":{"$ref":"#/components/schemas/UserId"},"displayName":{"description":"The user's name, as the platform holds it.","type":"string"},"activeDomain":{"$ref":"#/components/schemas/SessDomain","description":"The domain this session is acting in. A session carries exactly one at a time."},"roleIds":{"description":"The roles the session holds in that domain. Why it can do what it can.","type":"array","items":{"type":"string"}},"capabilities":{"description":"What it can actually do, the roles' grants, expanded.","type":"array","items":{"$ref":"#/components/schemas/SessCapability"}},"rbacHash":{"description":"A fingerprint of the permissions behind this session. It changes when the user's roles do, so a stale one means re-read.","type":"string"},"directDebitAccountKinds":{"description":"The kinds of bank account the platform can take a direct debit from. Offer only these `PsrcBankAccount` kinds when storing a direct debit source: any other can be stored, but no debit can be taken from it.","type":"array","items":{"$ref":"#/components/schemas/PsrcBankAccountKind"}},"expiresAt":{"description":"When the session stops working.","type":"string","format":"date-time"}}},"SessViewContactVerificationSent":{"title":"SessViewContactVerificationSent","description":"Contact-verification codes are on their way. Echo these timestamps back exactly, they are signed into the proof tokens.","examples":[{"type":"SessViewContactVerificationSent","emailSentAt":"2026-08-19T04:21:07Z","phoneSentAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","phoneSentAt"],"properties":{"type":{"description":"Always `SessViewContactVerificationSent`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessViewContactVerificationSent"]},"emailSentAt":{"description":"Absent when no code went to an email address.","type":"string","format":"date-time"},"phoneSentAt":{"type":"string","format":"date-time"}}},"SessViewContactVerified":{"title":"SessViewContactVerified","description":"The contact details are verified. Proof tokens, plus a bearer for the customer.","examples":[{"type":"SessViewContactVerified","emailToken":"ada@example.com","phoneToken":"+61400000000","signInToken":"tok_9f2Kd8QpLzXwR4mN"}],"type":"object","required":["type","emailToken","phoneToken","signInToken"],"properties":{"type":{"description":"Always `SessViewContactVerified`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessViewContactVerified"]},"emailToken":{"description":"Proof the email address was verified. Empty where no email code was answered.","type":"string"},"phoneToken":{"description":"Proof the phone number was verified.","type":"string"},"signInToken":{"description":"A bearer for the customer's session, present it directly. It lasts its hour and has no refresh token.","type":"string"}}},"SessViewCustomerOtpSent":{"title":"SessViewCustomerOtpSent","description":"One-time codes are on their way to the customer.","examples":[{"type":"SessViewCustomerOtpSent","phoneNumberLast4":"4242"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `SessViewCustomerOtpSent`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessViewCustomerOtpSent"]},"phoneNumberLast4":{"description":"Last four digits of the phone number a code went to. Absent when no phone number was on record, so only the email address was used.","type":"string"}}},"SessViewIssued":{"title":"SessViewIssued","description":"A session that was just minted, and the credentials that carry it.","examples":[{"type":"SessViewIssued","token":"tok_9f2Kd8QpLzXwR4mN","refreshToken":"tok_9f2Kd8QpLzXwR4mN","expiresAt":"2026-08-19T04:21:07Z","activeDomain":{"type":"SessDomainAttributes","domain":{"type":"UserDomainAnonymous","restrictedTo":{"type":"UserDomainCustomer","customerId":"cust_9f2Kd8QpLzXw"}},"description":"A short description."},"availableDomains":[{"type":"SessDomainAttributes","domain":{"type":"UserDomainAnonymous","restrictedTo":{"type":"UserDomainCustomer","customerId":"cust_9f2Kd8QpLzXw"}},"description":"A short description."}]}],"type":"object","required":["type","token","refreshToken","expiresAt","activeDomain"],"properties":{"type":{"description":"Always `SessViewIssued`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessViewIssued"]},"token":{"description":"The bearer for this session. Treat it as a credential, and present it as `Authorization: Bearer`.","type":"string"},"refreshToken":{"description":"Redeem this for a new bearer. Rotated on every use, keep the newest.","type":"string"},"expiresAt":{"description":"When the bearer stops working.","type":"string","format":"date-time"},"activeDomain":{"$ref":"#/components/schemas/SessDomain","description":"The domain this session is acting in."},"availableDomains":{"description":"Every domain the user holds, in the platform's precedence order. Switch between them with a `PATCH`.","type":"array","items":{"$ref":"#/components/schemas/SessDomain","description":"A permission domain, and what the platform calls it."}}}},"SessViewLinkSent":{"title":"SessViewLinkSent","description":"A link is on its way to the email address given.","examples":[{"type":"SessViewLinkSent","purpose":"SignIn"}],"type":"object","required":["type","purpose"],"properties":{"type":{"description":"Always `SessViewLinkSent`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessViewLinkSent"]},"purpose":{"$ref":"#/components/schemas/SessLinkPurpose"}}},"SessViewMethod":{"title":"SessViewMethod","description":"How the identified user signs in, and the handle to carry into the sign-in.","examples":[{"type":"SessViewMethod","method":{"type":"SessMethodBuiltIn","methods":["Password"]},"selectedDomainHandle":"example"}],"type":"object","required":["type","method","selectedDomainHandle"],"properties":{"type":{"description":"Always `SessViewMethod`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessViewMethod"]},"method":{"$ref":"#/components/schemas/SessMethod","description":"`SessMethodBuiltIn` for APG Pay's own credential store, `SessMethodFederated` for an external identity provider."},"selectedDomainHandle":{"description":"Opaque handle for the permission domain the method was resolved from. Present it unchanged on the sign-in arm. It carries no readable information and grants nothing on its own. Valid for one hour.","type":"string"}}},"SessViewOtpSent":{"title":"SessViewOtpSent","description":"A one-time code is on its way. Quote `challengeId` when submitting it.","examples":[{"type":"SessViewOtpSent","challengeId":"lotp_9f2Kd8QpLzXw","channel":"Email"}],"type":"object","required":["type","challengeId","channel"],"properties":{"type":{"description":"Always `SessViewOtpSent`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessViewOtpSent"]},"challengeId":{"$ref":"#/components/schemas/SessOtpChallengeId","description":"Handle naming the challenge. Present it with the code on `SessCmdSignInOtp`. Grants nothing on its own."},"channel":{"$ref":"#/components/schemas/SessOtpChannel","description":"Which contact detail the code went to, so the prompt can say which one to check."}}},"SessViewPasswordChanged":{"title":"SessViewPasswordChanged","description":"The password was changed, and every refresh token you hold is revoked: your bearer works until it expires, and then you sign in again.","examples":[{"type":"SessViewPasswordChanged"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `SessViewPasswordChanged`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessViewPasswordChanged"]}}},"SessViewProspect":{"title":"SessViewProspect","description":"A B2B prospect with no existing delegate. Carry this token through the onboarding flow.","examples":[{"type":"SessViewProspect","b2bProspectToken":"tok_9f2Kd8QpLzXwR4mN"}],"type":"object","required":["type","b2bProspectToken"],"properties":{"type":{"description":"Always `SessViewProspect`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessViewProspect"]},"b2bProspectToken":{"description":"Carry through the B2B onboarding flow. Treat as a credential.","type":"string"}}},"SessViewReauthenticationRequired":{"title":"SessViewReauthenticationRequired","description":"The session cannot move to that domain without authenticating again.","examples":[{"type":"SessViewReauthenticationRequired","method":{"type":"SessMethodBuiltIn","methods":["Password"]}}],"type":"object","required":["type","method"],"properties":{"type":{"description":"Always `SessViewReauthenticationRequired`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessViewReauthenticationRequired"]},"method":{"$ref":"#/components/schemas/SessMethod","description":"What to authenticate with. Present the current bearer as `sessionToken` so the new session carries both methods."}}},"SessViewRedirect":{"title":"SessViewRedirect","description":"Navigate the browser to the identity provider's authorisation URL.","examples":[{"type":"SessViewRedirect","authorisationUrl":"https://example.com/callback"}],"type":"object","required":["type","authorisationUrl"],"properties":{"type":{"description":"Always `SessViewRedirect`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SessViewRedirect"]},"authorisationUrl":{"description":"The provider's authorisation URL. Navigate the browser to it at the top level, not in a frame or with fetch.","type":"string"}}},"SettlementEntryColumn":{"title":"SettlementEntryColumn","type":"string","enum":["EntryJournalEntryId","EntryCounterEntryId","EntryJournalOwnerType","EntryJournalOwnerIdentifier","EntryJournalCategory","EntryJournalClearanceSystem","EntryJournalCurrency","EntryEntryType","EntryAmountsCurrency","EntryAmountsDebit","EntryAmountsCredit","EntryAmountsTax","EntryAmountsTaxRate","EntryAmountsTaxType","EntryAmountsTaxCountry","EntryEventSystemEventId","EntryEventSystemEventType","EntryMerchantId","EntryMarketplaceId","EntryEnterpriseId","EntryOriginalAmountMinorCurrencyUnits","EntryOriginalAmountCurrency","EntryDescription","EntryClearanceDate","EntrySettlementDate","EntryReferenceId","EntryCreatedAt","PayoutId"]},"SettlementEntryPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/SettlementEntryPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"SettlementEntryPageAttributes":"#/components/schemas/SettlementEntryPageAttributes"}}},"SettlementEntryPageAttributes":{"title":"SettlementEntryPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"SettlementEntryPageAttributes","data":[{"type":"SettlementEntryViewAttributes","entry":{"type":"JnalViewAttributes","journalEntryId":"sjen_9f2Kd8QpLzXw","counterEntryId":"sjen_9f2Kd8QpLzXw","journal":{"type":"SjnlBusinessKeyAttributes","ownerType":"Merchant","ownerIdentifier":"example","category":"General","clearanceSystem":"example","currency":"AUD"},"entryType":"example","amounts":{"type":"JnalAmountsAttributes","currency":"AUD","debit":"example","credit":"example","tax":"example","taxRate":"0.9412","taxType":"example","taxCountry":"AU"},"event":{"type":"JnalEventAttributes","systemEventId":"abc123","systemEventType":"example"},"merchantId":"mcht_9f2Kd8QpLzXw","marketplaceId":"mktp_9f2Kd8QpLzXw","enterpriseId":"ent_9f2Kd8QpLzXw","originalAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"description":"A short description.","clearanceDate":"2026-08-19","settlementDate":"2026-08-19","referenceId":"your-own-reference","metadata":{"yourKey":"example"},"createdAt":"2026-08-19T04:21:07Z"},"payoutId":"payout_9f2Kd8QpLzXw"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `SettlementEntryPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SettlementEntryPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/SettlementEntryView"}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"SettlementEntrySort":{"title":"SettlementEntrySort","type":"string","enum":["createdAt","-createdAt"]},"SettlementEntryView":{"description":"One line of a merchant's settlement: a journal entry, and the payout it landed in.","oneOf":[{"$ref":"#/components/schemas/SettlementEntryViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"SettlementEntryViewAttributes":"#/components/schemas/SettlementEntryViewAttributes"}}},"SettlementEntryViewAttributes":{"title":"SettlementEntryViewAttributes","description":"One line of a merchant's settlement: a journal entry, and the payout it landed in.","examples":[{"type":"SettlementEntryViewAttributes","entry":{"type":"JnalViewAttributes","journalEntryId":"sjen_9f2Kd8QpLzXw","counterEntryId":"sjen_9f2Kd8QpLzXw","journal":{"type":"SjnlBusinessKeyAttributes","ownerType":"Merchant","ownerIdentifier":"example","category":"General","clearanceSystem":"example","currency":"AUD"},"entryType":"example","amounts":{"type":"JnalAmountsAttributes","currency":"AUD","debit":"example","credit":"example","tax":"example","taxRate":"0.9412","taxType":"example","taxCountry":"AU"},"event":{"type":"JnalEventAttributes","systemEventId":"abc123","systemEventType":"example"},"merchantId":"mcht_9f2Kd8QpLzXw","marketplaceId":"mktp_9f2Kd8QpLzXw","enterpriseId":"ent_9f2Kd8QpLzXw","originalAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"description":"A short description.","clearanceDate":"2026-08-19","settlementDate":"2026-08-19","referenceId":"your-own-reference","metadata":{"yourKey":"example"},"createdAt":"2026-08-19T04:21:07Z"},"payoutId":"payout_9f2Kd8QpLzXw"}],"type":"object","required":["type","entry"],"properties":{"type":{"description":"Always `SettlementEntryViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SettlementEntryViewAttributes"]},"entry":{"$ref":"#/components/schemas/JnalView","description":"The movement itself. The same row `/journal-entries` publishes, read from the merchant's side."},"payoutId":{"$ref":"#/components/schemas/PayoutId","description":"The payout this entry settled in. Absent until the payout that will carry it is raised."}}},"SimCmd":{"oneOf":[{"$ref":"#/components/schemas/SimCmdCardAuthorisation"},{"$ref":"#/components/schemas/SimCmdCardClearing"},{"$ref":"#/components/schemas/SimCmdCardRefund"},{"$ref":"#/components/schemas/SimCmdDispute"},{"$ref":"#/components/schemas/SimCmdIssuerMessage"},{"$ref":"#/components/schemas/SimCmdIssuerMessageProcessing"}],"discriminator":{"propertyName":"type","mapping":{"SimCmdCardAuthorisation":"#/components/schemas/SimCmdCardAuthorisation","SimCmdCardClearing":"#/components/schemas/SimCmdCardClearing","SimCmdCardRefund":"#/components/schemas/SimCmdCardRefund","SimCmdDispute":"#/components/schemas/SimCmdDispute","SimCmdIssuerMessage":"#/components/schemas/SimCmdIssuerMessage","SimCmdIssuerMessageProcessing":"#/components/schemas/SimCmdIssuerMessageProcessing"}}},"SimCmdCardAuthorisation":{"title":"SimCmdCardAuthorisation","description":"Pretend the scheme authorised a purchase on an issued card. Answers the authorisation id a clearing needs.","examples":[{"type":"SimCmdCardAuthorisation","providerIdentifier":"example","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"merchantName":"Ada Lovelace","merchantCategoryCode":"example"}],"type":"object","required":["type","providerIdentifier","amount","merchantName","merchantCategoryCode"],"properties":{"type":{"description":"Always `SimCmdCardAuthorisation`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SimCmdCardAuthorisation"]},"providerIdentifier":{"description":"The card's identifier at the provider, `providerIdentifier` on the card, not its `dcard_` id.","type":"string"},"amount":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"An amount in minor current units of a given currency."},"merchantName":{"description":"The merchant the purchase was made at, as it would appear on a statement.","type":"string"},"merchantCategoryCode":{"description":"The merchant's category code, four digits. Decides which limits and fees apply.","type":"string"}}},"SimCmdCardClearing":{"title":"SimCmdCardClearing","description":"Pretend the scheme cleared an authorisation. Names the authorisation it settles.","examples":[{"type":"SimCmdCardClearing","providerIdentifier":"example","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"authorisationId":"abc123","merchantCategoryCode":"example"}],"type":"object","required":["type","providerIdentifier","amount","authorisationId","merchantCategoryCode"],"properties":{"type":{"description":"Always `SimCmdCardClearing`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SimCmdCardClearing"]},"providerIdentifier":{"description":"The card's identifier at the provider, as on `SimCmdCardAuthorisation`.","type":"string"},"amount":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"An amount in minor current units of a given currency."},"authorisationId":{"description":"The authorisation this clears, as `SimCmdCardAuthorisation` returned it.","type":"string"},"merchantCategoryCode":{"type":"string"}}},"SimCmdCardRefund":{"title":"SimCmdCardRefund","description":"Pretend the scheme sent a refund against an issued card.","examples":[{"type":"SimCmdCardRefund","cardId":"dcard_9f2Kd8QpLzXw","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"}}],"type":"object","required":["type","cardId","amount"],"properties":{"type":{"description":"Always `SimCmdCardRefund`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SimCmdCardRefund"]},"cardId":{"$ref":"#/components/schemas/CardId","description":"The card refunded, by its Bezel id."},"amount":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"An amount in minor current units of a given currency."}}},"SimCmdDispute":{"title":"SimCmdDispute","description":"Raise a dispute against a transaction, as the scheme would.","examples":[{"type":"SimCmdDispute","transactionId":"tran_9f2Kd8QpLzXw","disputeAmount":1250}],"type":"object","required":["type","transactionId"],"properties":{"type":{"description":"Always `SimCmdDispute`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SimCmdDispute"]},"transactionId":{"$ref":"#/components/schemas/TranId","description":"The transaction disputed. It has to have been charged: a dispute is against a charge."},"disputeAmount":{"description":"The amount disputed, in minor units. Defaults to the whole transaction.","type":"integer","format":"int64"}}},"SimCmdIssuerMessage":{"title":"SimCmdIssuerMessage","description":"Replay a scheme message as though it had just arrived. The message is the channel's own shape, not this platform's.","examples":[{"type":"SimCmdIssuerMessage","channel":"Controlpay","message":{}}],"type":"object","required":["type","channel","message"],"properties":{"type":{"description":"Always `SimCmdIssuerMessage`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SimCmdIssuerMessage"]},"channel":{"$ref":"#/components/schemas/SimIssuerChannel"},"message":{"description":"The message, verbatim, in the channel's own shape."}}},"SimCmdIssuerMessageProcessing":{"title":"SimCmdIssuerMessageProcessing","description":"Process the queued scheme messages now, as the cron would.","examples":[{"type":"SimCmdIssuerMessageProcessing"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `SimCmdIssuerMessageProcessing`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SimCmdIssuerMessageProcessing"]}}},"SimCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/SimCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"SimCreateRspAttributes":"#/components/schemas/SimCreateRspAttributes"}}},"SimCreateRspAttributes":{"title":"SimCreateRspAttributes","examples":[{"type":"SimCreateRspAttributes","created":{"type":"SimViewCardAuthorised","transactionReference":"your-own-reference","authorisationId":"abc123","succeeded":true,"message":"example"}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `SimCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SimCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/SimView"}}},"SimIssuerChannel":{"title":"SimIssuerChannel","description":"Which of the scheme's two inbound channels the message arrived on.","type":"string","enum":["Controlpay","Webhook","Unknown"]},"SimView":{"description":"The resource that was created.","oneOf":[{"$ref":"#/components/schemas/SimViewCardAuthorised"},{"$ref":"#/components/schemas/SimViewCardCleared"},{"$ref":"#/components/schemas/SimViewCardRefunded"},{"$ref":"#/components/schemas/SimViewDisputeRaised"},{"$ref":"#/components/schemas/SimViewIssuerMessageProcessed"}],"discriminator":{"propertyName":"type","mapping":{"SimViewCardAuthorised":"#/components/schemas/SimViewCardAuthorised","SimViewCardCleared":"#/components/schemas/SimViewCardCleared","SimViewCardRefunded":"#/components/schemas/SimViewCardRefunded","SimViewDisputeRaised":"#/components/schemas/SimViewDisputeRaised","SimViewIssuerMessageProcessed":"#/components/schemas/SimViewIssuerMessageProcessed"}}},"SimViewCardAuthorised":{"title":"SimViewCardAuthorised","description":"The scheme authorised the purchase, or refused it.","examples":[{"type":"SimViewCardAuthorised","transactionReference":"your-own-reference","authorisationId":"abc123","succeeded":true,"message":"example"}],"type":"object","required":["type","transactionReference","succeeded"],"properties":{"type":{"description":"Always `SimViewCardAuthorised`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SimViewCardAuthorised"]},"transactionReference":{"description":"The reference the scheme quoted.","type":"string"},"authorisationId":{"description":"Present when the authorisation succeeded. Pass it to `SimCmdCardClearing`.","type":"string"},"succeeded":{"type":"boolean"},"message":{"description":"The scheme's own words where it refused.","type":"string"}}},"SimViewCardCleared":{"title":"SimViewCardCleared","description":"The scheme cleared the authorisation, or refused to.","examples":[{"type":"SimViewCardCleared","succeeded":true,"message":"example"}],"type":"object","required":["type","succeeded"],"properties":{"type":{"description":"Always `SimViewCardCleared`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SimViewCardCleared"]},"succeeded":{"type":"boolean"},"message":{"type":"string"}}},"SimViewCardRefunded":{"title":"SimViewCardRefunded","description":"The platform sent the refund to itself as the scheme would have.","examples":[{"type":"SimViewCardRefunded"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `SimViewCardRefunded`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SimViewCardRefunded"]}}},"SimViewDisputeRaised":{"title":"SimViewDisputeRaised","description":"The dispute that was raised.","examples":[{"type":"SimViewDisputeRaised","disputeId":"dispute_9f2Kd8QpLzXw"}],"type":"object","required":["type","disputeId"],"properties":{"type":{"description":"Always `SimViewDisputeRaised`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SimViewDisputeRaised"]},"disputeId":{"type":"string"}}},"SimViewIssuerMessageProcessed":{"title":"SimViewIssuerMessageProcessed","description":"The platform processed the message. What it made of it is in `/issuer-transactions`.","examples":[{"type":"SimViewIssuerMessageProcessed","outcome":{}}],"type":"object","required":["type","outcome"],"properties":{"type":{"description":"Always `SimViewIssuerMessageProcessed`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SimViewIssuerMessageProcessed"]},"outcome":{"description":"The channel's own answer, verbatim. Empty where the channel answers nothing."}}},"SjnlAction":{"oneOf":[{"$ref":"#/components/schemas/SjnlActionClear"},{"$ref":"#/components/schemas/SjnlActionOpen"}],"discriminator":{"propertyName":"type","mapping":{"SjnlActionClear":"#/components/schemas/SjnlActionClear","SjnlActionOpen":"#/components/schemas/SjnlActionOpen"}}},"SjnlActionClear":{"title":"SjnlActionClear","description":"Clear these merchants' journals, so their books can be rebuilt.","examples":[{"type":"SjnlActionClear","realtimeJournals":true}],"type":"object","required":["type","realtimeJournals"],"properties":{"type":{"description":"Always `SjnlActionClear`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SjnlActionClear"]},"realtimeJournals":{"description":"Clear the real-time journals rather than the standard ones. The two halves of a merchant's books clear separately.","type":"boolean"}}},"SjnlActionOpen":{"title":"SjnlActionOpen","description":"Open the journals and ledgers these merchants need, where they do not exist yet.","examples":[{"type":"SjnlActionOpen"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `SjnlActionOpen`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SjnlActionOpen"]}}},"SjnlBusinessKey":{"oneOf":[{"$ref":"#/components/schemas/SjnlBusinessKeyAttributes"}],"discriminator":{"propertyName":"type","mapping":{"SjnlBusinessKeyAttributes":"#/components/schemas/SjnlBusinessKeyAttributes"}}},"SjnlBusinessKeyAttributes":{"title":"SjnlBusinessKeyAttributes","description":"What identifies a journal or a ledger, five fields that only mean anything together.","examples":[{"type":"SjnlBusinessKeyAttributes","ownerType":"Merchant","ownerIdentifier":"example","category":"General","clearanceSystem":"example","currency":"AUD"}],"type":"object","required":["type","ownerType","ownerIdentifier","category","clearanceSystem","currency"],"properties":{"type":{"description":"Always `SjnlBusinessKeyAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SjnlBusinessKeyAttributes"]},"ownerType":{"$ref":"#/components/schemas/SjnlOwnerType","description":"What kind of party owns the funds."},"ownerIdentifier":{"description":"Which party of that kind. A merchant id, a loan id, or the platform's own name.","type":"string"},"category":{"$ref":"#/components/schemas/JnalCategory","description":"What the journal counts."},"clearanceSystem":{"description":"How the funds are cleared to the owner.","type":"string"},"currency":{"$ref":"#/components/schemas/IsoCurrency"}}},"SjnlCollectionUpdate":{"description":"Open or clear the journals of a set of merchants.","oneOf":[{"$ref":"#/components/schemas/SjnlCollectionUpdateAttributes"}],"discriminator":{"propertyName":"type","mapping":{"SjnlCollectionUpdateAttributes":"#/components/schemas/SjnlCollectionUpdateAttributes"}}},"SjnlCollectionUpdateAttributes":{"title":"SjnlCollectionUpdateAttributes","description":"Open or clear the journals of a set of merchants.","examples":[{"type":"SjnlCollectionUpdateAttributes","action":{"type":"SjnlActionClear","realtimeJournals":true},"merchantIds":["mcht_9f2Kd8QpLzXw"]}],"type":"object","required":["type","action"],"properties":{"type":{"description":"Always `SjnlCollectionUpdateAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SjnlCollectionUpdateAttributes"]},"action":{"$ref":"#/components/schemas/SjnlAction","description":"What to do to their books."},"merchantIds":{"description":"The merchants to act on. Omit to act on every merchant, which is what a full rebuild does.","type":"array","items":{"$ref":"#/components/schemas/MchtId","description":"Identifier of a merchant."}}}},"SjnlColumn":{"title":"SjnlColumn","type":"string","enum":["JournalId","BusinessKeyOwnerType","BusinessKeyOwnerIdentifier","BusinessKeyCategory","BusinessKeyClearanceSystem","BusinessKeyCurrency","SystemLedgerId","ClearanceTimeZone","LastClearanceDate","LastClearanceAt","OwnerName","CreatedAt","UpdatedAt"]},"SjnlId":{"title":"SjnlId","description":"Identifier of a system journal.","examples":["sjnl_9f2Kd8QpLzXw"],"type":"string"},"SjnlMaintenance":{"description":"What a bulk journal maintenance did. Not a journal, the platform's bulk operations answer with nothing, so this says what was asked and that it was done.","oneOf":[{"$ref":"#/components/schemas/SjnlMaintenanceAttributes"}],"discriminator":{"propertyName":"type","mapping":{"SjnlMaintenanceAttributes":"#/components/schemas/SjnlMaintenanceAttributes"}}},"SjnlMaintenanceAttributes":{"title":"SjnlMaintenanceAttributes","description":"What a bulk journal maintenance did. Not a journal, the platform's bulk operations answer with nothing, so this says what was asked and that it was done.","examples":[{"type":"SjnlMaintenanceAttributes","action":{"type":"SjnlActionClear","realtimeJournals":true},"merchantIds":["mcht_9f2Kd8QpLzXw"],"appliedToEveryMerchant":true}],"type":"object","required":["type","action","appliedToEveryMerchant"],"properties":{"type":{"description":"Always `SjnlMaintenanceAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SjnlMaintenanceAttributes"]},"action":{"$ref":"#/components/schemas/SjnlAction","description":"The maintenance that ran, echoed back."},"merchantIds":{"description":"The merchants it ran for, as sent. Empty when it ran for every merchant.","type":"array","items":{"$ref":"#/components/schemas/MchtId","description":"Identifier of a merchant."}},"appliedToEveryMerchant":{"description":"`true` when `merchantIds` was empty and the maintenance therefore ran for **every merchant on the platform**. Assert on this rather than on the list.","type":"boolean"}}},"SjnlOwnerType":{"title":"SjnlOwnerType","type":"string","enum":["Merchant","Loan","Unknown"]},"SjnlPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/SjnlPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"SjnlPageAttributes":"#/components/schemas/SjnlPageAttributes"}}},"SjnlPageAttributes":{"title":"SjnlPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"SjnlPageAttributes","data":[{"type":"SjnlViewAttributes","journalId":"sjnl_9f2Kd8QpLzXw","businessKey":{"type":"SjnlBusinessKeyAttributes","ownerType":"Merchant","ownerIdentifier":"example","category":"General","clearanceSystem":"example","currency":"AUD"},"systemLedgerId":"sldg_9f2Kd8QpLzXw","clearanceTimeZone":"example","lastClearanceDate":"2026-08-19","lastClearanceAt":"2026-08-19T04:21:07Z","ownerName":"Ada Lovelace","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `SjnlPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SjnlPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/SjnlView","description":"A journal, the platform's double-entry record of money moving."}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"SjnlSort":{"title":"SjnlSort","type":"string","enum":["createdAt","-createdAt","updatedAt","-updatedAt"]},"SjnlUpdate":{"oneOf":[{"$ref":"#/components/schemas/SjnlUpdateLinkLedger"},{"$ref":"#/components/schemas/SjnlUpdateRecordClearance"}],"discriminator":{"propertyName":"type","mapping":{"SjnlUpdateLinkLedger":"#/components/schemas/SjnlUpdateLinkLedger","SjnlUpdateRecordClearance":"#/components/schemas/SjnlUpdateRecordClearance"}}},"SjnlUpdateLinkLedger":{"title":"SjnlUpdateLinkLedger","description":"Link this journal to the ledger it clears into.","examples":[{"type":"SjnlUpdateLinkLedger","systemLedgerId":"sldg_9f2Kd8QpLzXw"}],"type":"object","required":["type","systemLedgerId"],"properties":{"type":{"description":"Always `SjnlUpdateLinkLedger`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SjnlUpdateLinkLedger"]},"systemLedgerId":{"$ref":"#/components/schemas/SldgId","description":"Identifier of a system ledger."}}},"SjnlUpdateRecordClearance":{"title":"SjnlUpdateRecordClearance","description":"Record a clearance into a ledger. Names the ledger, because a clearance is always into one.","examples":[{"type":"SjnlUpdateRecordClearance","systemLedgerId":"sldg_9f2Kd8QpLzXw","lastClearanceDate":"2026-08-19","lastClearanceAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","systemLedgerId","lastClearanceDate"],"properties":{"type":{"description":"Always `SjnlUpdateRecordClearance`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SjnlUpdateRecordClearance"]},"systemLedgerId":{"$ref":"#/components/schemas/SldgId","description":"Identifier of a system ledger."},"lastClearanceDate":{"description":"The date entries were cleared from this journal.","type":"string","format":"date"},"lastClearanceAt":{"description":"For journals that clear more often than daily, when the clearance happened.","type":"string","format":"date-time"}}},"SjnlUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/SjnlUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"SjnlUpdateRspAttributes":"#/components/schemas/SjnlUpdateRspAttributes"}}},"SjnlUpdateRspAttributes":{"title":"SjnlUpdateRspAttributes","examples":[{"type":"SjnlUpdateRspAttributes","updated":{"type":"SjnlViewAttributes","journalId":"sjnl_9f2Kd8QpLzXw","businessKey":{"type":"SjnlBusinessKeyAttributes","ownerType":"Merchant","ownerIdentifier":"example","category":"General","clearanceSystem":"example","currency":"AUD"},"systemLedgerId":"sldg_9f2Kd8QpLzXw","clearanceTimeZone":"example","lastClearanceDate":"2026-08-19","lastClearanceAt":"2026-08-19T04:21:07Z","ownerName":"Ada Lovelace","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `SjnlUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SjnlUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/SjnlView","description":"The resource as it stands after the change."}}},"SjnlView":{"oneOf":[{"$ref":"#/components/schemas/SjnlViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"SjnlViewAttributes":"#/components/schemas/SjnlViewAttributes"}}},"SjnlViewAttributes":{"title":"SjnlViewAttributes","description":"A journal, the platform's double-entry record of money moving.","examples":[{"type":"SjnlViewAttributes","journalId":"sjnl_9f2Kd8QpLzXw","businessKey":{"type":"SjnlBusinessKeyAttributes","ownerType":"Merchant","ownerIdentifier":"example","category":"General","clearanceSystem":"example","currency":"AUD"},"systemLedgerId":"sldg_9f2Kd8QpLzXw","clearanceTimeZone":"example","lastClearanceDate":"2026-08-19","lastClearanceAt":"2026-08-19T04:21:07Z","ownerName":"Ada Lovelace","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","journalId","businessKey","clearanceTimeZone","createdAt","updatedAt"],"properties":{"type":{"description":"Always `SjnlViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SjnlViewAttributes"]},"journalId":{"$ref":"#/components/schemas/SjnlId"},"businessKey":{"$ref":"#/components/schemas/SjnlBusinessKey","description":"What identifies this journal. Five fields that only mean anything together."},"systemLedgerId":{"$ref":"#/components/schemas/SldgId","description":"The ledger this journal contributes to, set the first time it is cleared."},"clearanceTimeZone":{"description":"IANA time zone the clearing date is measured in.","type":"string"},"lastClearanceDate":{"description":"The most recent date entries were cleared from this journal.","type":"string","format":"date"},"lastClearanceAt":{"description":"For journals that clear more often than daily, when the last clearance happened.","type":"string","format":"date-time"},"ownerName":{"description":"The name of the business whose funds this journal records.","type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"SldgClearance":{"oneOf":[{"$ref":"#/components/schemas/SldgClearanceAdjusted"},{"$ref":"#/components/schemas/SldgClearanceCleared"}],"discriminator":{"propertyName":"type","mapping":{"SldgClearanceAdjusted":"#/components/schemas/SldgClearanceAdjusted","SldgClearanceCleared":"#/components/schemas/SldgClearanceCleared"}}},"SldgClearanceAdjusted":{"title":"SldgClearanceAdjusted","description":"The loan's ledger after the adjustment or correction, and the balance it now stands at.","examples":[{"type":"SldgClearanceAdjusted","ledger":{"type":"SldgViewAttributes","ledgerId":"sldg_9f2Kd8QpLzXw","businessKey":{"type":"SjnlBusinessKeyAttributes","ownerType":"Merchant","ownerIdentifier":"example","category":"General","clearanceSystem":"example","currency":"AUD"},"ledgerName":"Ada Lovelace","lastClearanceDate":"2026-08-19","lastLedgerSequence":1250,"lastClearanceAutomated":true,"latestEntry":{"type":"SldgEntryAttributes","sequence":1250,"currency":"AUD","balance":1250,"createdAt":"2026-08-19T04:21:07Z"},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"},"balance":1250}],"type":"object","required":["type","ledger"],"properties":{"type":{"description":"Always `SldgClearanceAdjusted`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SldgClearanceAdjusted"]},"ledger":{"$ref":"#/components/schemas/SldgView","description":"A ledger, where a journal's cleared entries land."},"balance":{"$ref":"#/components/schemas/MinorUnits","description":"The balance after the adjustment or correction. Absent where the ledger has no entries, which either should have just fixed."}}},"SldgClearanceCleared":{"title":"SldgClearanceCleared","description":"What a bulk ledger clearance did. Not a ledger, the platform's bulk operations answer with nothing.","examples":[{"type":"SldgClearanceCleared","owners":{"type":"SldgOwnersLoans","loanIds":["loan_9f2Kd8QpLzXw"]},"appliedToEveryOwner":true}],"type":"object","required":["type","owners","appliedToEveryOwner"],"properties":{"type":{"description":"Always `SldgClearanceCleared`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SldgClearanceCleared"]},"owners":{"$ref":"#/components/schemas/SldgOwners","description":"Whose ledgers were cleared, echoed back."},"appliedToEveryOwner":{"description":"`true` when the list was empty and the clearance therefore ran for **every** owner of that kind. Assert on this.","type":"boolean"}}},"SldgCollectionUpdate":{"oneOf":[{"$ref":"#/components/schemas/SldgCollectionUpdateAdjustLoanBalance"},{"$ref":"#/components/schemas/SldgCollectionUpdateClear"},{"$ref":"#/components/schemas/SldgCollectionUpdateCorrectLoanLedger"}],"discriminator":{"propertyName":"type","mapping":{"SldgCollectionUpdateAdjustLoanBalance":"#/components/schemas/SldgCollectionUpdateAdjustLoanBalance","SldgCollectionUpdateClear":"#/components/schemas/SldgCollectionUpdateClear","SldgCollectionUpdateCorrectLoanLedger":"#/components/schemas/SldgCollectionUpdateCorrectLoanLedger"}}},"SldgCollectionUpdateAdjustLoanBalance":{"title":"SldgCollectionUpdateAdjustLoanBalance","description":"Correct a loan's balance by hand. A bug-fixing tool: the adjustment is reserved against the loan's limits at once and is billed as a manual adjustment on the customer's next statement.","examples":[{"type":"SldgCollectionUpdateAdjustLoanBalance","loanId":"loan_9f2Kd8QpLzXw","adjustment":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"reason":"Requested by the customer."}],"type":"object","required":["type","loanId","adjustment","reason"],"properties":{"type":{"description":"Always `SldgCollectionUpdateAdjustLoanBalance`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SldgCollectionUpdateAdjustLoanBalance"]},"loanId":{"$ref":"#/components/schemas/LoanId","description":"Identifier of a loan."},"adjustment":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"Positive increases what the customer owes, negative decreases it. Zero is refused, and the currency must be the loan's."},"reason":{"description":"Why. This lands on the ledger entry and is the only record of the reason.","type":"string"}}},"SldgCollectionUpdateClear":{"title":"SldgCollectionUpdateClear","description":"Clear the ledgers of a set of owners.","examples":[{"type":"SldgCollectionUpdateClear","owners":{"type":"SldgOwnersLoans","loanIds":["loan_9f2Kd8QpLzXw"]}}],"type":"object","required":["type","owners"],"properties":{"type":{"description":"Always `SldgCollectionUpdateClear`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SldgCollectionUpdateClear"]},"owners":{"$ref":"#/components/schemas/SldgOwners","description":"Whose ledgers to clear."}}},"SldgCollectionUpdateCorrectLoanLedger":{"title":"SldgCollectionUpdateCorrectLoanLedger","description":"Correct a loan's balance on its ledgers alone, where a mistaken entry has moved it away from what the customer's issued statements say they owe. The loan's used and available balances, and the available balances of its master agreement and facility, change at once. The correction is never billed: it appears on no statement and does not change the next statement's period. Platform only.","examples":[{"type":"SldgCollectionUpdateCorrectLoanLedger","loanId":"loan_9f2Kd8QpLzXw","correction":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"reason":"Requested by the customer."}],"type":"object","required":["type","loanId","correction","reason"],"properties":{"type":{"description":"Always `SldgCollectionUpdateCorrectLoanLedger`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SldgCollectionUpdateCorrectLoanLedger"]},"loanId":{"$ref":"#/components/schemas/LoanId","description":"Identifier of a loan."},"correction":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"Positive increases what the customer owes, negative decreases it. Zero is refused, and the currency must be the loan's."},"reason":{"description":"Why. This lands on every ledger entry the correction adds and is the only record of the reason.","type":"string"}}},"SldgEntry":{"description":"The most recent entry, which is where the balance is. Absent on a ledger with no entries.","oneOf":[{"$ref":"#/components/schemas/SldgEntryAttributes"}],"discriminator":{"propertyName":"type","mapping":{"SldgEntryAttributes":"#/components/schemas/SldgEntryAttributes"}}},"SldgEntryAttributes":{"title":"SldgEntryAttributes","description":"A cleared movement on a ledger, and the running balance after it.","examples":[{"type":"SldgEntryAttributes","sequence":1250,"currency":"AUD","balance":1250,"createdAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","sequence","currency","balance","createdAt"],"properties":{"type":{"description":"Always `SldgEntryAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SldgEntryAttributes"]},"sequence":{"description":"The sequence number of this entry. Entries are numbered per ledger.","type":"integer","format":"int64"},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"balance":{"$ref":"#/components/schemas/MinorUnits","description":"The balance after this entry."},"createdAt":{"type":"string","format":"date-time"}}},"SldgId":{"title":"SldgId","examples":["sldg_9f2Kd8QpLzXw"],"type":"string"},"SldgOwners":{"oneOf":[{"$ref":"#/components/schemas/SldgOwnersLoans"},{"$ref":"#/components/schemas/SldgOwnersMerchants"}],"discriminator":{"propertyName":"type","mapping":{"SldgOwnersLoans":"#/components/schemas/SldgOwnersLoans","SldgOwnersMerchants":"#/components/schemas/SldgOwnersMerchants"}}},"SldgOwnersLoans":{"title":"SldgOwnersLoans","description":"Clear these loans' ledgers. Omit the list to clear every loan's.","examples":[{"type":"SldgOwnersLoans","loanIds":["loan_9f2Kd8QpLzXw"]}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `SldgOwnersLoans`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SldgOwnersLoans"]},"loanIds":{"type":"array","items":{"$ref":"#/components/schemas/LoanId","description":"Identifier of a loan."}}}},"SldgOwnersMerchants":{"title":"SldgOwnersMerchants","description":"Clear these merchants' ledgers. Omit the list to clear every merchant's.","examples":[{"type":"SldgOwnersMerchants","merchantIds":["mcht_9f2Kd8QpLzXw"]}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `SldgOwnersMerchants`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SldgOwnersMerchants"]},"merchantIds":{"type":"array","items":{"$ref":"#/components/schemas/MchtId","description":"Identifier of a merchant."}}}},"SldgUpdate":{"description":"Recount a ledger from a point in time.","oneOf":[{"$ref":"#/components/schemas/SldgUpdateRecount"}],"discriminator":{"propertyName":"type","mapping":{"SldgUpdateRecount":"#/components/schemas/SldgUpdateRecount"}}},"SldgUpdateRecount":{"title":"SldgUpdateRecount","description":"Recount a ledger from a point in time.","examples":[{"type":"SldgUpdateRecount","recountFrom":"2026-08-19T04:21:07Z","initialBalance":1250}],"type":"object","required":["type","recountFrom"],"properties":{"type":{"description":"Always `SldgUpdateRecount`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SldgUpdateRecount"]},"recountFrom":{"description":"Recount from this instant, including every entry at or after it. Edge's `ResetLedgerStartPoint`.","type":"string","format":"date-time"},"initialBalance":{"$ref":"#/components/schemas/MinorUnits","description":"The balance to start the recount from. Omit to start from nothing."}}},"SldgUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/SldgUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"SldgUpdateRspAttributes":"#/components/schemas/SldgUpdateRspAttributes"}}},"SldgUpdateRspAttributes":{"title":"SldgUpdateRspAttributes","examples":[{"type":"SldgUpdateRspAttributes","updated":{"type":"SldgViewAttributes","ledgerId":"sldg_9f2Kd8QpLzXw","businessKey":{"type":"SjnlBusinessKeyAttributes","ownerType":"Merchant","ownerIdentifier":"example","category":"General","clearanceSystem":"example","currency":"AUD"},"ledgerName":"Ada Lovelace","lastClearanceDate":"2026-08-19","lastLedgerSequence":1250,"lastClearanceAutomated":true,"latestEntry":{"type":"SldgEntryAttributes","sequence":1250,"currency":"AUD","balance":1250,"createdAt":"2026-08-19T04:21:07Z"},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `SldgUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SldgUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/SldgView","description":"The resource as it stands after the change."}}},"SldgView":{"oneOf":[{"$ref":"#/components/schemas/SldgViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"SldgViewAttributes":"#/components/schemas/SldgViewAttributes"}}},"SldgViewAttributes":{"title":"SldgViewAttributes","description":"A ledger, where a journal's cleared entries land.","examples":[{"type":"SldgViewAttributes","ledgerId":"sldg_9f2Kd8QpLzXw","businessKey":{"type":"SjnlBusinessKeyAttributes","ownerType":"Merchant","ownerIdentifier":"example","category":"General","clearanceSystem":"example","currency":"AUD"},"ledgerName":"Ada Lovelace","lastClearanceDate":"2026-08-19","lastLedgerSequence":1250,"lastClearanceAutomated":true,"latestEntry":{"type":"SldgEntryAttributes","sequence":1250,"currency":"AUD","balance":1250,"createdAt":"2026-08-19T04:21:07Z"},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","ledgerId","businessKey","ledgerName","createdAt","updatedAt"],"properties":{"type":{"description":"Always `SldgViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SldgViewAttributes"]},"ledgerId":{"$ref":"#/components/schemas/SldgId","description":"Identifier of a system ledger."},"businessKey":{"$ref":"#/components/schemas/SjnlBusinessKey","description":"What identifies this ledger. The same five fields a journal has, and the journal with the same key clears into it."},"ledgerName":{"description":"A human-readable description of what this ledger counts.","type":"string"},"lastClearanceDate":{"description":"The last date funds were disbursed or invoiced from this ledger to its owner.","type":"string","format":"date"},"lastLedgerSequence":{"description":"The sequence number of the last entry cleared, by a payout, an invoice or a loan statement.","type":"integer","format":"int64"},"lastClearanceAutomated":{"description":"Whether the last clearance was automated. `false` means someone did it by hand.","type":"boolean"},"latestEntry":{"$ref":"#/components/schemas/SldgEntry"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"SlinBilling":{"description":"What a line adds to its statement, in the statement's own currency. All are in the single currency given here.","oneOf":[{"$ref":"#/components/schemas/SlinBillingAttributes"}],"discriminator":{"propertyName":"type","mapping":{"SlinBillingAttributes":"#/components/schemas/SlinBillingAttributes"}}},"SlinBillingAttributes":{"title":"SlinBillingAttributes","description":"What a line adds to its statement, in the statement's own currency. All are in the single currency given here.","examples":[{"type":"SlinBillingAttributes","currency":"AUD","netAmount":1250,"taxAmount":1250,"grossAmount":1250,"taxRate":"0.9412","taxType":"example"}],"type":"object","required":["type","currency","netAmount","taxAmount","grossAmount"],"properties":{"type":{"description":"Always `SlinBillingAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SlinBillingAttributes"]},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"netAmount":{"$ref":"#/components/schemas/MinorUnits","description":"Before tax."},"taxAmount":{"$ref":"#/components/schemas/MinorUnits","description":"An amount in the minor units of the currency given by the enclosing object's `currency` field."},"grossAmount":{"$ref":"#/components/schemas/MinorUnits","description":"What the line adds to the statement: negative for a refund."},"taxRate":{"description":"The tax rate as a decimal string, `0.1` for ten per cent, where the line has one.","type":"string"},"taxType":{"type":"string"}}},"SlinCardType":{"title":"SlinCardType","type":"string","enum":["Uatp","MasterCard","Unknown"]},"SlinColumn":{"title":"SlinColumn","type":"string","enum":["LoanStatementId","ReferenceStatementId","StatementCreatedAt","LoanId","LoanAccountName","ReferenceLoanId","CustomerId","CustomerName","Kind","EntryId","Description","PostedAt","IssuerTransactionId","TransactionId","GalaxyTransactionId","FinancialTransactionId","ApprovalCode","OpenLoop","CardType","BillingCurrency","BillingNetAmount","BillingTaxAmount","BillingGrossAmount","BillingTaxRate","BillingTaxType","SalesCurrency","SalesNetAmount","SalesTaxAmount","SalesGrossAmount","SalesExchangeRate","ServiceType","TicketNumber","TravellerName","Routing","BookingClass","AirlineCode","SalesDate","TravelDate","MerchantName","MerchantCategoryCode","AgencyDeliveryNoteNumber","SupplierIataNumber","DbiPk","DbiDs","DbiKs","DbiAe","DbiIk","DbiBd","DbiPr","DbiAu","DbiAk","DbiRz"]},"SlinDbi":{"description":"The ten references a line carries for data-based invoicing. A field the line left blank is absent.","oneOf":[{"$ref":"#/components/schemas/SlinDbiAttributes"}],"discriminator":{"propertyName":"type","mapping":{"SlinDbiAttributes":"#/components/schemas/SlinDbiAttributes"}}},"SlinDbiAttributes":{"title":"SlinDbiAttributes","description":"The ten references a line carries for data-based invoicing. A field the line left blank is absent.","examples":[{"type":"SlinDbiAttributes","pk":"example","ds":"example","ks":"example","ae":"example","ik":"example","bd":"example","pr":"example","au":"example","ak":"example","rz":"example"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `SlinDbiAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SlinDbiAttributes"]},"pk":{"type":"string"},"ds":{"type":"string"},"ks":{"type":"string"},"ae":{"type":"string"},"ik":{"type":"string"},"bd":{"type":"string"},"pr":{"type":"string"},"au":{"type":"string"},"ak":{"type":"string"},"rz":{"type":"string"}}},"SlinDbiField":{"title":"SlinDbiField","type":"string","enum":["Pk","Ds","Ks","Ae","Ik","Bd","Pr","Au","Ak","Rz"]},"SlinKind":{"title":"SlinKind","type":"string","enum":["Charge","Refund","Dispute","Adjustment","RefundAdjustment","Manual","StandaloneFee","Unknown"]},"SlinPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/SlinPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"SlinPageAttributes":"#/components/schemas/SlinPageAttributes"}}},"SlinPageAttributes":{"title":"SlinPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"SlinPageAttributes","data":[{"type":"SlinViewAttributes","loanStatementId":"lstmt_9f2Kd8QpLzXw","referenceStatementId":"your-own-reference","statementCreatedAt":"2026-08-19T04:21:07Z","loanId":"loan_9f2Kd8QpLzXw","loanAccountName":"Ada Lovelace","referenceLoanId":"your-own-reference","customerId":"cust_9f2Kd8QpLzXw","customerName":"Ada Lovelace","kind":"Charge","entryId":"abc123","description":"A short description.","postedAt":"2026-08-19T04:21:07Z","issuerTransactionId":"itxn_9f2Kd8QpLzXw","transactionId":"tran_9f2Kd8QpLzXw","galaxyTransactionId":"tran_9f2Kd8QpLzXw","financialTransactionId":"tran_9f2Kd8QpLzXw","approvalCode":"example","openLoop":true,"cardType":"Uatp","billing":{"type":"SlinBillingAttributes","currency":"AUD","netAmount":1250,"taxAmount":1250,"grossAmount":1250,"taxRate":"0.9412","taxType":"example"},"sales":{"type":"SlinSalesAttributes","currency":"AUD","netAmount":1250,"taxAmount":1250,"grossAmount":1250,"exchangeRate":"0.9412"},"serviceType":"Flight","ticketNumber":"example","travellerName":"Ada Lovelace","routing":"example","bookingClass":"example","airlineCode":"example","salesDate":"2026-08-19","travelDate":"2026-08-19","merchantName":"Ada Lovelace","merchantCategoryCode":"example","agencyDeliveryNoteNumber":"example","supplierIataNumber":"example","serviceLines":["example"],"dbi":{"type":"SlinDbiAttributes","pk":"example","ds":"example","ks":"example","ae":"example","ik":"example","bd":"example","pr":"example","au":"example","ak":"example","rz":"example"}}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `SlinPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SlinPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/SlinView"}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"SlinSales":{"description":"The line in the currency the sale was made in, where that is not the statement's. All are in the single currency given here.","oneOf":[{"$ref":"#/components/schemas/SlinSalesAttributes"}],"discriminator":{"propertyName":"type","mapping":{"SlinSalesAttributes":"#/components/schemas/SlinSalesAttributes"}}},"SlinSalesAttributes":{"title":"SlinSalesAttributes","description":"The line in the currency the sale was made in, where that is not the statement's. All are in the single currency given here.","examples":[{"type":"SlinSalesAttributes","currency":"AUD","netAmount":1250,"taxAmount":1250,"grossAmount":1250,"exchangeRate":"0.9412"}],"type":"object","required":["type","currency","netAmount","taxAmount","grossAmount","exchangeRate"],"properties":{"type":{"description":"Always `SlinSalesAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SlinSalesAttributes"]},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"netAmount":{"$ref":"#/components/schemas/MinorUnits","description":"An amount in the minor units of the currency given by the enclosing object's `currency` field."},"taxAmount":{"$ref":"#/components/schemas/MinorUnits","description":"An amount in the minor units of the currency given by the enclosing object's `currency` field."},"grossAmount":{"$ref":"#/components/schemas/MinorUnits","description":"An amount in the minor units of the currency given by the enclosing object's `currency` field."},"exchangeRate":{"description":"What the sales currency was converted at, as a decimal string.","type":"string"}}},"SlinServiceType":{"title":"SlinServiceType","type":"string","enum":["Flight","CarRental","Hotel","Rail","ServiceFee","OtherService","Cruise","Unknown"]},"SlinView":{"description":"One line of a loan statement, as the statement's own document draws it. A card number, its first digits, its expiry and its holder's name are never published, and nor is a bank account.","oneOf":[{"$ref":"#/components/schemas/SlinViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"SlinViewAttributes":"#/components/schemas/SlinViewAttributes"}}},"SlinViewAttributes":{"title":"SlinViewAttributes","description":"One line of a loan statement, as the statement's own document draws it. A card number, its first digits, its expiry and its holder's name are never published, and nor is a bank account.","examples":[{"type":"SlinViewAttributes","loanStatementId":"lstmt_9f2Kd8QpLzXw","referenceStatementId":"your-own-reference","statementCreatedAt":"2026-08-19T04:21:07Z","loanId":"loan_9f2Kd8QpLzXw","loanAccountName":"Ada Lovelace","referenceLoanId":"your-own-reference","customerId":"cust_9f2Kd8QpLzXw","customerName":"Ada Lovelace","kind":"Charge","entryId":"abc123","description":"A short description.","postedAt":"2026-08-19T04:21:07Z","issuerTransactionId":"itxn_9f2Kd8QpLzXw","transactionId":"tran_9f2Kd8QpLzXw","galaxyTransactionId":"tran_9f2Kd8QpLzXw","financialTransactionId":"tran_9f2Kd8QpLzXw","approvalCode":"example","openLoop":true,"cardType":"Uatp","billing":{"type":"SlinBillingAttributes","currency":"AUD","netAmount":1250,"taxAmount":1250,"grossAmount":1250,"taxRate":"0.9412","taxType":"example"},"sales":{"type":"SlinSalesAttributes","currency":"AUD","netAmount":1250,"taxAmount":1250,"grossAmount":1250,"exchangeRate":"0.9412"},"serviceType":"Flight","ticketNumber":"example","travellerName":"Ada Lovelace","routing":"example","bookingClass":"example","airlineCode":"example","salesDate":"2026-08-19","travelDate":"2026-08-19","merchantName":"Ada Lovelace","merchantCategoryCode":"example","agencyDeliveryNoteNumber":"example","supplierIataNumber":"example","serviceLines":["example"],"dbi":{"type":"SlinDbiAttributes","pk":"example","ds":"example","ks":"example","ae":"example","ik":"example","bd":"example","pr":"example","au":"example","ak":"example","rz":"example"}}],"type":"object","required":["type","loanStatementId","referenceStatementId","statementCreatedAt","loanId","loanAccountName","kind","description","postedAt","billing","sales","serviceType","dbi"],"properties":{"type":{"description":"Always `SlinViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SlinViewAttributes"]},"loanStatementId":{"$ref":"#/components/schemas/LstmtId","description":"The statement the line is on. Read it at `/loan-statements/{loanStatementId}`."},"referenceStatementId":{"description":"The statement's number as its document states it.","type":"string"},"statementCreatedAt":{"description":"When the statement was made.","type":"string","format":"date-time"},"loanId":{"$ref":"#/components/schemas/LoanId","description":"Identifier of a loan."},"loanAccountName":{"description":"The loan's name as its statements print it.","type":"string"},"referenceLoanId":{"description":"The id the loan has in the system that originated it, which a statement prints as the account number.","type":"string"},"customerId":{"$ref":"#/components/schemas/CustId","description":"Identifier of a customer."},"customerName":{"type":"string"},"kind":{"$ref":"#/components/schemas/SlinKind"},"entryId":{"description":"The identifier of what the line is: the charge (`chrg_`), refund (`rfnd_`), dispute or exception it settles. Absent for a manual entry or a fee.","type":"string"},"description":{"type":"string"},"postedAt":{"description":"When the line was recorded.","type":"string","format":"date-time"},"issuerTransactionId":{"$ref":"#/components/schemas/ItxnId","description":"The card transaction the line is for. Reverse it at `GET /apg-numbers?kind=IssuerTransaction` for the number APG gave it, and read it at `/issuer-transactions/{id}`."},"transactionId":{"description":"The transaction the card transaction is linked to, which for an ordinary one is itself.","type":"string"},"galaxyTransactionId":{"description":"The order's reference with the travel provider.","type":"string"},"financialTransactionId":{"description":"The order's transaction reference on a closed-loop account, and the card transaction's own identifier on an open-loop one.","type":"string"},"approvalCode":{"type":"string"},"openLoop":{"description":"Whether the card is an open-loop card (a virtual card) rather than a closed-loop company account. Absent for a line with no card transaction.","type":"boolean"},"cardType":{"$ref":"#/components/schemas/SlinCardType"},"billing":{"$ref":"#/components/schemas/SlinBilling"},"sales":{"$ref":"#/components/schemas/SlinSales"},"serviceType":{"$ref":"#/components/schemas/SlinServiceType"},"ticketNumber":{"description":"The ticket or document number as it was stored.","type":"string"},"travellerName":{"type":"string"},"routing":{"type":"string"},"bookingClass":{"type":"string"},"airlineCode":{"type":"string"},"salesDate":{"type":"string","format":"date"},"travelDate":{"type":"string","format":"date"},"merchantName":{"description":"The merchant that took the payment.","type":"string"},"merchantCategoryCode":{"type":"string"},"agencyDeliveryNoteNumber":{"type":"string"},"supplierIataNumber":{"type":"string"},"serviceLines":{"description":"The up to three lines of description the statement prints for the service.","type":"array","items":{"type":"string"}},"dbi":{"$ref":"#/components/schemas/SlinDbi"}}},"SrbatColumn":{"title":"SrbatColumn","type":"string","enum":["StatementReceiptBatchId","RequestReference","BankChannelName","FileName","TransactionCount","TransactionAmountMinorCurrencyUnits","TransactionAmountCurrency","BankProcessDate","FileGenerateStatus","FileDealStatus","BankReference","PaymentMethod","Remark","ErrorMessage","CreatedAt","UpdatedAt"]},"SrbatFileStatus":{"title":"SrbatFileStatus","type":"string","enum":["Waiting","Processing","Successful","Failed","Unknown"]},"SrbatId":{"title":"SrbatId","examples":["srbat_9f2Kd8QpLzXw"],"type":"string"},"SrbatPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/SrbatPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"SrbatPageAttributes":"#/components/schemas/SrbatPageAttributes"}}},"SrbatPageAttributes":{"title":"SrbatPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"SrbatPageAttributes","data":[{"type":"SrbatViewAttributes","statementReceiptBatchId":"srbat_9f2Kd8QpLzXw","requestReference":"your-own-reference","bankChannelName":"Ada Lovelace","fileName":"Ada Lovelace","transactionCount":42,"transactionAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"bankProcessDate":"2026-08-19T04:21:07Z","fileGenerateStatus":"Waiting","fileDealStatus":"Waiting","bankReference":"your-own-reference","paymentMethod":"example","remark":"example","errorMessage":"example","receipts":[{"type":"SrcptViewAttributes","statementReceiptId":"srcpt_9f2Kd8QpLzXw","requestReference":"your-own-reference","loanStatementId":"lstmt_9f2Kd8QpLzXw","statementReceiptBatchId":"srbat_9f2Kd8QpLzXw","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"status":"Waiting","acknowledgement":"Waiting","receivedAt":"2026-08-19T04:21:07Z","remark":"example","errorMessage":"example","uploadFilePaths":["example"],"paymentMethod":"example","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `SrbatPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SrbatPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/SrbatView","description":"A bank direct-entry batch of receipts: the file sent to the bank, and the bank's answer. The accounts it moves money between are not published."}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"SrbatSort":{"title":"SrbatSort","type":"string","enum":["createdAt","-createdAt","updatedAt","-updatedAt"]},"SrbatUpdate":{"oneOf":[{"$ref":"#/components/schemas/SrbatUpdateSettle"}],"discriminator":{"propertyName":"type","mapping":{"SrbatUpdateSettle":"#/components/schemas/SrbatUpdateSettle"}}},"SrbatUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/SrbatUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"SrbatUpdateRspAttributes":"#/components/schemas/SrbatUpdateRspAttributes"}}},"SrbatUpdateRspAttributes":{"title":"SrbatUpdateRspAttributes","examples":[{"type":"SrbatUpdateRspAttributes","updated":{"type":"SrbatViewAttributes","statementReceiptBatchId":"srbat_9f2Kd8QpLzXw","requestReference":"your-own-reference","bankChannelName":"Ada Lovelace","fileName":"Ada Lovelace","transactionCount":42,"transactionAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"bankProcessDate":"2026-08-19T04:21:07Z","fileGenerateStatus":"Waiting","fileDealStatus":"Waiting","bankReference":"your-own-reference","paymentMethod":"example","remark":"example","errorMessage":"example","receipts":[{"type":"SrcptViewAttributes","statementReceiptId":"srcpt_9f2Kd8QpLzXw","requestReference":"your-own-reference","loanStatementId":"lstmt_9f2Kd8QpLzXw","statementReceiptBatchId":"srbat_9f2Kd8QpLzXw","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"status":"Waiting","acknowledgement":"Waiting","receivedAt":"2026-08-19T04:21:07Z","remark":"example","errorMessage":"example","uploadFilePaths":["example"],"paymentMethod":"example","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `SrbatUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SrbatUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/SrbatView","description":"The resource as it stands after the change."}}},"SrbatUpdateSettle":{"title":"SrbatUpdateSettle","description":"Tell the platform the bank has accepted the batch's file: its receipts are marked received and each is applied to its statement. Staff only: a batch spans statements.","examples":[{"type":"SrbatUpdateSettle"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `SrbatUpdateSettle`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SrbatUpdateSettle"]}}},"SrbatView":{"oneOf":[{"$ref":"#/components/schemas/SrbatViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"SrbatViewAttributes":"#/components/schemas/SrbatViewAttributes"}}},"SrbatViewAttributes":{"title":"SrbatViewAttributes","description":"A bank direct-entry batch of receipts: the file sent to the bank, and the bank's answer. The accounts it moves money between are not published.","examples":[{"type":"SrbatViewAttributes","statementReceiptBatchId":"srbat_9f2Kd8QpLzXw","requestReference":"your-own-reference","bankChannelName":"Ada Lovelace","fileName":"Ada Lovelace","transactionCount":42,"transactionAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"bankProcessDate":"2026-08-19T04:21:07Z","fileGenerateStatus":"Waiting","fileDealStatus":"Waiting","bankReference":"your-own-reference","paymentMethod":"example","remark":"example","errorMessage":"example","receipts":[{"type":"SrcptViewAttributes","statementReceiptId":"srcpt_9f2Kd8QpLzXw","requestReference":"your-own-reference","loanStatementId":"lstmt_9f2Kd8QpLzXw","statementReceiptBatchId":"srbat_9f2Kd8QpLzXw","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"status":"Waiting","acknowledgement":"Waiting","receivedAt":"2026-08-19T04:21:07Z","remark":"example","errorMessage":"example","uploadFilePaths":["example"],"paymentMethod":"example","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","statementReceiptBatchId","requestReference","transactionCount","transactionAmount","fileGenerateStatus","fileDealStatus","createdAt","updatedAt"],"properties":{"type":{"description":"Always `SrbatViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SrbatViewAttributes"]},"statementReceiptBatchId":{"$ref":"#/components/schemas/SrbatId","description":"Identifier of a bank direct-entry batch of receipts."},"requestReference":{"type":"string"},"bankChannelName":{"type":"string"},"fileName":{"type":"string"},"transactionCount":{"description":"How many receipts the batch carries.","type":"integer","format":"int32"},"transactionAmount":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"What the batch's receipts add up to."},"bankProcessDate":{"type":"string","format":"date-time"},"fileGenerateStatus":{"$ref":"#/components/schemas/SrbatFileStatus","description":"Whether the file for the bank was written."},"fileDealStatus":{"$ref":"#/components/schemas/SrbatFileStatus","description":"Whether the bank accepted the file. Settle the batch once it has."},"bankReference":{"type":"string"},"paymentMethod":{"type":"string"},"remark":{"type":"string"},"errorMessage":{"type":"string"},"receipts":{"description":"The receipts the batch carries. Filled on a read of one batch, and empty in a list: read them at `/statement-receipts`.","type":"array","items":{"$ref":"#/components/schemas/SrcptView","description":"A payment received against a loan statement, with what the platform answered when told of it. The bank account it was paid from is not published."}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"SrchqAccountMethod":{"title":"SrchqAccountMethod","type":"string","enum":["DirectDebit","PayTo","BankTransfer","Unknown"]},"SrchqAmounts":{"description":"The figures in a surcharge quote. All are in the single currency given here.","oneOf":[{"$ref":"#/components/schemas/SrchqAmountsAttributes"}],"discriminator":{"propertyName":"type","mapping":{"SrchqAmountsAttributes":"#/components/schemas/SrchqAmountsAttributes"}}},"SrchqAmountsAttributes":{"title":"SrchqAmountsAttributes","description":"The figures in a surcharge quote. All are in the single currency given here.","examples":[{"type":"SrchqAmountsAttributes","currency":"AUD","amount":1250,"surcharge":1250,"total":1250}],"type":"object","required":["type","currency","amount","surcharge","total"],"properties":{"type":{"description":"Always `SrchqAmountsAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SrchqAmountsAttributes"]},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"amount":{"$ref":"#/components/schemas/MinorUnits","description":"The amount before any surcharge, what you asked about."},"surcharge":{"$ref":"#/components/schemas/MinorUnits","description":"The surcharge that would be added."},"total":{"$ref":"#/components/schemas/MinorUnits","description":"What the payer would actually be charged."}}},"SrchqCardAttributes":{"description":"The card attributes a surcharge is priced from.","oneOf":[{"$ref":"#/components/schemas/SrchqCardAttributesAttributes"}],"discriminator":{"propertyName":"type","mapping":{"SrchqCardAttributesAttributes":"#/components/schemas/SrchqCardAttributesAttributes"}}},"SrchqCardAttributesAttributes":{"title":"SrchqCardAttributesAttributes","description":"The card attributes a surcharge is priced from.","examples":[{"type":"SrchqCardAttributesAttributes","currency":"AUD","country":"AU","brand":"Visa","funding":"Credit","prepaid":true,"issuer":"example","bin":"424242","productType":"Consumer","schemeProduct":"MasterCardCrPer"}],"type":"object","required":["type","currency","country","brand","funding","prepaid","issuer"],"properties":{"type":{"description":"Always `SrchqCardAttributesAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SrchqCardAttributesAttributes"]},"currency":{"$ref":"#/components/schemas/IsoCurrency","description":"The currency the card is denominated in."},"country":{"$ref":"#/components/schemas/IsoCountry","description":"The country the card was issued in."},"brand":{"$ref":"#/components/schemas/CardBrand"},"funding":{"$ref":"#/components/schemas/CardFunding"},"prepaid":{"description":"Whether the card is on an anonymous prepaid programme. Not the same as `funding: Prepaid`, and it is priced differently.","type":"boolean"},"issuer":{"description":"The issuing bank, as the scheme names it.","type":"string"},"bin":{"description":"First six to eight digits, where you have them.","type":"string"},"productType":{"$ref":"#/components/schemas/CardProductType"},"schemeProduct":{"$ref":"#/components/schemas/CardSchemeProduct"}}},"SrchqCardPresentment":{"title":"SrchqCardPresentment","description":"Whether the card is presented directly or through a wallet. Wallets are priced separately.","type":"string","enum":["Card","ApplePay","GooglePay","Unknown"]},"SrchqCmd":{"oneOf":[{"$ref":"#/components/schemas/SrchqCmdForAccount"},{"$ref":"#/components/schemas/SrchqCmdForCard"},{"$ref":"#/components/schemas/SrchqCmdForSavedSource"}],"discriminator":{"propertyName":"type","mapping":{"SrchqCmdForAccount":"#/components/schemas/SrchqCmdForAccount","SrchqCmdForCard":"#/components/schemas/SrchqCmdForCard","SrchqCmdForSavedSource":"#/components/schemas/SrchqCmdForSavedSource"}}},"SrchqCmdForAccount":{"title":"SrchqCmdForAccount","description":"Ask what a payment would cost on a method that carries no card, direct debit, PayTo, or a bank transfer.","examples":[{"type":"SrchqCmdForAccount","merchantId":"mcht_9f2Kd8QpLzXw","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"method":"DirectDebit","form":{"type":"SrchqFormPayInFull"},"customerType":"Consumer"}],"type":"object","required":["type","merchantId","amount","method","form","customerType"],"properties":{"type":{"description":"Always `SrchqCmdForAccount`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SrchqCmdForAccount"]},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"Identifier of a merchant."},"amount":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"An amount in minor current units of a given currency."},"method":{"$ref":"#/components/schemas/SrchqAccountMethod"},"form":{"$ref":"#/components/schemas/SrchqForm"},"customerType":{"$ref":"#/components/schemas/SrchqCustomerType"}}},"SrchqCmdForCard":{"title":"SrchqCmdForCard","description":"Ask what a payment would cost on a card you know the attributes of.","examples":[{"type":"SrchqCmdForCard","merchantId":"mcht_9f2Kd8QpLzXw","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"card":{"type":"SrchqCardAttributesAttributes","currency":"AUD","country":"AU","brand":"Visa","funding":"Credit","prepaid":true,"issuer":"example","bin":"424242","productType":"Consumer","schemeProduct":"MasterCardCrPer"},"presentment":"Card","form":{"type":"SrchqFormPayInFull"},"customerType":"Consumer"}],"type":"object","required":["type","merchantId","amount","card","presentment","form","customerType"],"properties":{"type":{"description":"Always `SrchqCmdForCard`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SrchqCmdForCard"]},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"Identifier of a merchant."},"amount":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"An amount in minor current units of a given currency."},"card":{"$ref":"#/components/schemas/SrchqCardAttributes"},"presentment":{"$ref":"#/components/schemas/SrchqCardPresentment"},"form":{"$ref":"#/components/schemas/SrchqForm"},"customerType":{"$ref":"#/components/schemas/SrchqCustomerType"}}},"SrchqCmdForSavedSource":{"title":"SrchqCmdForSavedSource","description":"Ask what a payment would cost on a payment source already stored against a customer.","examples":[{"type":"SrchqCmdForSavedSource","merchantId":"mcht_9f2Kd8QpLzXw","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"sourceId":"psrc_9f2Kd8QpLzXw","form":{"type":"SrchqFormPayInFull"},"customerType":"Consumer"}],"type":"object","required":["type","merchantId","amount","sourceId","form","customerType"],"properties":{"type":{"description":"Always `SrchqCmdForSavedSource`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SrchqCmdForSavedSource"]},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"Identifier of a merchant."},"amount":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"An amount in minor current units of a given currency."},"sourceId":{"$ref":"#/components/schemas/PsrcId","description":"Identifier of a payment source."},"form":{"$ref":"#/components/schemas/SrchqForm","description":"Whether the payment is taken in full or over a plan. Surcharge rates differ."},"customerType":{"$ref":"#/components/schemas/SrchqCustomerType","description":"Whether the payer is a consumer or an organisation. Surcharge rates differ."}}},"SrchqCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/SrchqCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"SrchqCreateRspAttributes":"#/components/schemas/SrchqCreateRspAttributes"}}},"SrchqCreateRspAttributes":{"title":"SrchqCreateRspAttributes","examples":[{"type":"SrchqCreateRspAttributes","created":{"type":"SrchqViewAttributes","surchargeQuoteId":"srchq_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","amounts":{"type":"SrchqAmountsAttributes","currency":"AUD","amount":1250,"surcharge":1250,"total":1250},"summary":"example","method":{"type":"SrchqMethodApplePay","card":{"type":"SrchqCardAttributesAttributes","currency":"AUD","country":"AU","brand":"Visa","funding":"Credit","prepaid":true,"issuer":"example","bin":"424242","productType":"Consumer","schemeProduct":"MasterCardCrPer"}}}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `SrchqCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SrchqCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/SrchqView","description":"The resource that was created."}}},"SrchqCustomerType":{"title":"SrchqCustomerType","type":"string","enum":["Consumer","Organisation","Unknown"]},"SrchqForm":{"oneOf":[{"$ref":"#/components/schemas/SrchqFormPayInFull"},{"$ref":"#/components/schemas/SrchqFormPayPlan"}],"discriminator":{"propertyName":"type","mapping":{"SrchqFormPayInFull":"#/components/schemas/SrchqFormPayInFull","SrchqFormPayPlan":"#/components/schemas/SrchqFormPayPlan"}}},"SrchqFormPayInFull":{"title":"SrchqFormPayInFull","description":"Taken in full, once.","examples":[{"type":"SrchqFormPayInFull"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `SrchqFormPayInFull`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SrchqFormPayInFull"]}}},"SrchqFormPayPlan":{"title":"SrchqFormPayPlan","description":"Taken over a plan. The variant decides the schedule, and the rate.","examples":[{"type":"SrchqFormPayPlan","variant":"FourFortnightlyQuarters"}],"type":"object","required":["type","variant"],"properties":{"type":{"description":"Always `SrchqFormPayPlan`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SrchqFormPayPlan"]},"variant":{"$ref":"#/components/schemas/SrchqPayPlanVariant"}}},"SrchqId":{"title":"SrchqId","description":"The quote's identity and its signature. Send it back unchanged when you take the payment.","type":"string"},"SrchqMethod":{"description":"The payment method this quote is for. A quote is only valid for the method it was asked about.","oneOf":[{"$ref":"#/components/schemas/SrchqMethodApplePay"},{"$ref":"#/components/schemas/SrchqMethodBankTransfer"},{"$ref":"#/components/schemas/SrchqMethodCard"},{"$ref":"#/components/schemas/SrchqMethodDirectDebit"},{"$ref":"#/components/schemas/SrchqMethodGooglePay"},{"$ref":"#/components/schemas/SrchqMethodPayTo"},{"$ref":"#/components/schemas/SrchqMethodSavedSource"}],"discriminator":{"propertyName":"type","mapping":{"SrchqMethodApplePay":"#/components/schemas/SrchqMethodApplePay","SrchqMethodBankTransfer":"#/components/schemas/SrchqMethodBankTransfer","SrchqMethodCard":"#/components/schemas/SrchqMethodCard","SrchqMethodDirectDebit":"#/components/schemas/SrchqMethodDirectDebit","SrchqMethodGooglePay":"#/components/schemas/SrchqMethodGooglePay","SrchqMethodPayTo":"#/components/schemas/SrchqMethodPayTo","SrchqMethodSavedSource":"#/components/schemas/SrchqMethodSavedSource"}}},"SrchqMethodApplePay":{"title":"SrchqMethodApplePay","description":"Apple Pay, priced from the card behind it.","examples":[{"type":"SrchqMethodApplePay","card":{"type":"SrchqCardAttributesAttributes","currency":"AUD","country":"AU","brand":"Visa","funding":"Credit","prepaid":true,"issuer":"example","bin":"424242","productType":"Consumer","schemeProduct":"MasterCardCrPer"}}],"type":"object","required":["type","card"],"properties":{"type":{"description":"Always `SrchqMethodApplePay`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SrchqMethodApplePay"]},"card":{"$ref":"#/components/schemas/SrchqCardAttributes"}}},"SrchqMethodBankTransfer":{"title":"SrchqMethodBankTransfer","description":"A bank transfer the payer makes themselves.","examples":[{"type":"SrchqMethodBankTransfer"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `SrchqMethodBankTransfer`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SrchqMethodBankTransfer"]}}},"SrchqMethodCard":{"title":"SrchqMethodCard","description":"A card.","examples":[{"type":"SrchqMethodCard","card":{"type":"SrchqCardAttributesAttributes","currency":"AUD","country":"AU","brand":"Visa","funding":"Credit","prepaid":true,"issuer":"example","bin":"424242","productType":"Consumer","schemeProduct":"MasterCardCrPer"}}],"type":"object","required":["type","card"],"properties":{"type":{"description":"Always `SrchqMethodCard`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SrchqMethodCard"]},"card":{"$ref":"#/components/schemas/SrchqCardAttributes"}}},"SrchqMethodDirectDebit":{"title":"SrchqMethodDirectDebit","description":"Direct debit from a bank account.","examples":[{"type":"SrchqMethodDirectDebit"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `SrchqMethodDirectDebit`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SrchqMethodDirectDebit"]}}},"SrchqMethodGooglePay":{"title":"SrchqMethodGooglePay","description":"Google Pay, priced from the card behind it.","examples":[{"type":"SrchqMethodGooglePay","card":{"type":"SrchqCardAttributesAttributes","currency":"AUD","country":"AU","brand":"Visa","funding":"Credit","prepaid":true,"issuer":"example","bin":"424242","productType":"Consumer","schemeProduct":"MasterCardCrPer"}}],"type":"object","required":["type","card"],"properties":{"type":{"description":"Always `SrchqMethodGooglePay`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SrchqMethodGooglePay"]},"card":{"$ref":"#/components/schemas/SrchqCardAttributes"}}},"SrchqMethodPayTo":{"title":"SrchqMethodPayTo","description":"A PayTo agreement.","examples":[{"type":"SrchqMethodPayTo"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `SrchqMethodPayTo`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SrchqMethodPayTo"]}}},"SrchqMethodSavedSource":{"title":"SrchqMethodSavedSource","description":"A stored payment source, priced from whatever it holds.","examples":[{"type":"SrchqMethodSavedSource","sourceId":"psrc_9f2Kd8QpLzXw","underlying":{}}],"type":"object","required":["type","sourceId","underlying"],"properties":{"type":{"description":"Always `SrchqMethodSavedSource`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SrchqMethodSavedSource"]},"sourceId":{"$ref":"#/components/schemas/PsrcId","description":"Identifier of a payment source."},"underlying":{"$ref":"#/components/schemas/SrchqMethod"}}},"SrchqPayPlanVariant":{"title":"SrchqPayPlanVariant","type":"string","enum":["FourFortnightlyQuarters","FourWeekly","EightWeekly","TwentySixFortnightly","FiftyTwoWeekly","TwoMonthly","ThreeMonthly","FourMonthly","FiveMonthly","SixMonthly","SevenMonthly","EightMonthly","NineMonthly","TenMonthly","ElevenMonthly","TwelveMonthly","FortnightDeferred","FourWeekDeferred","SevenWeekDeferred","ThirtyDayDeferred","Unknown"]},"SrchqView":{"oneOf":[{"$ref":"#/components/schemas/SrchqViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"SrchqViewAttributes":"#/components/schemas/SrchqViewAttributes"}}},"SrchqViewAttributes":{"title":"SrchqViewAttributes","description":"What a payment would cost on a given payment method, including any surcharge.","examples":[{"type":"SrchqViewAttributes","surchargeQuoteId":"srchq_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","amounts":{"type":"SrchqAmountsAttributes","currency":"AUD","amount":1250,"surcharge":1250,"total":1250},"summary":"example","method":{"type":"SrchqMethodApplePay","card":{"type":"SrchqCardAttributesAttributes","currency":"AUD","country":"AU","brand":"Visa","funding":"Credit","prepaid":true,"issuer":"example","bin":"424242","productType":"Consumer","schemeProduct":"MasterCardCrPer"}}}],"type":"object","required":["type","surchargeQuoteId","merchantId","amounts","summary","method"],"properties":{"type":{"description":"Always `SrchqViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SrchqViewAttributes"]},"surchargeQuoteId":{"$ref":"#/components/schemas/SrchqId"},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"Identifier of a merchant."},"amounts":{"$ref":"#/components/schemas/SrchqAmounts"},"summary":{"description":"How the surcharge was worked out, in words a payer can be shown, `1% + $0.30 for Visa`.","type":"string"},"method":{"$ref":"#/components/schemas/SrchqMethod"}}},"SrcptAcknowledgement":{"title":"SrcptAcknowledgement","type":"string","enum":["Waiting","Successful","RequestFailed","ReturnFailed","Unknown"]},"SrcptCmd":{"oneOf":[{"$ref":"#/components/schemas/SrcptCmdRecord"}],"discriminator":{"propertyName":"type","mapping":{"SrcptCmdRecord":"#/components/schemas/SrcptCmdRecord"}}},"SrcptCmdRecord":{"title":"SrcptCmdRecord","description":"Record a payment received against a statement and apply it to the statement. A request already recorded answers with what it holds and applies nothing twice.","examples":[{"type":"SrcptCmdRecord","loanStatementId":"lstmt_9f2Kd8QpLzXw","requestReference":"your-own-reference","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"receivedAt":"2026-08-19T04:21:07Z","remark":"example","uploadFilePaths":["example"],"paymentMethod":"example"}],"type":"object","required":["type","loanStatementId","requestReference","amount"],"properties":{"type":{"description":"Always `SrcptCmdRecord`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SrcptCmdRecord"]},"loanStatementId":{"$ref":"#/components/schemas/LstmtId","description":"Identifier of a loan statement."},"requestReference":{"description":"The caller's reference for this receipt. Sending it again is safe.","type":"string"},"amount":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"The amount, in the statement's own currency: another currency is refused."},"receivedAt":{"description":"When the payment was received, where it differs from now.","type":"string","format":"date-time"},"remark":{"type":"string"},"uploadFilePaths":{"type":"array","items":{"type":"string"}},"paymentMethod":{"type":"string"}}},"SrcptColumn":{"title":"SrcptColumn","type":"string","enum":["StatementReceiptId","RequestReference","LoanStatementId","StatementReceiptBatchId","AmountMinorCurrencyUnits","AmountCurrency","Status","Acknowledgement","ReceivedAt","Remark","ErrorMessage","PaymentMethod","CreatedAt","UpdatedAt"]},"SrcptCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/SrcptCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"SrcptCreateRspAttributes":"#/components/schemas/SrcptCreateRspAttributes"}}},"SrcptCreateRspAttributes":{"title":"SrcptCreateRspAttributes","examples":[{"type":"SrcptCreateRspAttributes","created":{"type":"SrcptViewAttributes","statementReceiptId":"srcpt_9f2Kd8QpLzXw","requestReference":"your-own-reference","loanStatementId":"lstmt_9f2Kd8QpLzXw","statementReceiptBatchId":"srbat_9f2Kd8QpLzXw","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"status":"Waiting","acknowledgement":"Waiting","receivedAt":"2026-08-19T04:21:07Z","remark":"example","errorMessage":"example","uploadFilePaths":["example"],"paymentMethod":"example","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `SrcptCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SrcptCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/SrcptView","description":"The resource that was created."}}},"SrcptId":{"title":"SrcptId","description":"Identifier of a payment received against a loan statement.","examples":["srcpt_9f2Kd8QpLzXw"],"type":"string"},"SrcptPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/SrcptPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"SrcptPageAttributes":"#/components/schemas/SrcptPageAttributes"}}},"SrcptPageAttributes":{"title":"SrcptPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"SrcptPageAttributes","data":[{"type":"SrcptViewAttributes","statementReceiptId":"srcpt_9f2Kd8QpLzXw","requestReference":"your-own-reference","loanStatementId":"lstmt_9f2Kd8QpLzXw","statementReceiptBatchId":"srbat_9f2Kd8QpLzXw","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"status":"Waiting","acknowledgement":"Waiting","receivedAt":"2026-08-19T04:21:07Z","remark":"example","errorMessage":"example","uploadFilePaths":["example"],"paymentMethod":"example","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `SrcptPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SrcptPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/SrcptView","description":"A payment received against a loan statement, with what the platform answered when told of it. The bank account it was paid from is not published."}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"SrcptStatus":{"title":"SrcptStatus","type":"string","enum":["Waiting","Processing","Successful","Failed","Unknown"]},"SrcptView":{"oneOf":[{"$ref":"#/components/schemas/SrcptViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"SrcptViewAttributes":"#/components/schemas/SrcptViewAttributes"}}},"SrcptViewAttributes":{"title":"SrcptViewAttributes","description":"A payment received against a loan statement, with what the platform answered when told of it. The bank account it was paid from is not published.","examples":[{"type":"SrcptViewAttributes","statementReceiptId":"srcpt_9f2Kd8QpLzXw","requestReference":"your-own-reference","loanStatementId":"lstmt_9f2Kd8QpLzXw","statementReceiptBatchId":"srbat_9f2Kd8QpLzXw","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"status":"Waiting","acknowledgement":"Waiting","receivedAt":"2026-08-19T04:21:07Z","remark":"example","errorMessage":"example","uploadFilePaths":["example"],"paymentMethod":"example","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","statementReceiptId","requestReference","loanStatementId","amount","status","acknowledgement","createdAt","updatedAt"],"properties":{"type":{"description":"Always `SrcptViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SrcptViewAttributes"]},"statementReceiptId":{"$ref":"#/components/schemas/SrcptId"},"requestReference":{"description":"The caller's own reference for the receipt, which makes recording it idempotent.","type":"string"},"loanStatementId":{"$ref":"#/components/schemas/LstmtId","description":"The statement it was applied to. Read it at `/loan-statements/{loanStatementId}`."},"statementReceiptBatchId":{"$ref":"#/components/schemas/SrbatId","description":"The bank direct-entry batch carrying it, where there is one. Read it at `/statement-receipt-batches/{statementReceiptBatchId}`."},"amount":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"An amount in minor current units of a given currency."},"status":{"$ref":"#/components/schemas/SrcptStatus"},"acknowledgement":{"$ref":"#/components/schemas/SrcptAcknowledgement"},"receivedAt":{"type":"string","format":"date-time"},"remark":{"type":"string"},"errorMessage":{"type":"string"},"uploadFilePaths":{"description":"Where the evidence of the payment was uploaded.","type":"array","items":{"type":"string"}},"paymentMethod":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"SuplColumn":{"title":"SuplColumn","type":"string","enum":["SupplierId","MerchantId","LicenceNumber","CreatedAt","UpdatedAt"]},"SuplId":{"title":"SuplId","description":"Identifier of a supplier.","examples":["supl_9f2Kd8QpLzXw"],"type":"string"},"SuplPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/SuplPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"SuplPageAttributes":"#/components/schemas/SuplPageAttributes"}}},"SuplPageAttributes":{"title":"SuplPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"SuplPageAttributes","data":[{"type":"SuplViewAttributes","supplierId":"supl_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","licenceNumber":"example","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `SuplPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SuplPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/SuplView"}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"SuplSort":{"title":"SuplSort","type":"string","enum":["createdAt","-createdAt"]},"SuplView":{"description":"A merchant in its role as a supplier: the record of what it supplies under. Read only: its licence is the merchant's, and changes with the merchant.","oneOf":[{"$ref":"#/components/schemas/SuplViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"SuplViewAttributes":"#/components/schemas/SuplViewAttributes"}}},"SuplViewAttributes":{"title":"SuplViewAttributes","description":"A merchant in its role as a supplier: the record of what it supplies under. Read only: its licence is the merchant's, and changes with the merchant.","examples":[{"type":"SuplViewAttributes","supplierId":"supl_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","licenceNumber":"example","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","supplierId","merchantId","createdAt","updatedAt"],"properties":{"type":{"description":"Always `SuplViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["SuplViewAttributes"]},"supplierId":{"$ref":"#/components/schemas/SuplId"},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"The merchant that is this supplier."},"licenceNumber":{"description":"The licence the merchant supplies under, where it holds one.","type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"TranAmounts":{"description":"The amounts on a transaction. All are in the single currency given here.","oneOf":[{"$ref":"#/components/schemas/TranAmountsAttributes"}],"discriminator":{"propertyName":"type","mapping":{"TranAmountsAttributes":"#/components/schemas/TranAmountsAttributes"}}},"TranAmountsAttributes":{"title":"TranAmountsAttributes","description":"The amounts on a transaction. All are in the single currency given here.","examples":[{"type":"TranAmountsAttributes","currency":"AUD","amount":1250,"surcharge":1250,"refunded":1250,"fee":1250}],"type":"object","required":["type","currency","amount","surcharge","refunded"],"properties":{"type":{"description":"Always `TranAmountsAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TranAmountsAttributes"]},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"amount":{"$ref":"#/components/schemas/MinorUnits","description":"What the payer was charged, surcharge included."},"surcharge":{"$ref":"#/components/schemas/MinorUnits","description":"The surcharge the payer bore for the method used, included in `amount`."},"refunded":{"$ref":"#/components/schemas/MinorUnits","description":"How much of `amount` has been refunded."},"fee":{"$ref":"#/components/schemas/MinorUnits","description":"Platform fee deducted from the merchant. Absent unless the principal may read merchant financials."}}},"TranCardRef":{"description":"The card to charge.","oneOf":[{"$ref":"#/components/schemas/TranCardRefById"},{"$ref":"#/components/schemas/TranCardRefBySynonym"},{"$ref":"#/components/schemas/TranCardRefByToken"}],"discriminator":{"propertyName":"type","mapping":{"TranCardRefById":"#/components/schemas/TranCardRefById","TranCardRefBySynonym":"#/components/schemas/TranCardRefBySynonym","TranCardRefByToken":"#/components/schemas/TranCardRefByToken"}}},"TranCardRefById":{"title":"TranCardRefById","description":"By the card's identifier.","examples":[{"type":"TranCardRefById","cardId":"dcard_9f2Kd8QpLzXw"}],"type":"object","required":["type","cardId"],"properties":{"type":{"description":"Always `TranCardRefById`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TranCardRefById"]},"cardId":{"$ref":"#/components/schemas/CardId","description":"Identifier of a digital card."}}},"TranCardRefBySynonym":{"title":"TranCardRefBySynonym","description":"By a synonym issued against the card.","examples":[{"type":"TranCardRefBySynonym","synonym":"example","synonymType":"RandomPan"}],"type":"object","required":["type","synonym","synonymType"],"properties":{"type":{"description":"Always `TranCardRefBySynonym`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TranCardRefBySynonym"]},"synonym":{"type":"string"},"synonymType":{"$ref":"#/components/schemas/CardSynonymType"}}},"TranCardRefByToken":{"title":"TranCardRefByToken","description":"By the card's tokenised number, a vault token, never a PAN.","examples":[{"type":"TranCardRefByToken","tokenisedPan":"tok_9f2Kd8QpLzXwR4mN"}],"type":"object","required":["type","tokenisedPan"],"properties":{"type":{"description":"Always `TranCardRefByToken`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TranCardRefByToken"]},"tokenisedPan":{"type":"string"}}},"TranCmd":{"oneOf":[{"$ref":"#/components/schemas/TranCmdCompleteThreeDS"},{"$ref":"#/components/schemas/TranCmdCreate"},{"$ref":"#/components/schemas/TranCmdCreateFromDigitalCard"}],"discriminator":{"propertyName":"type","mapping":{"TranCmdCompleteThreeDS":"#/components/schemas/TranCmdCompleteThreeDS","TranCmdCreate":"#/components/schemas/TranCmdCreate","TranCmdCreateFromDigitalCard":"#/components/schemas/TranCmdCreateFromDigitalCard"}}},"TranCmdCompleteThreeDS":{"title":"TranCmdCompleteThreeDS","description":"Complete a payment that was awaiting a 3DS challenge.","examples":[{"type":"TranCmdCompleteThreeDS","orderId":"ordr_9f2Kd8QpLzXw","paymentTokenId":"ptkn_9f2Kd8QpLzXw","authorisationId":"abc123","referenceTransactionId":"your-own-reference"}],"type":"object","required":["type","orderId","paymentTokenId","authorisationId"],"properties":{"type":{"description":"Always `TranCmdCompleteThreeDS`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TranCmdCompleteThreeDS"]},"orderId":{"$ref":"#/components/schemas/OrdrId","description":"Identifier of an order."},"paymentTokenId":{"$ref":"#/components/schemas/PtknId","description":"Identifier of a payment token."},"authorisationId":{"description":"The authorisation the challenge belonged to, as `TranCreateRspThreeDSRequired` gave it.","type":"string"},"referenceTransactionId":{"description":"Your own reference for this transaction.","type":"string"}}},"TranCmdCreate":{"title":"TranCmdCreate","description":"Take a payment against a payment token.","examples":[{"type":"TranCmdCreate","orderId":"ordr_9f2Kd8QpLzXw","paymentTokenId":"ptkn_9f2Kd8QpLzXw","authoriseOnly":true,"requestThreeDS":true,"returnUrl":"https://example.com/callback","offSession":true,"cardStatementName":"Ada Lovelace","cardStatementCity":"example","referenceTransactionId":"your-own-reference"}],"type":"object","required":["type","orderId","paymentTokenId"],"properties":{"type":{"description":"Always `TranCmdCreate`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TranCmdCreate"]},"orderId":{"$ref":"#/components/schemas/OrdrId","description":"The order this payment settles. Required, the platform pays an order, not a bare amount."},"paymentTokenId":{"$ref":"#/components/schemas/PtknId","description":"The token authorising this payment. Its method decides how the money is taken."},"authoriseOnly":{"description":"Authorise only, capturing later. Defaults to capturing immediately.","type":"boolean"},"requestThreeDS":{"description":"Ask the card scheme for a 3DS challenge. Defaults to the merchant's own policy.","type":"boolean"},"returnUrl":{"description":"Where to return the payer after a 3DS challenge. Required for card payments that may be challenged.","type":"string"},"offSession":{"description":"The payer is not present, a stored credential being used without them.","type":"boolean"},"cardStatementName":{"description":"Override what the payer sees on their card statement for this payment.","type":"string"},"cardStatementCity":{"description":"Override the city shown beside the statement name.","type":"string"},"referenceTransactionId":{"description":"Your own reference for this transaction.","type":"string"}}},"TranCmdCreateFromDigitalCard":{"title":"TranCmdCreateFromDigitalCard","description":"Take a payment against a digital card the platform issued.","examples":[{"type":"TranCmdCreateFromDigitalCard","orderId":"ordr_9f2Kd8QpLzXw","cardReference":{"type":"TranCardRefById","cardId":"dcard_9f2Kd8QpLzXw"},"amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"surcharge":{"type":"PtknSurchargeNone"},"authoriseOnly":true,"referenceTransactionId":"your-own-reference"}],"type":"object","required":["type","orderId","cardReference","amount"],"properties":{"type":{"description":"Always `TranCmdCreateFromDigitalCard`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TranCmdCreateFromDigitalCard"]},"orderId":{"$ref":"#/components/schemas/OrdrId","description":"Identifier of an order."},"cardReference":{"$ref":"#/components/schemas/TranCardRef"},"amount":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"What to charge before any surcharge. The card's own currency is used where it allows the order's."},"surcharge":{"$ref":"#/components/schemas/PtknSurcharge","description":"Whether to surcharge, and how much. Defaults to no surcharge."},"authoriseOnly":{"description":"Hold the funds without capturing them. Defaults to `false`.","type":"boolean"},"referenceTransactionId":{"description":"Your own reference for this transaction.","type":"string"}}},"TranColumn":{"title":"TranColumn","type":"string","enum":["TransactionId","MerchantId","CustomerCustomerId","CustomerName","CustomerEmailAddress","CustomerPhoneNumber","OrderId","ReferenceOrderId","PaymentType","Status","AmountsCurrency","AmountsAmount","AmountsSurcharge","AmountsRefunded","AmountsFee","PayoutId","SettlementDate","AvailableOn","ReferenceTransactionId","ReferenceIssuerTransactionId","CreatedAt","UpdatedAt"]},"TranCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/TranCreateRspCompleted"},{"$ref":"#/components/schemas/TranCreateRspThreeDSRequired"}],"discriminator":{"propertyName":"type","mapping":{"TranCreateRspCompleted":"#/components/schemas/TranCreateRspCompleted","TranCreateRspThreeDSRequired":"#/components/schemas/TranCreateRspThreeDSRequired"}}},"TranCreateRspCompleted":{"title":"TranCreateRspCompleted","description":"The payment went through. The transaction is what it produced.","examples":[{"type":"TranCreateRspCompleted","created":{"type":"TranViewAttributes","transactionId":"tran_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","customer":{"type":"RfndCustomerAttributes","customerId":"cust_9f2Kd8QpLzXw","name":"Ada Lovelace","emailAddress":"ada@example.com","phoneNumber":"+61400000000"},"orderId":"ordr_9f2Kd8QpLzXw","referenceOrderId":"your-own-reference","paymentType":"PayInFull","status":"Accepted","amounts":{"type":"TranAmountsAttributes","currency":"AUD","amount":1250,"surcharge":1250,"refunded":1250,"fee":1250},"refunds":[{"type":"RfndViewAttributes","refundId":"rfnd_9f2Kd8QpLzXw","subject":{"type":"RfndSubjectTransaction","transactionId":"tran_9f2Kd8QpLzXw"},"merchantId":"mcht_9f2Kd8QpLzXw","customer":{"type":"RfndCustomerAttributes","customerId":"cust_9f2Kd8QpLzXw","name":"Ada Lovelace","emailAddress":"ada@example.com","phoneNumber":"+61400000000"},"status":"Pending","amounts":{"type":"RfndAmountsAttributes","currency":"AUD","amount":1250,"transactionAmount":1250},"orderId":"ordr_9f2Kd8QpLzXw","referenceOrderId":"your-own-reference","orderMetadata":{"yourKey":{}},"payoutId":"payout_9f2Kd8QpLzXw","settlementDate":"2026-08-19","attempts":1250,"lastError":"example","createdAt":"2026-08-19T04:21:07Z","refundedAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"disputes":[{"type":"DisputeViewAttributes","disputeId":"dispute_9f2Kd8QpLzXw","subject":{"type":"RfndSubjectTransaction","transactionId":"tran_9f2Kd8QpLzXw"},"merchantId":"mcht_9f2Kd8QpLzXw","customer":{"type":"RfndCustomerAttributes","customerId":"cust_9f2Kd8QpLzXw","name":"Ada Lovelace","emailAddress":"ada@example.com","phoneNumber":"+61400000000"},"status":"Pending","gatewayState":"example","amounts":{"type":"DisputeAmountsAttributes","currency":"AUD","amount":1250,"transactionAmount":1250},"feeAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"reason":"Requested by the customer.","description":"A short description.","orderId":"ordr_9f2Kd8QpLzXw","referenceOrderId":"your-own-reference","orderMetadata":{"yourKey":{}},"evidenceDueBy":"2026-08-19","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"payoutId":"payout_9f2Kd8QpLzXw","settlementDate":"2026-08-19","availableOn":"2026-08-19","referenceTransactionId":"your-own-reference","referenceIssuerTransactionId":"your-own-reference","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `TranCreateRspCompleted`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TranCreateRspCompleted"]},"created":{"$ref":"#/components/schemas/TranView","description":"A transaction, a payment taken from a customer on behalf of a merchant."}}},"TranCreateRspThreeDSRequired":{"title":"TranCreateRspThreeDSRequired","description":"The payment needs the payer to complete a 3DS challenge before it can go through.","examples":[{"type":"TranCreateRspThreeDSRequired","transactionId":"tran_9f2Kd8QpLzXw","orderId":"ordr_9f2Kd8QpLzXw","paymentTokenId":"ptkn_9f2Kd8QpLzXw","authorisationId":"abc123","challengeUrl":"https://example.com/callback"}],"type":"object","required":["type","transactionId","orderId","paymentTokenId","authorisationId"],"properties":{"type":{"description":"Always `TranCreateRspThreeDSRequired`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TranCreateRspThreeDSRequired"]},"transactionId":{"$ref":"#/components/schemas/TranId","description":"The transaction the challenge is about. It exists, and it has not been paid."},"orderId":{"$ref":"#/components/schemas/OrdrId","description":"The order being paid. Quote it back when completing the payment."},"paymentTokenId":{"$ref":"#/components/schemas/PtknId","description":"The payment token being used. Quote it back when completing the payment."},"authorisationId":{"description":"The authorisation the challenge belongs to. Quote it back as `authorisationId`.","type":"string"},"challengeUrl":{"description":"Where to send the payer. They return to your own redirect once the scheme is satisfied.","type":"string"}}},"TranId":{"title":"TranId","examples":["tran_9f2Kd8QpLzXw"],"type":"string"},"TranPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/TranPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"TranPageAttributes":"#/components/schemas/TranPageAttributes"}}},"TranPageAttributes":{"title":"TranPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"TranPageAttributes","data":[{"type":"TranViewAttributes","transactionId":"tran_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","customer":{"type":"RfndCustomerAttributes","customerId":"cust_9f2Kd8QpLzXw","name":"Ada Lovelace","emailAddress":"ada@example.com","phoneNumber":"+61400000000"},"orderId":"ordr_9f2Kd8QpLzXw","referenceOrderId":"your-own-reference","paymentType":"PayInFull","status":"Accepted","amounts":{"type":"TranAmountsAttributes","currency":"AUD","amount":1250,"surcharge":1250,"refunded":1250,"fee":1250},"refunds":[{"type":"RfndViewAttributes","refundId":"rfnd_9f2Kd8QpLzXw","subject":{"type":"RfndSubjectTransaction","transactionId":"tran_9f2Kd8QpLzXw"},"merchantId":"mcht_9f2Kd8QpLzXw","customer":{"type":"RfndCustomerAttributes","customerId":"cust_9f2Kd8QpLzXw","name":"Ada Lovelace","emailAddress":"ada@example.com","phoneNumber":"+61400000000"},"status":"Pending","amounts":{"type":"RfndAmountsAttributes","currency":"AUD","amount":1250,"transactionAmount":1250},"orderId":"ordr_9f2Kd8QpLzXw","referenceOrderId":"your-own-reference","orderMetadata":{"yourKey":{}},"payoutId":"payout_9f2Kd8QpLzXw","settlementDate":"2026-08-19","attempts":1250,"lastError":"example","createdAt":"2026-08-19T04:21:07Z","refundedAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"disputes":[{"type":"DisputeViewAttributes","disputeId":"dispute_9f2Kd8QpLzXw","subject":{"type":"RfndSubjectTransaction","transactionId":"tran_9f2Kd8QpLzXw"},"merchantId":"mcht_9f2Kd8QpLzXw","customer":{"type":"RfndCustomerAttributes","customerId":"cust_9f2Kd8QpLzXw","name":"Ada Lovelace","emailAddress":"ada@example.com","phoneNumber":"+61400000000"},"status":"Pending","gatewayState":"example","amounts":{"type":"DisputeAmountsAttributes","currency":"AUD","amount":1250,"transactionAmount":1250},"feeAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"reason":"Requested by the customer.","description":"A short description.","orderId":"ordr_9f2Kd8QpLzXw","referenceOrderId":"your-own-reference","orderMetadata":{"yourKey":{}},"evidenceDueBy":"2026-08-19","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"payoutId":"payout_9f2Kd8QpLzXw","settlementDate":"2026-08-19","availableOn":"2026-08-19","referenceTransactionId":"your-own-reference","referenceIssuerTransactionId":"your-own-reference","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `TranPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TranPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/TranView","description":"A transaction, a payment taken from a customer on behalf of a merchant."}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"TranPaymentType":{"title":"TranPaymentType","description":"How the payment was structured, in full, or over instalments.","type":"string","enum":["PayInFull","PayPlan","Unknown"]},"TranSort":{"title":"TranSort","type":"string","enum":["createdAt","-createdAt"]},"TranStatus":{"title":"TranStatus","type":"string","enum":["Accepted","Captured","Authorised","Pending","AwaitingAuthentication","PartiallyRefunded","Refunded","Disputed","Failed","Cancelled","Unknown"]},"TranUpdate":{"oneOf":[{"$ref":"#/components/schemas/TranUpdateCancel"},{"$ref":"#/components/schemas/TranUpdateCapture"}],"discriminator":{"propertyName":"type","mapping":{"TranUpdateCancel":"#/components/schemas/TranUpdateCancel","TranUpdateCapture":"#/components/schemas/TranUpdateCapture"}}},"TranUpdateCancel":{"title":"TranUpdateCancel","description":"Release the authorisation without taking the money. The held funds go back.","examples":[{"type":"TranUpdateCancel"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `TranUpdateCancel`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TranUpdateCancel"]}}},"TranUpdateCapture":{"title":"TranUpdateCapture","description":"Capture the authorisation, taking the money.","examples":[{"type":"TranUpdateCapture","captureAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"}}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `TranUpdateCapture`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TranUpdateCapture"]},"captureAmount":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"Capture less than the full authorised amount. Omit to capture all of it."}}},"TranUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/TranUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"TranUpdateRspAttributes":"#/components/schemas/TranUpdateRspAttributes"}}},"TranUpdateRspAttributes":{"title":"TranUpdateRspAttributes","examples":[{"type":"TranUpdateRspAttributes","updated":{"type":"TranViewAttributes","transactionId":"tran_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","customer":{"type":"RfndCustomerAttributes","customerId":"cust_9f2Kd8QpLzXw","name":"Ada Lovelace","emailAddress":"ada@example.com","phoneNumber":"+61400000000"},"orderId":"ordr_9f2Kd8QpLzXw","referenceOrderId":"your-own-reference","paymentType":"PayInFull","status":"Accepted","amounts":{"type":"TranAmountsAttributes","currency":"AUD","amount":1250,"surcharge":1250,"refunded":1250,"fee":1250},"refunds":[{"type":"RfndViewAttributes","refundId":"rfnd_9f2Kd8QpLzXw","subject":{"type":"RfndSubjectTransaction","transactionId":"tran_9f2Kd8QpLzXw"},"merchantId":"mcht_9f2Kd8QpLzXw","customer":{"type":"RfndCustomerAttributes","customerId":"cust_9f2Kd8QpLzXw","name":"Ada Lovelace","emailAddress":"ada@example.com","phoneNumber":"+61400000000"},"status":"Pending","amounts":{"type":"RfndAmountsAttributes","currency":"AUD","amount":1250,"transactionAmount":1250},"orderId":"ordr_9f2Kd8QpLzXw","referenceOrderId":"your-own-reference","orderMetadata":{"yourKey":{}},"payoutId":"payout_9f2Kd8QpLzXw","settlementDate":"2026-08-19","attempts":1250,"lastError":"example","createdAt":"2026-08-19T04:21:07Z","refundedAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"disputes":[{"type":"DisputeViewAttributes","disputeId":"dispute_9f2Kd8QpLzXw","subject":{"type":"RfndSubjectTransaction","transactionId":"tran_9f2Kd8QpLzXw"},"merchantId":"mcht_9f2Kd8QpLzXw","customer":{"type":"RfndCustomerAttributes","customerId":"cust_9f2Kd8QpLzXw","name":"Ada Lovelace","emailAddress":"ada@example.com","phoneNumber":"+61400000000"},"status":"Pending","gatewayState":"example","amounts":{"type":"DisputeAmountsAttributes","currency":"AUD","amount":1250,"transactionAmount":1250},"feeAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"reason":"Requested by the customer.","description":"A short description.","orderId":"ordr_9f2Kd8QpLzXw","referenceOrderId":"your-own-reference","orderMetadata":{"yourKey":{}},"evidenceDueBy":"2026-08-19","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"payoutId":"payout_9f2Kd8QpLzXw","settlementDate":"2026-08-19","availableOn":"2026-08-19","referenceTransactionId":"your-own-reference","referenceIssuerTransactionId":"your-own-reference","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `TranUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TranUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/TranView","description":"The resource as it stands after the change."}}},"TranView":{"oneOf":[{"$ref":"#/components/schemas/TranViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"TranViewAttributes":"#/components/schemas/TranViewAttributes"}}},"TranViewAttributes":{"title":"TranViewAttributes","description":"A transaction, a payment taken from a customer on behalf of a merchant.","examples":[{"type":"TranViewAttributes","transactionId":"tran_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","customer":{"type":"RfndCustomerAttributes","customerId":"cust_9f2Kd8QpLzXw","name":"Ada Lovelace","emailAddress":"ada@example.com","phoneNumber":"+61400000000"},"orderId":"ordr_9f2Kd8QpLzXw","referenceOrderId":"your-own-reference","paymentType":"PayInFull","status":"Accepted","amounts":{"type":"TranAmountsAttributes","currency":"AUD","amount":1250,"surcharge":1250,"refunded":1250,"fee":1250},"refunds":[{"type":"RfndViewAttributes","refundId":"rfnd_9f2Kd8QpLzXw","subject":{"type":"RfndSubjectTransaction","transactionId":"tran_9f2Kd8QpLzXw"},"merchantId":"mcht_9f2Kd8QpLzXw","customer":{"type":"RfndCustomerAttributes","customerId":"cust_9f2Kd8QpLzXw","name":"Ada Lovelace","emailAddress":"ada@example.com","phoneNumber":"+61400000000"},"status":"Pending","amounts":{"type":"RfndAmountsAttributes","currency":"AUD","amount":1250,"transactionAmount":1250},"orderId":"ordr_9f2Kd8QpLzXw","referenceOrderId":"your-own-reference","orderMetadata":{"yourKey":{}},"payoutId":"payout_9f2Kd8QpLzXw","settlementDate":"2026-08-19","attempts":1250,"lastError":"example","createdAt":"2026-08-19T04:21:07Z","refundedAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"disputes":[{"type":"DisputeViewAttributes","disputeId":"dispute_9f2Kd8QpLzXw","subject":{"type":"RfndSubjectTransaction","transactionId":"tran_9f2Kd8QpLzXw"},"merchantId":"mcht_9f2Kd8QpLzXw","customer":{"type":"RfndCustomerAttributes","customerId":"cust_9f2Kd8QpLzXw","name":"Ada Lovelace","emailAddress":"ada@example.com","phoneNumber":"+61400000000"},"status":"Pending","gatewayState":"example","amounts":{"type":"DisputeAmountsAttributes","currency":"AUD","amount":1250,"transactionAmount":1250},"feeAmount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"reason":"Requested by the customer.","description":"A short description.","orderId":"ordr_9f2Kd8QpLzXw","referenceOrderId":"your-own-reference","orderMetadata":{"yourKey":{}},"evidenceDueBy":"2026-08-19","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"payoutId":"payout_9f2Kd8QpLzXw","settlementDate":"2026-08-19","availableOn":"2026-08-19","referenceTransactionId":"your-own-reference","referenceIssuerTransactionId":"your-own-reference","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","transactionId","merchantId","customer","orderId","paymentType","status","amounts","createdAt","updatedAt"],"properties":{"type":{"description":"Always `TranViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TranViewAttributes"]},"transactionId":{"$ref":"#/components/schemas/TranId","description":"Identifier of a transaction."},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"Identifier of a merchant."},"customer":{"$ref":"#/components/schemas/RfndCustomer","description":"Who paid, carried here so a report does not need a second call."},"orderId":{"$ref":"#/components/schemas/OrdrId","description":"The order this payment settles. Every transaction has one, the platform creates one where the caller did not."},"referenceOrderId":{"description":"Your own reference for that order.","type":"string"},"paymentType":{"$ref":"#/components/schemas/TranPaymentType"},"status":{"$ref":"#/components/schemas/TranStatus"},"amounts":{"$ref":"#/components/schemas/TranAmounts"},"refunds":{"description":"The refunds issued against this transaction, in full.","type":"array","items":{"$ref":"#/components/schemas/RfndView","description":"A refund of part or all of a transaction."}},"disputes":{"description":"The disputes raised against this transaction, in full.","type":"array","items":{"$ref":"#/components/schemas/DisputeView","description":"A cardholder's challenge to a transaction, and the platform's response to it."}},"payoutId":{"$ref":"#/components/schemas/PayoutId","description":"The payout this payment settled in. Absent unless the principal may read merchant financials."},"settlementDate":{"description":"The date that payout settles.","type":"string","format":"date"},"availableOn":{"description":"The date the funds became available to pay out.","type":"string","format":"date"},"referenceTransactionId":{"description":"The caller's own reference for this transaction.","type":"string"},"referenceIssuerTransactionId":{"description":"The issuer transaction this payment was made with, where the payer used a card the platform issued.","type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"TtfrAmounts":{"description":"A transaction's total and what has been moved out of it. All in the single currency given here.","oneOf":[{"$ref":"#/components/schemas/TtfrAmountsAttributes"}],"discriminator":{"propertyName":"type","mapping":{"TtfrAmountsAttributes":"#/components/schemas/TtfrAmountsAttributes"}}},"TtfrAmountsAttributes":{"title":"TtfrAmountsAttributes","description":"A transaction's total and what has been moved out of it. All in the single currency given here.","examples":[{"type":"TtfrAmountsAttributes","currency":"AUD","transactionAmount":1250,"transferred":1250,"transferable":1250,"levied":1250,"surcharged":1250}],"type":"object","required":["type","currency","transactionAmount","transferred","transferable","levied","surcharged"],"properties":{"type":{"description":"Always `TtfrAmountsAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TtfrAmountsAttributes"]},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"transactionAmount":{"$ref":"#/components/schemas/MinorUnits","description":"The transaction's amount, fixed when the first transfer was made."},"transferred":{"$ref":"#/components/schemas/MinorUnits","description":"Moved out so far, net of reversals."},"transferable":{"$ref":"#/components/schemas/MinorUnits","description":"Still available to move. `transactionAmount` less `transferred`, floored at zero."},"levied":{"$ref":"#/components/schemas/MinorUnits","description":"Fees charged to destination merchants across every movement."},"surcharged":{"$ref":"#/components/schemas/MinorUnits","description":"Platform fees taken back from the source merchant across every movement."}}},"TtfrCmd":{"oneOf":[{"$ref":"#/components/schemas/TtfrCmdCreate"}],"discriminator":{"propertyName":"type","mapping":{"TtfrCmdCreate":"#/components/schemas/TtfrCmdCreate"}}},"TtfrCmdAmounts":{"description":"How much to move and the fee to charge for it. Both in the single currency given here.","oneOf":[{"$ref":"#/components/schemas/TtfrCmdAmountsAttributes"}],"discriminator":{"propertyName":"type","mapping":{"TtfrCmdAmountsAttributes":"#/components/schemas/TtfrCmdAmountsAttributes"}}},"TtfrCmdAmountsAttributes":{"title":"TtfrCmdAmountsAttributes","description":"How much to move and the fee to charge for it. Both in the single currency given here.","examples":[{"type":"TtfrCmdAmountsAttributes","currency":"AUD","amount":1250,"levy":1250}],"type":"object","required":["type","currency","amount"],"properties":{"type":{"description":"Always `TtfrCmdAmountsAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TtfrCmdAmountsAttributes"]},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"amount":{"$ref":"#/components/schemas/MinorUnits","description":"How much to move. Must be positive, and at most the record's `transferable`."},"levy":{"$ref":"#/components/schemas/MinorUnits","description":"A fee to charge the destination merchant for receiving this. Must be positive where given."}}},"TtfrCmdCreate":{"title":"TtfrCmdCreate","description":"Move part of a transaction's funds to another merchant.","examples":[{"type":"TtfrCmdCreate","transactionId":"tran_9f2Kd8QpLzXw","fromMerchantId":"mcht_9f2Kd8QpLzXw","toMerchantId":"mcht_9f2Kd8QpLzXw","amounts":{"type":"TtfrCmdAmountsAttributes","currency":"AUD","amount":1250,"levy":1250},"surcharge":true,"metadata":{"yourKey":"example"}}],"type":"object","required":["type","transactionId","fromMerchantId","toMerchantId","amounts","surcharge"],"properties":{"type":{"description":"Always `TtfrCmdCreate`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TtfrCmdCreate"]},"transactionId":{"$ref":"#/components/schemas/TranId","description":"The transaction to move funds out of."},"fromMerchantId":{"$ref":"#/components/schemas/MchtId","description":"The merchant that took the payment. Must be the transaction's own merchant."},"toMerchantId":{"$ref":"#/components/schemas/MchtId","description":"The merchant to move the funds to."},"amounts":{"$ref":"#/components/schemas/TtfrCmdAmounts"},"surcharge":{"description":"`true` charges the platform fee for this transfer back to the source merchant.","type":"boolean"},"metadata":{"$ref":"#/components/schemas/MchtStringMap","description":"Free-form data to store against this movement and return on every read of it."}}},"TtfrCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/TtfrCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"TtfrCreateRspAttributes":"#/components/schemas/TtfrCreateRspAttributes"}}},"TtfrCreateRspAttributes":{"title":"TtfrCreateRspAttributes","examples":[{"type":"TtfrCreateRspAttributes","created":{"type":"TtfrViewAttributes","transferId":"tran_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","marketplaceId":"mktp_9f2Kd8QpLzXw","enterpriseId":"ent_9f2Kd8QpLzXw","state":"Available","amounts":{"type":"TtfrAmountsAttributes","currency":"AUD","transactionAmount":1250,"transferred":1250,"transferable":1250,"levied":1250,"surcharged":1250},"movements":[{"type":"TtfrMovementAttributes","toMerchantId":"mcht_9f2Kd8QpLzXw","idempotencyKey":"example","transferred":1250,"surcharged":1250,"levy":1250,"metadata":{"yourKey":"example"},"createdAt":"2026-08-19T04:21:07Z"}],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `TtfrCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TtfrCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/TtfrView","description":"The resource that was created."}}},"TtfrMovement":{"description":"One movement in the journal, a transfer, or a reversal.","oneOf":[{"$ref":"#/components/schemas/TtfrMovementAttributes"}],"discriminator":{"propertyName":"type","mapping":{"TtfrMovementAttributes":"#/components/schemas/TtfrMovementAttributes"}}},"TtfrMovementAttributes":{"title":"TtfrMovementAttributes","description":"One movement in the journal, a transfer, or a reversal.","examples":[{"type":"TtfrMovementAttributes","toMerchantId":"mcht_9f2Kd8QpLzXw","idempotencyKey":"example","transferred":1250,"surcharged":1250,"levy":1250,"metadata":{"yourKey":"example"},"createdAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","toMerchantId","idempotencyKey","transferred","surcharged","levy","createdAt"],"properties":{"type":{"description":"Always `TtfrMovementAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TtfrMovementAttributes"]},"toMerchantId":{"$ref":"#/components/schemas/MchtId","description":"The merchant funds moved to, or were clawed back from."},"idempotencyKey":{"description":"The key this movement was made under. A repeat of it is refused.","type":"string"},"transferred":{"$ref":"#/components/schemas/MinorUnits","description":"Signed: positive is a transfer out, negative is a reversal back. Minor units of the record's currency."},"surcharged":{"$ref":"#/components/schemas/MinorUnits","description":"Platform fees taken back from the source merchant for this movement."},"levy":{"$ref":"#/components/schemas/MinorUnits","description":"Fees charged to the destination merchant for this movement."},"metadata":{"$ref":"#/components/schemas/MchtStringMap","description":"Free-form data the source merchant attached to this movement."},"createdAt":{"type":"string","format":"date-time"}}},"TtfrState":{"title":"TtfrState","description":"Whether a movement is in flight. A caller seeing `Transferring` should retry rather than treat it as final.","type":"string","enum":["Available","Transferring","Unknown"]},"TtfrUpdate":{"oneOf":[{"$ref":"#/components/schemas/TtfrUpdateReverse"}],"discriminator":{"propertyName":"type","mapping":{"TtfrUpdateReverse":"#/components/schemas/TtfrUpdateReverse"}}},"TtfrUpdateReverse":{"title":"TtfrUpdateReverse","description":"Claw back part of what was transferred to one merchant.","examples":[{"type":"TtfrUpdateReverse","toMerchantId":"mcht_9f2Kd8QpLzXw","amount":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"},"reverseLevy":true,"metadata":{"yourKey":"example"}}],"type":"object","required":["type","toMerchantId","amount","reverseLevy"],"properties":{"type":{"description":"Always `TtfrUpdateReverse`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TtfrUpdateReverse"]},"toMerchantId":{"$ref":"#/components/schemas/MchtId","description":"The merchant to claw the funds back from. It must have received a transfer on this transaction."},"amount":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"How much to reverse. Must be positive, and at most what that merchant received."},"reverseLevy":{"description":"`true` returns the levy charged to that merchant in proportion. `false` leaves it in place.","type":"boolean"},"metadata":{"$ref":"#/components/schemas/MchtStringMap","description":"Free-form data to store against the reversal movement."}}},"TtfrUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/TtfrUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"TtfrUpdateRspAttributes":"#/components/schemas/TtfrUpdateRspAttributes"}}},"TtfrUpdateRspAttributes":{"title":"TtfrUpdateRspAttributes","examples":[{"type":"TtfrUpdateRspAttributes","updated":{"type":"TtfrViewAttributes","transferId":"tran_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","marketplaceId":"mktp_9f2Kd8QpLzXw","enterpriseId":"ent_9f2Kd8QpLzXw","state":"Available","amounts":{"type":"TtfrAmountsAttributes","currency":"AUD","transactionAmount":1250,"transferred":1250,"transferable":1250,"levied":1250,"surcharged":1250},"movements":[{"type":"TtfrMovementAttributes","toMerchantId":"mcht_9f2Kd8QpLzXw","idempotencyKey":"example","transferred":1250,"surcharged":1250,"levy":1250,"metadata":{"yourKey":"example"},"createdAt":"2026-08-19T04:21:07Z"}],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `TtfrUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TtfrUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/TtfrView","description":"The resource as it stands after the change."}}},"TtfrView":{"oneOf":[{"$ref":"#/components/schemas/TtfrViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"TtfrViewAttributes":"#/components/schemas/TtfrViewAttributes"}}},"TtfrViewAttributes":{"title":"TtfrViewAttributes","description":"Every movement of one transaction's funds to other merchants, and what is left to move.","examples":[{"type":"TtfrViewAttributes","transferId":"tran_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","marketplaceId":"mktp_9f2Kd8QpLzXw","enterpriseId":"ent_9f2Kd8QpLzXw","state":"Available","amounts":{"type":"TtfrAmountsAttributes","currency":"AUD","transactionAmount":1250,"transferred":1250,"transferable":1250,"levied":1250,"surcharged":1250},"movements":[{"type":"TtfrMovementAttributes","toMerchantId":"mcht_9f2Kd8QpLzXw","idempotencyKey":"example","transferred":1250,"surcharged":1250,"levy":1250,"metadata":{"yourKey":"example"},"createdAt":"2026-08-19T04:21:07Z"}],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","transferId","merchantId","marketplaceId","enterpriseId","state","amounts","createdAt","updatedAt"],"properties":{"type":{"description":"Always `TtfrViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TtfrViewAttributes"]},"transferId":{"$ref":"#/components/schemas/TranId","description":"The transaction whose funds these movements come out of. This is also the record's identifier."},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"The merchant that took the payment, and the source of every movement here."},"marketplaceId":{"$ref":"#/components/schemas/MktpId","description":"The marketplace the transfers are made in. Inferred from the credential, not supplied."},"enterpriseId":{"$ref":"#/components/schemas/EntId","description":"Identifier of an enterprise."},"state":{"$ref":"#/components/schemas/TtfrState"},"amounts":{"$ref":"#/components/schemas/TtfrAmounts"},"movements":{"description":"Every transfer and reversal, oldest first. Append-only, a reversal is a negative movement, not an edit.","type":"array","items":{"$ref":"#/components/schemas/TtfrMovement"}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"TvlbatColumn":{"title":"TvlbatColumn","type":"string","enum":["TravelBatchId","TravelFileId","FileName","MerchantId","OwnerMerchantId","PartnerCode","FileType","ProcessingDate","Version","Release","CountryCode","AcquirerPrefix","ProcessingPage","CreditCardIndicator","BosReference","FileReference","RecordCount","StartLine","EndLine","Currency","ParseStatus","DealStatus","Validation","CreatedAt","UpdatedAt"]},"TvlbatPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/TvlbatPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"TvlbatPageAttributes":"#/components/schemas/TvlbatPageAttributes"}}},"TvlbatPageAttributes":{"title":"TvlbatPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"TvlbatPageAttributes","data":[{"type":"TvlbatViewAttributes","travelBatchId":"tvlbat_9f2Kd8QpLzXw","travelFileId":"tvlfile_9f2Kd8QpLzXw","fileName":"Ada Lovelace","merchantId":"mcht_9f2Kd8QpLzXw","ownerMerchantId":"mcht_9f2Kd8QpLzXw","partnerCode":"example","fileType":"Merchant","processingDate":"2026-08-19","version":"example","release":"example","countryCode":"AU","acquirerPrefix":"example","processingPage":"example","creditCardIndicator":"example","bosReference":"your-own-reference","fileReference":"your-own-reference","recordCount":42,"startLine":1250,"endLine":1250,"currency":"AUD","parseStatus":"NotRequired","dealStatus":"Waiting","validation":"Passed","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `TvlbatPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvlbatPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/TvlbatView"}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"TvlbatSort":{"title":"TvlbatSort","type":"string","enum":["createdAt","-createdAt","updatedAt","-updatedAt","processingDate","-processingDate"]},"TvlbatView":{"description":"One batch of a travel file, from its header to its trailer, listed across files with the file it came in. Its totals are not held: they are the sums of its entries.","oneOf":[{"$ref":"#/components/schemas/TvlbatViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"TvlbatViewAttributes":"#/components/schemas/TvlbatViewAttributes"}}},"TvlbatViewAttributes":{"title":"TvlbatViewAttributes","description":"One batch of a travel file, from its header to its trailer, listed across files with the file it came in. Its totals are not held: they are the sums of its entries.","examples":[{"type":"TvlbatViewAttributes","travelBatchId":"tvlbat_9f2Kd8QpLzXw","travelFileId":"tvlfile_9f2Kd8QpLzXw","fileName":"Ada Lovelace","merchantId":"mcht_9f2Kd8QpLzXw","ownerMerchantId":"mcht_9f2Kd8QpLzXw","partnerCode":"example","fileType":"Merchant","processingDate":"2026-08-19","version":"example","release":"example","countryCode":"AU","acquirerPrefix":"example","processingPage":"example","creditCardIndicator":"example","bosReference":"your-own-reference","fileReference":"your-own-reference","recordCount":42,"startLine":1250,"endLine":1250,"currency":"AUD","parseStatus":"NotRequired","dealStatus":"Waiting","validation":"Passed","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","travelBatchId","travelFileId","fileName","merchantId","ownerMerchantId","partnerCode","fileType","processingDate","version","release","countryCode","acquirerPrefix","processingPage","creditCardIndicator","bosReference","fileReference","recordCount","startLine","endLine","parseStatus","dealStatus","validation","createdAt","updatedAt"],"properties":{"type":{"description":"Always `TvlbatViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvlbatViewAttributes"]},"travelBatchId":{"$ref":"#/components/schemas/TvlfileBatchId","description":"Identifier of a batch of a travel file."},"travelFileId":{"$ref":"#/components/schemas/TvlfileId","description":"The file the batch came in. Read it at `/travel-files/{travelFileId}`, and this batch at `/travel-files/{travelFileId}/batches/{travelBatchId}`."},"fileName":{"description":"The name of the file the batch came in.","type":"string"},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"The merchant that uploaded the file."},"ownerMerchantId":{"$ref":"#/components/schemas/MchtId","description":"The merchant the batch's entries belong to, which is not the uploader when a distributor sends a file for a client."},"partnerCode":{"description":"The twelve-digit merchant code the batch's header states.","type":"string"},"fileType":{"$ref":"#/components/schemas/TvlfileType"},"processingDate":{"type":"string","format":"date"},"version":{"description":"The file layout version, such as `V02.01`.","type":"string"},"release":{"type":"string"},"countryCode":{"type":"string"},"acquirerPrefix":{"type":"string"},"processingPage":{"description":"The acquirer processing page the header states.","type":"string"},"creditCardIndicator":{"type":"string"},"bosReference":{"type":"string"},"fileReference":{"type":"string"},"recordCount":{"type":"integer","format":"int32"},"startLine":{"description":"The line of the file the batch starts on.","type":"integer","format":"int32"},"endLine":{"type":"integer","format":"int32"},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"parseStatus":{"$ref":"#/components/schemas/TvlfileParseStatus"},"dealStatus":{"$ref":"#/components/schemas/TvlfileDealStatus"},"validation":{"$ref":"#/components/schemas/TvlfileValidation","description":"Whether the batch passed its checks."},"createdAt":{"description":"When the file the batch came in was received.","type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"TvldbicApplied":{"description":"Present when at least one correction was staged: what applying everything staged for the merchant did, any an earlier call left included.","oneOf":[{"$ref":"#/components/schemas/TvldbicAppliedAttributes"}],"discriminator":{"propertyName":"type","mapping":{"TvldbicAppliedAttributes":"#/components/schemas/TvldbicAppliedAttributes"}}},"TvldbicAppliedAttributes":{"title":"TvldbicAppliedAttributes","description":"What applying the staged corrections did, counted in corrections. Each is taken off the stage whether it succeeded or not.","examples":[{"type":"TvldbicAppliedAttributes","applied":1250,"failed":1250}],"type":"object","required":["type","applied","failed"],"properties":{"type":{"description":"Always `TvldbicAppliedAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvldbicAppliedAttributes"]},"applied":{"type":"integer","format":"int32"},"failed":{"type":"integer","format":"int32"}}},"TvldbicCmd":{"oneOf":[{"$ref":"#/components/schemas/TvldbicCmdSubmit"}],"discriminator":{"propertyName":"type","mapping":{"TvldbicCmdSubmit":"#/components/schemas/TvldbicCmdSubmit"}}},"TvldbicCmdSubmit":{"title":"TvldbicCmdSubmit","description":"Correct the references of one or more entries whose check failed, and apply them. One correction is the single-entry edit and several are a batch. A correction that leaves a mandatory reference blank is refused and reported in the answer, and the others carry on.","examples":[{"type":"TvldbicCmdSubmit","merchantId":"mcht_9f2Kd8QpLzXw","corrections":[{"type":"TvldbicItemAttributes","travelEntryId":"tvlent_9f2Kd8QpLzXw","references":{"type":"TvldbicReferencesAttributes","pk":"example","ds":"example","ks":"example","ae":"example","ik":"example","bd":"2026-08-19","pr":"example","au":"example","ak":"example","rz":"example"}}]}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `TvldbicCmdSubmit`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvldbicCmdSubmit"]},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"Whose entries to correct. Omit it when the `Merchant-Id` header names the merchant."},"corrections":{"type":"array","items":{"$ref":"#/components/schemas/TvldbicItem"}}}},"TvldbicColumn":{"title":"TvldbicColumn","type":"string","enum":["TravelDbiCorrectionId","OwnerMerchantId"]},"TvldbicId":{"title":"TvldbicId","description":"Identifier of a correction staged against a travel entry, which is the entry's own identifier.","examples":["tvlent_9f2Kd8QpLzXw"],"type":"string"},"TvldbicItem":{"description":"The references to correct on one entry.","oneOf":[{"$ref":"#/components/schemas/TvldbicItemAttributes"}],"discriminator":{"propertyName":"type","mapping":{"TvldbicItemAttributes":"#/components/schemas/TvldbicItemAttributes"}}},"TvldbicItemAttributes":{"title":"TvldbicItemAttributes","description":"The references to correct on one entry.","examples":[{"type":"TvldbicItemAttributes","travelEntryId":"tvlent_9f2Kd8QpLzXw","references":{"type":"TvldbicReferencesAttributes","pk":"example","ds":"example","ks":"example","ae":"example","ik":"example","bd":"2026-08-19","pr":"example","au":"example","ak":"example","rz":"example"}}],"type":"object","required":["type","travelEntryId","references"],"properties":{"type":{"description":"Always `TvldbicItemAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvldbicItemAttributes"]},"travelEntryId":{"$ref":"#/components/schemas/TvlentId","description":"The entry to correct. Read it at `/travel-entries/{travelEntryId}`."},"references":{"$ref":"#/components/schemas/TvldbicReferences"}}},"TvldbicPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/TvldbicPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"TvldbicPageAttributes":"#/components/schemas/TvldbicPageAttributes"}}},"TvldbicPageAttributes":{"title":"TvldbicPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"TvldbicPageAttributes","data":[{"type":"TvldbicViewAttributes","travelDbiCorrectionId":"tvlent_9f2Kd8QpLzXw","ownerMerchantId":"mcht_9f2Kd8QpLzXw"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `TvldbicPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvldbicPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/TvldbicView"}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"TvldbicReferences":{"description":"The ten references a line carries for the data-based invoicing check. A reference left out is a reference left blank.","oneOf":[{"$ref":"#/components/schemas/TvldbicReferencesAttributes"}],"discriminator":{"propertyName":"type","mapping":{"TvldbicReferencesAttributes":"#/components/schemas/TvldbicReferencesAttributes"}}},"TvldbicReferencesAttributes":{"title":"TvldbicReferencesAttributes","description":"The ten references a line carries for the data-based invoicing check. A reference left out is a reference left blank.","examples":[{"type":"TvldbicReferencesAttributes","pk":"example","ds":"example","ks":"example","ae":"example","ik":"example","bd":"2026-08-19","pr":"example","au":"example","ak":"example","rz":"example"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `TvldbicReferencesAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvldbicReferencesAttributes"]},"pk":{"type":"string"},"ds":{"type":"string"},"ks":{"type":"string"},"ae":{"type":"string"},"ik":{"type":"string"},"bd":{"description":"A date, `2026-03-31`.","type":"string","format":"date"},"pr":{"type":"string"},"au":{"type":"string"},"ak":{"type":"string"},"rz":{"type":"string"}}},"TvldbicRefusal":{"description":"A correction that was not staged, and why: a mandatory reference it left blank, or one the check does not name.","oneOf":[{"$ref":"#/components/schemas/TvldbicRefusalAttributes"}],"discriminator":{"propertyName":"type","mapping":{"TvldbicRefusalAttributes":"#/components/schemas/TvldbicRefusalAttributes"}}},"TvldbicRefusalAttributes":{"title":"TvldbicRefusalAttributes","description":"A correction that was not staged, and why: a mandatory reference it left blank, or one the check does not name.","examples":[{"type":"TvldbicRefusalAttributes","travelEntryId":"tvlent_9f2Kd8QpLzXw","reasons":["Requested by the customer."]}],"type":"object","required":["type","travelEntryId"],"properties":{"type":{"description":"Always `TvldbicRefusalAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvldbicRefusalAttributes"]},"travelEntryId":{"$ref":"#/components/schemas/TvlentId","description":"Identifier of a travel entry."},"reasons":{"type":"array","items":{"type":"string"}}}},"TvldbicResult":{"description":"What submitting corrections did. A refused correction is reported here and is not an error.","oneOf":[{"$ref":"#/components/schemas/TvldbicResultAttributes"}],"discriminator":{"propertyName":"type","mapping":{"TvldbicResultAttributes":"#/components/schemas/TvldbicResultAttributes"}}},"TvldbicResultAttributes":{"title":"TvldbicResultAttributes","description":"What submitting corrections did. A refused correction is reported here and is not an error.","examples":[{"type":"TvldbicResultAttributes","staged":["tvlent_9f2Kd8QpLzXw"],"refused":[{"type":"TvldbicRefusalAttributes","travelEntryId":"tvlent_9f2Kd8QpLzXw","reasons":["Requested by the customer."]}],"skipped":["tvlent_9f2Kd8QpLzXw"],"applied":{"type":"TvldbicAppliedAttributes","applied":1250,"failed":1250}}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `TvldbicResultAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvldbicResultAttributes"]},"staged":{"description":"The corrections staged.","type":"array","items":{"$ref":"#/components/schemas/TvlentId","description":"Identifier of a travel entry."}},"refused":{"type":"array","items":{"$ref":"#/components/schemas/TvldbicRefusal"}},"skipped":{"description":"Corrections that name no entry of the merchant whose check failed, which are passed over.","type":"array","items":{"$ref":"#/components/schemas/TvlentId","description":"Identifier of a travel entry."}},"applied":{"$ref":"#/components/schemas/TvldbicApplied"}}},"TvldbicView":{"description":"A correction staged against an entry and not yet applied. Submitting applies what it stages, so this lists what an earlier call left.","oneOf":[{"$ref":"#/components/schemas/TvldbicViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"TvldbicViewAttributes":"#/components/schemas/TvldbicViewAttributes"}}},"TvldbicViewAttributes":{"title":"TvldbicViewAttributes","description":"A correction staged against an entry and not yet applied. Submitting applies what it stages, so this lists what an earlier call left.","examples":[{"type":"TvldbicViewAttributes","travelDbiCorrectionId":"tvlent_9f2Kd8QpLzXw","ownerMerchantId":"mcht_9f2Kd8QpLzXw"}],"type":"object","required":["type","travelDbiCorrectionId","ownerMerchantId"],"properties":{"type":{"description":"Always `TvldbicViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvldbicViewAttributes"]},"travelDbiCorrectionId":{"$ref":"#/components/schemas/TvldbicId"},"ownerMerchantId":{"$ref":"#/components/schemas/MchtId","description":"The merchant the entry belongs to."}}},"TvldbiwLayout":{"title":"TvldbiwLayout","type":"string","enum":["Merchant","Admin"]},"TvlentAmounts":{"description":"The amounts on a travel entry. All are in the single currency given here.","oneOf":[{"$ref":"#/components/schemas/TvlentAmountsAttributes"}],"discriminator":{"propertyName":"type","mapping":{"TvlentAmountsAttributes":"#/components/schemas/TvlentAmountsAttributes"}}},"TvlentAmountsAttributes":{"title":"TvlentAmountsAttributes","description":"The amounts on a travel entry. All are in the single currency given here.","examples":[{"type":"TvlentAmountsAttributes","currency":"AUD","amount":1250,"netAmountNonVatable":1250,"netAmountVatable":1250,"vatAmount":1250,"refundedAmount":1250,"vatPercentage":"example","vatIndicator":"example"}],"type":"object","required":["type","currency","amount","netAmountNonVatable","netAmountVatable","vatAmount","refundedAmount","vatPercentage","vatIndicator"],"properties":{"type":{"description":"Always `TvlentAmountsAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvlentAmountsAttributes"]},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"amount":{"$ref":"#/components/schemas/MinorUnits","description":"The entry's total."},"netAmountNonVatable":{"$ref":"#/components/schemas/MinorUnits","description":"An amount in the minor units of the currency given by the enclosing object's `currency` field."},"netAmountVatable":{"$ref":"#/components/schemas/MinorUnits","description":"An amount in the minor units of the currency given by the enclosing object's `currency` field."},"vatAmount":{"$ref":"#/components/schemas/MinorUnits","description":"An amount in the minor units of the currency given by the enclosing object's `currency` field."},"refundedAmount":{"$ref":"#/components/schemas/MinorUnits","description":"How much of the entry has been refunded so far. `PATCH` it with `TvlentUpdateResetRefundedAmount`."},"vatPercentage":{"description":"The VAT rate as a decimal string, `19.00`.","type":"string"},"vatIndicator":{"type":"string"}}},"TvlentAuthOperator":{"title":"TvlentAuthOperator","type":"string","enum":["ApgPay","APG Pay","Unknown"]},"TvlentAuthStatus":{"title":"TvlentAuthStatus","type":"string","enum":["NotRequired","Waiting","Processing","Succeeded","Failed","Unknown"]},"TvlentAuthorisation":{"description":"Where an entry's authorisation and its refund have got to.","oneOf":[{"$ref":"#/components/schemas/TvlentAuthorisationAttributes"}],"discriminator":{"propertyName":"type","mapping":{"TvlentAuthorisationAttributes":"#/components/schemas/TvlentAuthorisationAttributes"}}},"TvlentAuthorisationAttributes":{"title":"TvlentAuthorisationAttributes","description":"Where an entry's authorisation and its refund have got to.","examples":[{"type":"TvlentAuthorisationAttributes","operator":"ApgPay","status":"NotRequired","statusAt":"2026-08-19T04:21:07Z","statusMessage":"Active","refundStatus":"NotRequired","refundStatusAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","status","refundStatus"],"properties":{"type":{"description":"Always `TvlentAuthorisationAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvlentAuthorisationAttributes"]},"operator":{"$ref":"#/components/schemas/TvlentAuthOperator"},"status":{"$ref":"#/components/schemas/TvlentAuthStatus"},"statusAt":{"type":"string","format":"date-time"},"statusMessage":{"type":"string"},"refundStatus":{"$ref":"#/components/schemas/TvlentAuthStatus"},"refundStatusAt":{"type":"string","format":"date-time"}}},"TvlentCarCharge":{"description":"A charge on a car rental, in the arm's currency.","oneOf":[{"$ref":"#/components/schemas/TvlentCarChargeAttributes"}],"discriminator":{"propertyName":"type","mapping":{"TvlentCarChargeAttributes":"#/components/schemas/TvlentCarChargeAttributes"}}},"TvlentCarChargeAttributes":{"title":"TvlentCarChargeAttributes","description":"A charge on a car rental, in the arm's currency.","examples":[{"type":"TvlentCarChargeAttributes","kind":"example","amount":1250,"vatIndicator":"example"}],"type":"object","required":["type","kind","amount","vatIndicator"],"properties":{"type":{"description":"Always `TvlentCarChargeAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvlentCarChargeAttributes"]},"kind":{"type":"string"},"amount":{"$ref":"#/components/schemas/MinorUnits","description":"An amount in the minor units of the currency given by the enclosing object's `currency` field."},"vatIndicator":{"type":"string"}}},"TvlentCardType":{"title":"TvlentCardType","type":"string","enum":["Uatp","Mastercard","Unknown"]},"TvlentColumn":{"title":"TvlentColumn","type":"string","enum":["TravelEntryId","TravelFileId","TravelBatchId","MerchantId","OwnerMerchantId","FileType","ProcessingDate","LineNumber","ServiceKind","Sign","CardType","HasCardToken","DocumentNumberFormat","DocumentNumber","SerialNumber","PurchaseDate","TravellerName","AmountsCurrency","AmountsAmount","AmountsNetAmountNonVatable","AmountsNetAmountVatable","AmountsVatAmount","AmountsRefundedAmount","AmountsVatPercentage","AmountsVatIndicator","ApprovalCode","MerchantDetailsName","MerchantDetailsCity","MerchantDetailsZipCode","MerchantDetailsStateCode","MerchantDetailsIataNumber","MerchantDetailsInvoiceNumber","MerchantDetailsOrderNumber","MerchantDetailsCustomerNumber","MerchantDetailsAgencyDossierNumber","MerchantDetailsAgencyDeliveryNoteNumber","UsageCode","Validation","DbiPk","DbiDs","DbiKs","DbiAe","DbiIk","DbiBd","DbiPr","DbiAu","DbiAk","DbiRz","DbiStatus","DbiStatusAt","DbiStatusMessage","DbiMandatoryFields","AuthorisationOperator","AuthorisationStatus","AuthorisationStatusAt","AuthorisationStatusMessage","AuthorisationRefundStatus","AuthorisationRefundStatusAt","MatchingStatus","MatchingStatusAt","MatchingStatusMessage","MatchingTimedOut","MatchingNeedsManualOriginalMatch","MatchingOriginalTravelEntryId","MatchingTransactionId","MatchingRefundId","MatchingIssuerTransactionId","MatchingIssuerRefundId","MatchingLoanId","MatchingCustomerId","Enabled","CreatedAt","UpdatedAt"]},"TvlentCorrectedAmounts":{"description":"The amounts of a corrected entry. All are in the single currency given here, which must be the entry's own.","oneOf":[{"$ref":"#/components/schemas/TvlentCorrectedAmountsAttributes"}],"discriminator":{"propertyName":"type","mapping":{"TvlentCorrectedAmountsAttributes":"#/components/schemas/TvlentCorrectedAmountsAttributes"}}},"TvlentCorrectedAmountsAttributes":{"title":"TvlentCorrectedAmountsAttributes","description":"The amounts of a corrected entry. All are in the single currency given here, which must be the entry's own.","examples":[{"type":"TvlentCorrectedAmountsAttributes","currency":"AUD","amount":1250,"netAmountNonVatable":1250,"netAmountVatable":1250,"vatAmount":1250,"vatPercentage":"example","vatIndicator":"example"}],"type":"object","required":["type","currency","amount","netAmountNonVatable","netAmountVatable","vatAmount","vatIndicator"],"properties":{"type":{"description":"Always `TvlentCorrectedAmountsAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvlentCorrectedAmountsAttributes"]},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"amount":{"$ref":"#/components/schemas/MinorUnits","description":"The entry's total."},"netAmountNonVatable":{"$ref":"#/components/schemas/MinorUnits","description":"An amount in the minor units of the currency given by the enclosing object's `currency` field."},"netAmountVatable":{"$ref":"#/components/schemas/MinorUnits","description":"An amount in the minor units of the currency given by the enclosing object's `currency` field."},"vatAmount":{"$ref":"#/components/schemas/MinorUnits","description":"An amount in the minor units of the currency given by the enclosing object's `currency` field."},"vatPercentage":{"description":"The VAT rate as a decimal string, `19.00`. Without it, zero.","type":"string"},"vatIndicator":{"type":"string"}}},"TvlentDbi":{"description":"The ten references a line carries for the data-based invoicing check. An empty string is a field the line left blank.","oneOf":[{"$ref":"#/components/schemas/TvlentDbiAttributes"}],"discriminator":{"propertyName":"type","mapping":{"TvlentDbiAttributes":"#/components/schemas/TvlentDbiAttributes"}}},"TvlentDbiAttributes":{"title":"TvlentDbiAttributes","description":"The ten references a line carries for the data-based invoicing check. An empty string is a field the line left blank.","examples":[{"type":"TvlentDbiAttributes","pk":"example","ds":"example","ks":"example","ae":"example","ik":"example","bd":"2026-08-19","pr":"example","au":"example","ak":"example","rz":"example","status":"NotRequired","statusAt":"2026-08-19T04:21:07Z","statusMessage":"Active","mandatoryFields":"example"}],"type":"object","required":["type","pk","ds","ks","ae","ik","pr","au","ak","rz","status"],"properties":{"type":{"description":"Always `TvlentDbiAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvlentDbiAttributes"]},"pk":{"type":"string"},"ds":{"type":"string"},"ks":{"type":"string"},"ae":{"type":"string"},"ik":{"type":"string"},"bd":{"type":"string","format":"date"},"pr":{"type":"string"},"au":{"type":"string"},"ak":{"type":"string"},"rz":{"type":"string"},"status":{"$ref":"#/components/schemas/TvlentDbiStatus"},"statusAt":{"type":"string","format":"date-time"},"statusMessage":{"description":"What the check said, where it failed.","type":"string"},"mandatoryFields":{"description":"The references the check required.","type":"string"}}},"TvlentDbiStatus":{"title":"TvlentDbiStatus","type":"string","enum":["NotRequired","Waiting","Passed","Failed","Unknown"]},"TvlentFlightSegment":{"description":"One passenger-segment of a flight.","oneOf":[{"$ref":"#/components/schemas/TvlentFlightSegmentAttributes"}],"discriminator":{"propertyName":"type","mapping":{"TvlentFlightSegmentAttributes":"#/components/schemas/TvlentFlightSegmentAttributes"}}},"TvlentFlightSegmentAttributes":{"title":"TvlentFlightSegmentAttributes","description":"One passenger-segment of a flight.","examples":[{"type":"TvlentFlightSegmentAttributes","destination":"example","airline":"example","flight":"example","flightClass":"example"}],"type":"object","required":["type","destination","airline","flight","flightClass"],"properties":{"type":{"description":"Always `TvlentFlightSegmentAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvlentFlightSegmentAttributes"]},"destination":{"type":"string"},"airline":{"type":"string"},"flight":{"type":"string"},"flightClass":{"type":"string"}}},"TvlentFlightTax":{"description":"A tax charged on a flight, in the arm's currency.","oneOf":[{"$ref":"#/components/schemas/TvlentFlightTaxAttributes"}],"discriminator":{"propertyName":"type","mapping":{"TvlentFlightTaxAttributes":"#/components/schemas/TvlentFlightTaxAttributes"}}},"TvlentFlightTaxAttributes":{"title":"TvlentFlightTaxAttributes","description":"A tax charged on a flight, in the arm's currency.","examples":[{"type":"TvlentFlightTaxAttributes","taxType":"example","amount":1250}],"type":"object","required":["type","taxType","amount"],"properties":{"type":{"description":"Always `TvlentFlightTaxAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvlentFlightTaxAttributes"]},"taxType":{"type":"string"},"amount":{"$ref":"#/components/schemas/MinorUnits","description":"An amount in the minor units of the currency given by the enclosing object's `currency` field."}}},"TvlentHotelCharge":{"description":"A service charged on a hotel stay, in the arm's currency.","oneOf":[{"$ref":"#/components/schemas/TvlentHotelChargeAttributes"}],"discriminator":{"propertyName":"type","mapping":{"TvlentHotelChargeAttributes":"#/components/schemas/TvlentHotelChargeAttributes"}}},"TvlentHotelChargeAttributes":{"title":"TvlentHotelChargeAttributes","description":"A service charged on a hotel stay, in the arm's currency.","examples":[{"type":"TvlentHotelChargeAttributes","code":"example","amount":1250,"vatIndicator":"example"}],"type":"object","required":["type","code","amount","vatIndicator"],"properties":{"type":{"description":"Always `TvlentHotelChargeAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvlentHotelChargeAttributes"]},"code":{"type":"string"},"amount":{"$ref":"#/components/schemas/MinorUnits","description":"An amount in the minor units of the currency given by the enclosing object's `currency` field."},"vatIndicator":{"type":"string"}}},"TvlentId":{"title":"TvlentId","examples":["tvlent_9f2Kd8QpLzXw"],"type":"string"},"TvlentMatch":{"description":"Where matching an entry to its payment has got to, and what it was matched to.","oneOf":[{"$ref":"#/components/schemas/TvlentMatchAttributes"}],"discriminator":{"propertyName":"type","mapping":{"TvlentMatchAttributes":"#/components/schemas/TvlentMatchAttributes"}}},"TvlentMatchAttributes":{"title":"TvlentMatchAttributes","description":"Where matching an entry to its payment has got to, and what it was matched to.","examples":[{"type":"TvlentMatchAttributes","status":"NotRequired","statusAt":"2026-08-19T04:21:07Z","statusMessage":"Active","timedOut":true,"needsManualOriginalMatch":true,"originalTravelEntryId":"tvlent_9f2Kd8QpLzXw","transactionId":"tran_9f2Kd8QpLzXw","refundId":"rfnd_9f2Kd8QpLzXw","issuerTransactionId":"itxn_9f2Kd8QpLzXw","issuerRefundId":"rfnd_9f2Kd8QpLzXw","loanId":"loan_9f2Kd8QpLzXw","customerId":"cust_9f2Kd8QpLzXw"}],"type":"object","required":["type","status","timedOut","needsManualOriginalMatch"],"properties":{"type":{"description":"Always `TvlentMatchAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvlentMatchAttributes"]},"status":{"$ref":"#/components/schemas/TvlentMatchStatus"},"statusAt":{"type":"string","format":"date-time"},"statusMessage":{"type":"string"},"timedOut":{"description":"Whether the matching gave up waiting for the payment.","type":"boolean"},"needsManualOriginalMatch":{"description":"Whether a refund is waiting for staff to say which purchase it refunds.","type":"boolean"},"originalTravelEntryId":{"$ref":"#/components/schemas/TvlentId","description":"The purchase this refund refunds. Read it at `/travel-entries/{travelEntryId}`."},"transactionId":{"$ref":"#/components/schemas/TranId","description":"The payment the entry was matched to. Read it at `/transactions/{transactionId}`."},"refundId":{"$ref":"#/components/schemas/RfndId","description":"The refund the entry was matched to. Read it at `/refunds/{refundId}`."},"issuerTransactionId":{"$ref":"#/components/schemas/ItxnId","description":"The card transaction the entry was matched to. Read it at `/issuer-transactions/{issuerTransactionId}`."},"issuerRefundId":{"$ref":"#/components/schemas/ItxnId","description":"The card refund the entry was matched to."},"loanId":{"$ref":"#/components/schemas/LoanId","description":"The loan the matched payment was drawn on."},"customerId":{"$ref":"#/components/schemas/CustId","description":"The customer the matched payment was for."}}},"TvlentMatchStatus":{"title":"TvlentMatchStatus","type":"string","enum":["NotRequired","Waiting","Processing","Matched","Failed","Unknown"]},"TvlentMerchantDetails":{"description":"The merchant's own details and references, as the line stated them.","oneOf":[{"$ref":"#/components/schemas/TvlentMerchantDetailsAttributes"}],"discriminator":{"propertyName":"type","mapping":{"TvlentMerchantDetailsAttributes":"#/components/schemas/TvlentMerchantDetailsAttributes"}}},"TvlentMerchantDetailsAttributes":{"title":"TvlentMerchantDetailsAttributes","description":"The merchant's own details and references, as the line stated them.","examples":[{"type":"TvlentMerchantDetailsAttributes","name":"Ada Lovelace","city":"example","zipCode":"example","stateCode":"example","iataNumber":"example","invoiceNumber":"example","orderNumber":"example","customerNumber":"example","agencyDossierNumber":"example","agencyDeliveryNoteNumber":"example"}],"type":"object","required":["type","name","city","iataNumber","invoiceNumber","orderNumber","customerNumber","agencyDossierNumber","agencyDeliveryNoteNumber"],"properties":{"type":{"description":"Always `TvlentMerchantDetailsAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvlentMerchantDetailsAttributes"]},"name":{"type":"string"},"city":{"type":"string"},"zipCode":{"type":"string"},"stateCode":{"type":"string"},"iataNumber":{"type":"string"},"invoiceNumber":{"type":"string"},"orderNumber":{"type":"string"},"customerNumber":{"type":"string"},"agencyDossierNumber":{"type":"string"},"agencyDeliveryNoteNumber":{"type":"string"}}},"TvlentPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/TvlentPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"TvlentPageAttributes":"#/components/schemas/TvlentPageAttributes"}}},"TvlentPageAttributes":{"title":"TvlentPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"TvlentPageAttributes","data":[{"type":"TvlentViewAttributes","travelEntryId":"tvlent_9f2Kd8QpLzXw","travelFileId":"tvlfile_9f2Kd8QpLzXw","travelBatchId":"tvlbat_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","ownerMerchantId":"mcht_9f2Kd8QpLzXw","fileType":"Merchant","processingDate":"2026-08-19","lineNumber":1250,"serviceKind":"Flight","sign":"Purchase","cardType":"Uatp","hasCardToken":true,"documentNumberFormat":"2026-08-19T04:21:07Z","documentNumber":"example","serialNumber":"example","purchaseDate":"2026-08-19","travellerName":"Ada Lovelace","amounts":{"type":"TvlentAmountsAttributes","currency":"AUD","amount":1250,"netAmountNonVatable":1250,"netAmountVatable":1250,"vatAmount":1250,"refundedAmount":1250,"vatPercentage":"example","vatIndicator":"example"},"approvalCode":"example","merchantDetails":{"type":"TvlentMerchantDetailsAttributes","name":"Ada Lovelace","city":"example","zipCode":"example","stateCode":"example","iataNumber":"example","invoiceNumber":"example","orderNumber":"example","customerNumber":"example","agencyDossierNumber":"example","agencyDeliveryNoteNumber":"example"},"usageCode":"example","validation":"Passed","dbi":{"type":"TvlentDbiAttributes","pk":"example","ds":"example","ks":"example","ae":"example","ik":"example","bd":"2026-08-19","pr":"example","au":"example","ak":"example","rz":"example","status":"NotRequired","statusAt":"2026-08-19T04:21:07Z","statusMessage":"Active","mandatoryFields":"example"},"authorisation":{"type":"TvlentAuthorisationAttributes","operator":"ApgPay","status":"NotRequired","statusAt":"2026-08-19T04:21:07Z","statusMessage":"Active","refundStatus":"NotRequired","refundStatusAt":"2026-08-19T04:21:07Z"},"matching":{"type":"TvlentMatchAttributes","status":"NotRequired","statusAt":"2026-08-19T04:21:07Z","statusMessage":"Active","timedOut":true,"needsManualOriginalMatch":true,"originalTravelEntryId":"tvlent_9f2Kd8QpLzXw","transactionId":"tran_9f2Kd8QpLzXw","refundId":"rfnd_9f2Kd8QpLzXw","issuerTransactionId":"itxn_9f2Kd8QpLzXw","issuerRefundId":"rfnd_9f2Kd8QpLzXw","loanId":"loan_9f2Kd8QpLzXw","customerId":"cust_9f2Kd8QpLzXw"},"enabled":true,"serviceLines":[{"type":"TvlentServiceLineCar","currency":"AUD","rentalCompanyCode":"example","contractNumber":"example","vehicleClassCode":"example","vehicleType":"example","noShow":true,"pickUpDate":"2026-08-19","pickUpTime":"example","pickUpLocationCode":"example","pickUpLocationCity":"example","returnDate":"2026-08-19","returnTime":"example","returnLocationCode":"example","returnLocationCity":"example","rentalDays":1250,"mileageIndicator":"example","drivenDistance":"example","charges":[{"type":"TvlentCarChargeAttributes","kind":"example","amount":1250,"vatIndicator":"example"}]}],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `TvlentPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvlentPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/TvlentView","description":"One transaction line of a travel file: what was bought, its amounts, the references the data-based invoicing check reads, where authorising and matching it to a payment have got to, and what it paid for. The card is not published, only whether the line carries one."}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"TvlentRefundCandidatePage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/TvlentRefundCandidatePageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"TvlentRefundCandidatePageAttributes":"#/components/schemas/TvlentRefundCandidatePageAttributes"}}},"TvlentRefundCandidatePageAttributes":{"title":"TvlentRefundCandidatePageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"TvlentRefundCandidatePageAttributes","data":[{"type":"TvlentViewAttributes","travelEntryId":"tvlent_9f2Kd8QpLzXw","travelFileId":"tvlfile_9f2Kd8QpLzXw","travelBatchId":"tvlbat_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","ownerMerchantId":"mcht_9f2Kd8QpLzXw","fileType":"Merchant","processingDate":"2026-08-19","lineNumber":1250,"serviceKind":"Flight","sign":"Purchase","cardType":"Uatp","hasCardToken":true,"documentNumberFormat":"2026-08-19T04:21:07Z","documentNumber":"example","serialNumber":"example","purchaseDate":"2026-08-19","travellerName":"Ada Lovelace","amounts":{"type":"TvlentAmountsAttributes","currency":"AUD","amount":1250,"netAmountNonVatable":1250,"netAmountVatable":1250,"vatAmount":1250,"refundedAmount":1250,"vatPercentage":"example","vatIndicator":"example"},"approvalCode":"example","merchantDetails":{"type":"TvlentMerchantDetailsAttributes","name":"Ada Lovelace","city":"example","zipCode":"example","stateCode":"example","iataNumber":"example","invoiceNumber":"example","orderNumber":"example","customerNumber":"example","agencyDossierNumber":"example","agencyDeliveryNoteNumber":"example"},"usageCode":"example","validation":"Passed","dbi":{"type":"TvlentDbiAttributes","pk":"example","ds":"example","ks":"example","ae":"example","ik":"example","bd":"2026-08-19","pr":"example","au":"example","ak":"example","rz":"example","status":"NotRequired","statusAt":"2026-08-19T04:21:07Z","statusMessage":"Active","mandatoryFields":"example"},"authorisation":{"type":"TvlentAuthorisationAttributes","operator":"ApgPay","status":"NotRequired","statusAt":"2026-08-19T04:21:07Z","statusMessage":"Active","refundStatus":"NotRequired","refundStatusAt":"2026-08-19T04:21:07Z"},"matching":{"type":"TvlentMatchAttributes","status":"NotRequired","statusAt":"2026-08-19T04:21:07Z","statusMessage":"Active","timedOut":true,"needsManualOriginalMatch":true,"originalTravelEntryId":"tvlent_9f2Kd8QpLzXw","transactionId":"tran_9f2Kd8QpLzXw","refundId":"rfnd_9f2Kd8QpLzXw","issuerTransactionId":"itxn_9f2Kd8QpLzXw","issuerRefundId":"rfnd_9f2Kd8QpLzXw","loanId":"loan_9f2Kd8QpLzXw","customerId":"cust_9f2Kd8QpLzXw"},"enabled":true,"serviceLines":[{"type":"TvlentServiceLineCar","currency":"AUD","rentalCompanyCode":"example","contractNumber":"example","vehicleClassCode":"example","vehicleType":"example","noShow":true,"pickUpDate":"2026-08-19","pickUpTime":"example","pickUpLocationCode":"example","pickUpLocationCity":"example","returnDate":"2026-08-19","returnTime":"example","returnLocationCode":"example","returnLocationCity":"example","rentalDays":1250,"mileageIndicator":"example","drivenDistance":"example","charges":[{"type":"TvlentCarChargeAttributes","kind":"example","amount":1250,"vatIndicator":"example"}]}],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `TvlentRefundCandidatePageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvlentRefundCandidatePageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/TvlentView","description":"One transaction line of a travel file: what was bought, its amounts, the references the data-based invoicing check reads, where authorising and matching it to a payment have got to, and what it paid for. The card is not published, only whether the line carries one."}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"TvlentRefundMatchField":{"title":"TvlentRefundMatchField","type":"string","enum":["DocumentNumber","TravellerName","DbiPk","DbiDs","DbiKs","DbiAe","DbiIk","DbiBd","DbiPr","DbiAu","DbiAk","DbiRz"]},"TvlentServiceKind":{"title":"TvlentServiceKind","type":"string","enum":["Flight","Hotel","Car","Train","Ship","Fee","Other","Commission","Tasf","Unknown"]},"TvlentServiceLine":{"oneOf":[{"$ref":"#/components/schemas/TvlentServiceLineCar"},{"$ref":"#/components/schemas/TvlentServiceLineFee"},{"$ref":"#/components/schemas/TvlentServiceLineFlight"},{"$ref":"#/components/schemas/TvlentServiceLineHotel"},{"$ref":"#/components/schemas/TvlentServiceLineOther"},{"$ref":"#/components/schemas/TvlentServiceLineShip"},{"$ref":"#/components/schemas/TvlentServiceLineTrain"}],"discriminator":{"propertyName":"type","mapping":{"TvlentServiceLineCar":"#/components/schemas/TvlentServiceLineCar","TvlentServiceLineFee":"#/components/schemas/TvlentServiceLineFee","TvlentServiceLineFlight":"#/components/schemas/TvlentServiceLineFlight","TvlentServiceLineHotel":"#/components/schemas/TvlentServiceLineHotel","TvlentServiceLineOther":"#/components/schemas/TvlentServiceLineOther","TvlentServiceLineShip":"#/components/schemas/TvlentServiceLineShip","TvlentServiceLineTrain":"#/components/schemas/TvlentServiceLineTrain"}}},"TvlentServiceLineCar":{"title":"TvlentServiceLineCar","description":"A car rental. Its charges are in `currency`.","examples":[{"type":"TvlentServiceLineCar","currency":"AUD","rentalCompanyCode":"example","contractNumber":"example","vehicleClassCode":"example","vehicleType":"example","noShow":true,"pickUpDate":"2026-08-19","pickUpTime":"example","pickUpLocationCode":"example","pickUpLocationCity":"example","returnDate":"2026-08-19","returnTime":"example","returnLocationCode":"example","returnLocationCity":"example","rentalDays":1250,"mileageIndicator":"example","drivenDistance":"example","charges":[{"type":"TvlentCarChargeAttributes","kind":"example","amount":1250,"vatIndicator":"example"}]}],"type":"object","required":["type","currency","rentalCompanyCode","contractNumber","vehicleClassCode","vehicleType","noShow","pickUpLocationCode","pickUpLocationCity","returnLocationCode","returnLocationCity","rentalDays","mileageIndicator"],"properties":{"type":{"description":"Always `TvlentServiceLineCar`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvlentServiceLineCar"]},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"rentalCompanyCode":{"type":"string"},"contractNumber":{"type":"string"},"vehicleClassCode":{"type":"string"},"vehicleType":{"type":"string"},"noShow":{"type":"boolean"},"pickUpDate":{"type":"string","format":"date"},"pickUpTime":{"type":"string"},"pickUpLocationCode":{"type":"string"},"pickUpLocationCity":{"type":"string"},"returnDate":{"type":"string","format":"date"},"returnTime":{"type":"string"},"returnLocationCode":{"type":"string"},"returnLocationCity":{"type":"string"},"rentalDays":{"type":"integer","format":"int32"},"mileageIndicator":{"type":"string"},"drivenDistance":{"description":"The distance driven, as a decimal string.","type":"string"},"charges":{"type":"array","items":{"$ref":"#/components/schemas/TvlentCarCharge"}}}},"TvlentServiceLineFee":{"title":"TvlentServiceLineFee","description":"A fee. Its matching criteria are not published: for a booking-engine fee they are the card number the booking was made with.","examples":[{"type":"TvlentServiceLineFee","originator":"example","serviceQualifier":"example","documentNumberFormat":"2026-08-19T04:21:07Z","relatedDocumentNumber":"example","crs":"example","title":"example"}],"type":"object","required":["type","originator","serviceQualifier","documentNumberFormat","relatedDocumentNumber","crs","title"],"properties":{"type":{"description":"Always `TvlentServiceLineFee`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvlentServiceLineFee"]},"originator":{"type":"string"},"serviceQualifier":{"type":"string"},"documentNumberFormat":{"type":"string"},"relatedDocumentNumber":{"type":"string"},"crs":{"type":"string"},"title":{"type":"string"}}},"TvlentServiceLineFlight":{"title":"TvlentServiceLineFlight","description":"A flight. Its taxes are in `currency`.","examples":[{"type":"TvlentServiceLineFlight","currency":"AUD","departureDate":"2026-08-19","originLocation":"example","crs":"example","passengerCount":42,"conjunctionTickets":["example"],"segmentOverflow":true,"ticketIndicator":"example","tourCode":"example","taxes":[{"type":"TvlentFlightTaxAttributes","taxType":"example","amount":1250}],"segments":[{"type":"TvlentFlightSegmentAttributes","destination":"example","airline":"example","flight":"example","flightClass":"example"}]}],"type":"object","required":["type","currency","originLocation","crs","passengerCount","segmentOverflow","ticketIndicator","tourCode"],"properties":{"type":{"description":"Always `TvlentServiceLineFlight`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvlentServiceLineFlight"]},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"departureDate":{"type":"string","format":"date"},"originLocation":{"type":"string"},"crs":{"type":"string"},"passengerCount":{"type":"integer","format":"int32"},"conjunctionTickets":{"type":"array","items":{"type":"string"}},"segmentOverflow":{"type":"boolean"},"ticketIndicator":{"type":"string"},"tourCode":{"type":"string"},"taxes":{"type":"array","items":{"$ref":"#/components/schemas/TvlentFlightTax"}},"segments":{"type":"array","items":{"$ref":"#/components/schemas/TvlentFlightSegment"}}}},"TvlentServiceLineHotel":{"title":"TvlentServiceLineHotel","description":"A hotel stay. Its room amount and services are in `currency`.","examples":[{"type":"TvlentServiceLineHotel","currency":"AUD","companyCode":"example","contractNumber":"example","name":"Ada Lovelace","stayReasonIndicator":"Requested by the customer.","noShow":true,"checkInDate":"2026-08-19","checkInTime":"example","checkOutDate":"2026-08-19","checkOutTime":"example","locationCode":"example","locationCity":"example","guestCount":42,"nights":1250,"netRoomAmount":1250,"netRoomVatIndicator":"example","prepaidExpenses":1250,"description":"A short description.","services":[{"type":"TvlentHotelChargeAttributes","code":"example","amount":1250,"vatIndicator":"example"}]}],"type":"object","required":["type","currency","companyCode","contractNumber","name","stayReasonIndicator","noShow","locationCode","locationCity","guestCount","nights","netRoomAmount","netRoomVatIndicator","prepaidExpenses","description"],"properties":{"type":{"description":"Always `TvlentServiceLineHotel`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvlentServiceLineHotel"]},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"companyCode":{"type":"string"},"contractNumber":{"type":"string"},"name":{"type":"string"},"stayReasonIndicator":{"type":"string"},"noShow":{"type":"boolean"},"checkInDate":{"type":"string","format":"date"},"checkInTime":{"type":"string"},"checkOutDate":{"type":"string","format":"date"},"checkOutTime":{"type":"string"},"locationCode":{"type":"string"},"locationCity":{"type":"string"},"guestCount":{"type":"integer","format":"int32"},"nights":{"type":"integer","format":"int32"},"netRoomAmount":{"$ref":"#/components/schemas/MinorUnits","description":"An amount in the minor units of the currency given by the enclosing object's `currency` field."},"netRoomVatIndicator":{"type":"string"},"prepaidExpenses":{"type":"integer","format":"int32"},"description":{"type":"string"},"services":{"type":"array","items":{"$ref":"#/components/schemas/TvlentHotelCharge"}}}},"TvlentServiceLineOther":{"title":"TvlentServiceLineOther","description":"Any other service. Its matching criteria are not published.","examples":[{"type":"TvlentServiceLineOther","descriptions":["A short description."]}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `TvlentServiceLineOther`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvlentServiceLineOther"]},"descriptions":{"type":"array","items":{"type":"string"}}}},"TvlentServiceLineShip":{"title":"TvlentServiceLineShip","description":"A sea journey.","examples":[{"type":"TvlentServiceLineShip","companyName":"Ada Lovelace","departureDate":"2026-08-19","originCode":"example","originCity":"example","passengerCount":42,"arrivalDate":"2026-08-19","arrivalCode":"example","arrivalCity":"example","descriptions":["A short description."]}],"type":"object","required":["type","companyName","originCode","originCity","passengerCount","arrivalCode","arrivalCity"],"properties":{"type":{"description":"Always `TvlentServiceLineShip`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvlentServiceLineShip"]},"companyName":{"type":"string"},"departureDate":{"type":"string","format":"date"},"originCode":{"type":"string"},"originCity":{"type":"string"},"passengerCount":{"type":"integer","format":"int32"},"arrivalDate":{"type":"string","format":"date"},"arrivalCode":{"type":"string"},"arrivalCity":{"type":"string"},"descriptions":{"type":"array","items":{"type":"string"}}}},"TvlentServiceLineTrain":{"title":"TvlentServiceLineTrain","description":"A rail journey.","examples":[{"type":"TvlentServiceLineTrain","companyName":"Ada Lovelace","departureDate":"2026-08-19","originCode":"example","originCity":"example","passengerCount":42,"ticketType":"example","segmentOverflow":true,"finalDestinationCode":"example","finalDestinationCity":"example","description":"A short description.","segments":[{"type":"TvlentTrainSegmentAttributes","destinationCode":"example","destinationCity":"example","trainNumber":"example","trainClass":"example"}]}],"type":"object","required":["type","companyName","originCode","originCity","passengerCount","ticketType","segmentOverflow","finalDestinationCode","finalDestinationCity","description"],"properties":{"type":{"description":"Always `TvlentServiceLineTrain`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvlentServiceLineTrain"]},"companyName":{"type":"string"},"departureDate":{"type":"string","format":"date"},"originCode":{"type":"string"},"originCity":{"type":"string"},"passengerCount":{"type":"integer","format":"int32"},"ticketType":{"type":"string"},"segmentOverflow":{"type":"boolean"},"finalDestinationCode":{"type":"string"},"finalDestinationCity":{"type":"string"},"description":{"type":"string"},"segments":{"type":"array","items":{"$ref":"#/components/schemas/TvlentTrainSegment"}}}},"TvlentSign":{"title":"TvlentSign","type":"string","enum":["Purchase","Refund","Unknown"]},"TvlentSort":{"title":"TvlentSort","type":"string","enum":["createdAt","-createdAt","updatedAt","-updatedAt","lineNumber","-lineNumber","documentNumber","-documentNumber","matchStatus","-matchStatus","dbiStatus","-dbiStatus"]},"TvlentTrainSegment":{"description":"One leg of a rail journey.","oneOf":[{"$ref":"#/components/schemas/TvlentTrainSegmentAttributes"}],"discriminator":{"propertyName":"type","mapping":{"TvlentTrainSegmentAttributes":"#/components/schemas/TvlentTrainSegmentAttributes"}}},"TvlentTrainSegmentAttributes":{"title":"TvlentTrainSegmentAttributes","description":"One leg of a rail journey.","examples":[{"type":"TvlentTrainSegmentAttributes","destinationCode":"example","destinationCity":"example","trainNumber":"example","trainClass":"example"}],"type":"object","required":["type","destinationCode","destinationCity","trainNumber","trainClass"],"properties":{"type":{"description":"Always `TvlentTrainSegmentAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvlentTrainSegmentAttributes"]},"destinationCode":{"type":"string"},"destinationCity":{"type":"string"},"trainNumber":{"type":"string"},"trainClass":{"type":"string"}}},"TvlentUpdate":{"oneOf":[{"$ref":"#/components/schemas/TvlentUpdateCorrect"},{"$ref":"#/components/schemas/TvlentUpdateMatchNow"},{"$ref":"#/components/schemas/TvlentUpdateRelinkOriginal"},{"$ref":"#/components/schemas/TvlentUpdateResetRefundedAmount"},{"$ref":"#/components/schemas/TvlentUpdateSettleMatch"}],"discriminator":{"propertyName":"type","mapping":{"TvlentUpdateCorrect":"#/components/schemas/TvlentUpdateCorrect","TvlentUpdateMatchNow":"#/components/schemas/TvlentUpdateMatchNow","TvlentUpdateRelinkOriginal":"#/components/schemas/TvlentUpdateRelinkOriginal","TvlentUpdateResetRefundedAmount":"#/components/schemas/TvlentUpdateResetRefundedAmount","TvlentUpdateSettleMatch":"#/components/schemas/TvlentUpdateSettleMatch"}}},"TvlentUpdateCorrect":{"title":"TvlentUpdateCorrect","description":"Correct what the entry says it was: the document, the traveller, the amounts, the approval and the merchant's own details, as the portal's edit does. The card's expiry and the service lines are not edited here. Every field is replaced, so send the entry as it should read.","examples":[{"type":"TvlentUpdateCorrect","documentNumberFormat":"2026-08-19T04:21:07Z","documentNumber":"example","serialNumber":"example","purchaseDate":"2026-08-19","travellerName":"Ada Lovelace","amounts":{"type":"TvlentCorrectedAmountsAttributes","currency":"AUD","amount":1250,"netAmountNonVatable":1250,"netAmountVatable":1250,"vatAmount":1250,"vatPercentage":"example","vatIndicator":"example"},"approvalCode":"example","merchantDetails":{"type":"TvlentMerchantDetailsAttributes","name":"Ada Lovelace","city":"example","zipCode":"example","stateCode":"example","iataNumber":"example","invoiceNumber":"example","orderNumber":"example","customerNumber":"example","agencyDossierNumber":"example","agencyDeliveryNoteNumber":"example"},"usageCode":"example"}],"type":"object","required":["type","documentNumberFormat","documentNumber","serialNumber","amounts","approvalCode","merchantDetails","usageCode"],"properties":{"type":{"description":"Always `TvlentUpdateCorrect`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvlentUpdateCorrect"]},"documentNumberFormat":{"type":"string"},"documentNumber":{"type":"string"},"serialNumber":{"type":"string"},"purchaseDate":{"type":"string","format":"date"},"travellerName":{"type":"string"},"amounts":{"$ref":"#/components/schemas/TvlentCorrectedAmounts"},"approvalCode":{"type":"string"},"merchantDetails":{"$ref":"#/components/schemas/TvlentMerchantDetails"},"usageCode":{"type":"string"}}},"TvlentUpdateMatchNow":{"title":"TvlentUpdateMatchNow","description":"Match the entry to its payment now, instead of waiting for the sweep. It acts on a purchase or a refund as the entry's `sign` says, and answers with the entry as the matching left it.","examples":[{"type":"TvlentUpdateMatchNow"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `TvlentUpdateMatchNow`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvlentUpdateMatchNow"]}}},"TvlentUpdateRelinkOriginal":{"title":"TvlentUpdateRelinkOriginal","description":"Say which purchase this refund refunds, or none, which staff do for a refund the matching could not place. Moves the refunded amount from the old original to the new.","examples":[{"type":"TvlentUpdateRelinkOriginal","originalTravelEntryId":"tvlent_9f2Kd8QpLzXw","matchAgain":true}],"type":"object","required":["type","matchAgain"],"properties":{"type":{"description":"Always `TvlentUpdateRelinkOriginal`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvlentUpdateRelinkOriginal"]},"originalTravelEntryId":{"$ref":"#/components/schemas/TvlentId","description":"The purchase to link, or absent to unlink."},"matchAgain":{"description":"Whether to make the matching look again, which a failed refund waits for.","type":"boolean"}}},"TvlentUpdateResetRefundedAmount":{"title":"TvlentUpdateResetRefundedAmount","description":"Set how much of the entry has been refunded, which the portal reads to decide how much more may be refunded. Staff only: it overrides what the refunds recorded, and `refunded.currency` must be the entry's currency.","examples":[{"type":"TvlentUpdateResetRefundedAmount","refunded":{"type":"IsoCurrencyAmount","minorCurrencyUnits":1250,"currency":"AUD"}}],"type":"object","required":["type","refunded"],"properties":{"type":{"description":"Always `TvlentUpdateResetRefundedAmount`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvlentUpdateResetRefundedAmount"]},"refunded":{"$ref":"#/components/schemas/IsoCurrencyAmount","description":"An amount in minor current units of a given currency."}}},"TvlentUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/TvlentUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"TvlentUpdateRspAttributes":"#/components/schemas/TvlentUpdateRspAttributes"}}},"TvlentUpdateRspAttributes":{"title":"TvlentUpdateRspAttributes","examples":[{"type":"TvlentUpdateRspAttributes","updated":{"type":"TvlentViewAttributes","travelEntryId":"tvlent_9f2Kd8QpLzXw","travelFileId":"tvlfile_9f2Kd8QpLzXw","travelBatchId":"tvlbat_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","ownerMerchantId":"mcht_9f2Kd8QpLzXw","fileType":"Merchant","processingDate":"2026-08-19","lineNumber":1250,"serviceKind":"Flight","sign":"Purchase","cardType":"Uatp","hasCardToken":true,"documentNumberFormat":"2026-08-19T04:21:07Z","documentNumber":"example","serialNumber":"example","purchaseDate":"2026-08-19","travellerName":"Ada Lovelace","amounts":{"type":"TvlentAmountsAttributes","currency":"AUD","amount":1250,"netAmountNonVatable":1250,"netAmountVatable":1250,"vatAmount":1250,"refundedAmount":1250,"vatPercentage":"example","vatIndicator":"example"},"approvalCode":"example","merchantDetails":{"type":"TvlentMerchantDetailsAttributes","name":"Ada Lovelace","city":"example","zipCode":"example","stateCode":"example","iataNumber":"example","invoiceNumber":"example","orderNumber":"example","customerNumber":"example","agencyDossierNumber":"example","agencyDeliveryNoteNumber":"example"},"usageCode":"example","validation":"Passed","dbi":{"type":"TvlentDbiAttributes","pk":"example","ds":"example","ks":"example","ae":"example","ik":"example","bd":"2026-08-19","pr":"example","au":"example","ak":"example","rz":"example","status":"NotRequired","statusAt":"2026-08-19T04:21:07Z","statusMessage":"Active","mandatoryFields":"example"},"authorisation":{"type":"TvlentAuthorisationAttributes","operator":"ApgPay","status":"NotRequired","statusAt":"2026-08-19T04:21:07Z","statusMessage":"Active","refundStatus":"NotRequired","refundStatusAt":"2026-08-19T04:21:07Z"},"matching":{"type":"TvlentMatchAttributes","status":"NotRequired","statusAt":"2026-08-19T04:21:07Z","statusMessage":"Active","timedOut":true,"needsManualOriginalMatch":true,"originalTravelEntryId":"tvlent_9f2Kd8QpLzXw","transactionId":"tran_9f2Kd8QpLzXw","refundId":"rfnd_9f2Kd8QpLzXw","issuerTransactionId":"itxn_9f2Kd8QpLzXw","issuerRefundId":"rfnd_9f2Kd8QpLzXw","loanId":"loan_9f2Kd8QpLzXw","customerId":"cust_9f2Kd8QpLzXw"},"enabled":true,"serviceLines":[{"type":"TvlentServiceLineCar","currency":"AUD","rentalCompanyCode":"example","contractNumber":"example","vehicleClassCode":"example","vehicleType":"example","noShow":true,"pickUpDate":"2026-08-19","pickUpTime":"example","pickUpLocationCode":"example","pickUpLocationCity":"example","returnDate":"2026-08-19","returnTime":"example","returnLocationCode":"example","returnLocationCity":"example","rentalDays":1250,"mileageIndicator":"example","drivenDistance":"example","charges":[{"type":"TvlentCarChargeAttributes","kind":"example","amount":1250,"vatIndicator":"example"}]}],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `TvlentUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvlentUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/TvlentView","description":"The resource as it stands after the change."}}},"TvlentUpdateSettleMatch":{"title":"TvlentUpdateSettleMatch","description":"Record by hand the result of matching the entry with the platform's payments, where the sweep could not settle it. Staff only. A matched purchase must name its card transaction and a matched refund its card refund. Only the references given change.","examples":[{"type":"TvlentUpdateSettleMatch","status":"NotRequired","statusMessage":"Active","transactionId":"tran_9f2Kd8QpLzXw","refundId":"rfnd_9f2Kd8QpLzXw","issuerTransactionId":"itxn_9f2Kd8QpLzXw","issuerRefundId":"rfnd_9f2Kd8QpLzXw"}],"type":"object","required":["type","status"],"properties":{"type":{"description":"Always `TvlentUpdateSettleMatch`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvlentUpdateSettleMatch"]},"status":{"$ref":"#/components/schemas/TvlentMatchStatus"},"statusMessage":{"type":"string"},"transactionId":{"$ref":"#/components/schemas/TranId","description":"The payment the entry was matched to."},"refundId":{"$ref":"#/components/schemas/RfndId","description":"The refund the entry was matched to."},"issuerTransactionId":{"$ref":"#/components/schemas/ItxnId","description":"The card transaction the entry was matched to."},"issuerRefundId":{"$ref":"#/components/schemas/ItxnId","description":"The card refund the entry was matched to."}}},"TvlentView":{"oneOf":[{"$ref":"#/components/schemas/TvlentViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"TvlentViewAttributes":"#/components/schemas/TvlentViewAttributes"}}},"TvlentViewAttributes":{"title":"TvlentViewAttributes","description":"One transaction line of a travel file: what was bought, its amounts, the references the data-based invoicing check reads, where authorising and matching it to a payment have got to, and what it paid for. The card is not published, only whether the line carries one.","examples":[{"type":"TvlentViewAttributes","travelEntryId":"tvlent_9f2Kd8QpLzXw","travelFileId":"tvlfile_9f2Kd8QpLzXw","travelBatchId":"tvlbat_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","ownerMerchantId":"mcht_9f2Kd8QpLzXw","fileType":"Merchant","processingDate":"2026-08-19","lineNumber":1250,"serviceKind":"Flight","sign":"Purchase","cardType":"Uatp","hasCardToken":true,"documentNumberFormat":"2026-08-19T04:21:07Z","documentNumber":"example","serialNumber":"example","purchaseDate":"2026-08-19","travellerName":"Ada Lovelace","amounts":{"type":"TvlentAmountsAttributes","currency":"AUD","amount":1250,"netAmountNonVatable":1250,"netAmountVatable":1250,"vatAmount":1250,"refundedAmount":1250,"vatPercentage":"example","vatIndicator":"example"},"approvalCode":"example","merchantDetails":{"type":"TvlentMerchantDetailsAttributes","name":"Ada Lovelace","city":"example","zipCode":"example","stateCode":"example","iataNumber":"example","invoiceNumber":"example","orderNumber":"example","customerNumber":"example","agencyDossierNumber":"example","agencyDeliveryNoteNumber":"example"},"usageCode":"example","validation":"Passed","dbi":{"type":"TvlentDbiAttributes","pk":"example","ds":"example","ks":"example","ae":"example","ik":"example","bd":"2026-08-19","pr":"example","au":"example","ak":"example","rz":"example","status":"NotRequired","statusAt":"2026-08-19T04:21:07Z","statusMessage":"Active","mandatoryFields":"example"},"authorisation":{"type":"TvlentAuthorisationAttributes","operator":"ApgPay","status":"NotRequired","statusAt":"2026-08-19T04:21:07Z","statusMessage":"Active","refundStatus":"NotRequired","refundStatusAt":"2026-08-19T04:21:07Z"},"matching":{"type":"TvlentMatchAttributes","status":"NotRequired","statusAt":"2026-08-19T04:21:07Z","statusMessage":"Active","timedOut":true,"needsManualOriginalMatch":true,"originalTravelEntryId":"tvlent_9f2Kd8QpLzXw","transactionId":"tran_9f2Kd8QpLzXw","refundId":"rfnd_9f2Kd8QpLzXw","issuerTransactionId":"itxn_9f2Kd8QpLzXw","issuerRefundId":"rfnd_9f2Kd8QpLzXw","loanId":"loan_9f2Kd8QpLzXw","customerId":"cust_9f2Kd8QpLzXw"},"enabled":true,"serviceLines":[{"type":"TvlentServiceLineCar","currency":"AUD","rentalCompanyCode":"example","contractNumber":"example","vehicleClassCode":"example","vehicleType":"example","noShow":true,"pickUpDate":"2026-08-19","pickUpTime":"example","pickUpLocationCode":"example","pickUpLocationCity":"example","returnDate":"2026-08-19","returnTime":"example","returnLocationCode":"example","returnLocationCity":"example","rentalDays":1250,"mileageIndicator":"example","drivenDistance":"example","charges":[{"type":"TvlentCarChargeAttributes","kind":"example","amount":1250,"vatIndicator":"example"}]}],"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","travelEntryId","travelFileId","travelBatchId","merchantId","ownerMerchantId","fileType","processingDate","lineNumber","cardType","hasCardToken","documentNumberFormat","documentNumber","serialNumber","amounts","approvalCode","merchantDetails","usageCode","validation","dbi","authorisation","matching","enabled","createdAt","updatedAt"],"properties":{"type":{"description":"Always `TvlentViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvlentViewAttributes"]},"travelEntryId":{"$ref":"#/components/schemas/TvlentId","description":"Identifier of a travel entry."},"travelFileId":{"$ref":"#/components/schemas/TvlfileId","description":"The file it came in. Read it at `/travel-files/{travelFileId}`."},"travelBatchId":{"$ref":"#/components/schemas/TvlfileBatchId","description":"The batch it came in."},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"The merchant the file was uploaded for."},"ownerMerchantId":{"$ref":"#/components/schemas/MchtId","description":"The merchant the entry belongs to, which is who the portal reads it as."},"fileType":{"$ref":"#/components/schemas/TvlfileType"},"processingDate":{"type":"string","format":"date"},"lineNumber":{"description":"The line of the file the entry was read from.","type":"integer","format":"int32"},"serviceKind":{"$ref":"#/components/schemas/TvlentServiceKind"},"sign":{"$ref":"#/components/schemas/TvlentSign"},"cardType":{"$ref":"#/components/schemas/TvlentCardType"},"hasCardToken":{"description":"Whether the line carried a tokenised card. The token itself is never published.","type":"boolean"},"documentNumberFormat":{"type":"string"},"documentNumber":{"type":"string"},"serialNumber":{"type":"string"},"purchaseDate":{"type":"string","format":"date"},"travellerName":{"description":"The traveller's name, as the line stated it.","type":"string"},"amounts":{"$ref":"#/components/schemas/TvlentAmounts"},"approvalCode":{"type":"string"},"merchantDetails":{"$ref":"#/components/schemas/TvlentMerchantDetails"},"usageCode":{"type":"string"},"validation":{"$ref":"#/components/schemas/TvlfileValidation"},"dbi":{"$ref":"#/components/schemas/TvlentDbi"},"authorisation":{"$ref":"#/components/schemas/TvlentAuthorisation"},"matching":{"$ref":"#/components/schemas/TvlentMatch"},"enabled":{"description":"Whether the entry is still live. A disabled entry has been superseded.","type":"boolean"},"serviceLines":{"description":"What the entry paid for. Empty for a commission or TASF line.","type":"array","items":{"$ref":"#/components/schemas/TvlentServiceLine"}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"TvlfileBatch":{"description":"One batch of a travel file, from its header to its trailer. Its totals are not held: they are the sums of its entries.","oneOf":[{"$ref":"#/components/schemas/TvlfileBatchAttributes"}],"discriminator":{"propertyName":"type","mapping":{"TvlfileBatchAttributes":"#/components/schemas/TvlfileBatchAttributes"}}},"TvlfileBatchAttributes":{"title":"TvlfileBatchAttributes","description":"One batch of a travel file, from its header to its trailer. Its totals are not held: they are the sums of its entries.","examples":[{"type":"TvlfileBatchAttributes","travelBatchId":"tvlbat_9f2Kd8QpLzXw","ownerMerchantId":"mcht_9f2Kd8QpLzXw","partnerCode":"example","fileType":"Merchant","processingDate":"2026-08-19","version":"example","release":"example","countryCode":"AU","acquirerPrefix":"example","processingPage":"example","creditCardIndicator":"example","bosReference":"your-own-reference","fileReference":"your-own-reference","recordCount":42,"startLine":1250,"endLine":1250,"currency":"AUD","parseStatus":"NotRequired","dealStatus":"Waiting","validation":"Passed"}],"type":"object","required":["type","travelBatchId","ownerMerchantId","partnerCode","fileType","processingDate","version","release","countryCode","acquirerPrefix","processingPage","creditCardIndicator","bosReference","fileReference","recordCount","startLine","endLine","parseStatus","dealStatus","validation"],"properties":{"type":{"description":"Always `TvlfileBatchAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvlfileBatchAttributes"]},"travelBatchId":{"$ref":"#/components/schemas/TvlfileBatchId","description":"Identifier of a batch of a travel file."},"ownerMerchantId":{"$ref":"#/components/schemas/MchtId","description":"The merchant the batch's entries belong to."},"partnerCode":{"description":"The twelve-digit merchant code the batch's header states.","type":"string"},"fileType":{"$ref":"#/components/schemas/TvlfileType"},"processingDate":{"type":"string","format":"date"},"version":{"description":"The file layout version, such as `V02.01`.","type":"string"},"release":{"type":"string"},"countryCode":{"type":"string"},"acquirerPrefix":{"type":"string"},"processingPage":{"description":"The acquirer processing page the header states.","type":"string"},"creditCardIndicator":{"type":"string"},"bosReference":{"type":"string"},"fileReference":{"type":"string"},"recordCount":{"type":"integer","format":"int32"},"startLine":{"description":"The line of the file the batch starts on.","type":"integer","format":"int32"},"endLine":{"type":"integer","format":"int32"},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"parseStatus":{"$ref":"#/components/schemas/TvlfileParseStatus"},"dealStatus":{"$ref":"#/components/schemas/TvlfileDealStatus"},"validation":{"$ref":"#/components/schemas/TvlfileValidation"}}},"TvlfileBatchId":{"title":"TvlfileBatchId","examples":["tvlbat_9f2Kd8QpLzXw"],"type":"string"},"TvlfileBatchPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/TvlfileBatchPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"TvlfileBatchPageAttributes":"#/components/schemas/TvlfileBatchPageAttributes"}}},"TvlfileBatchPageAttributes":{"title":"TvlfileBatchPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"TvlfileBatchPageAttributes","data":[{"type":"TvlfileBatchAttributes","travelBatchId":"tvlbat_9f2Kd8QpLzXw","ownerMerchantId":"mcht_9f2Kd8QpLzXw","partnerCode":"example","fileType":"Merchant","processingDate":"2026-08-19","version":"example","release":"example","countryCode":"AU","acquirerPrefix":"example","processingPage":"example","creditCardIndicator":"example","bosReference":"your-own-reference","fileReference":"your-own-reference","recordCount":42,"startLine":1250,"endLine":1250,"currency":"AUD","parseStatus":"NotRequired","dealStatus":"Waiting","validation":"Passed"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `TvlfileBatchPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvlfileBatchPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/TvlfileBatch"}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"TvlfileColumn":{"title":"TvlfileColumn","type":"string","enum":["TravelFileId","MerchantId","MerchantCode","Name","TokenisedName","FileType","Currency","ParseStatus","DealStatus","ReportStatus","Validation","CreatedAt","UpdatedAt"]},"TvlfileDealStatus":{"title":"TvlfileDealStatus","type":"string","enum":["Waiting","Processing","Processed","Unknown"]},"TvlfileError":{"description":"A record of a travel file that failed its checks. It names the line it failed on but never carries the line, which held a card number.","oneOf":[{"$ref":"#/components/schemas/TvlfileErrorAttributes"}],"discriminator":{"propertyName":"type","mapping":{"TvlfileErrorAttributes":"#/components/schemas/TvlfileErrorAttributes"}}},"TvlfileErrorAttributes":{"title":"TvlfileErrorAttributes","description":"A record of a travel file that failed its checks. It names the line it failed on but never carries the line, which held a card number.","examples":[{"type":"TvlfileErrorAttributes","travelFileErrorId":"tvlerr_9f2Kd8QpLzXw","errorType":"File","travelBatchId":"tvlbat_9f2Kd8QpLzXw","travelEntryId":"tvlent_9f2Kd8QpLzXw","lineNumber":1250,"codes":[{"type":"TvlfileErrorCodeAttributes","code":"example","message":"example"}],"corrected":true,"timedOut":true,"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","travelFileErrorId","errorType","corrected","timedOut","createdAt","updatedAt"],"properties":{"type":{"description":"Always `TvlfileErrorAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvlfileErrorAttributes"]},"travelFileErrorId":{"$ref":"#/components/schemas/TvlfileErrorId"},"errorType":{"$ref":"#/components/schemas/TvlfileErrorType"},"travelBatchId":{"$ref":"#/components/schemas/TvlfileBatchId","description":"The batch it failed in, where it belongs to one."},"travelEntryId":{"$ref":"#/components/schemas/TvlentId","description":"The entry it failed on, where it belongs to one. Read it at `/travel-entries/{travelEntryId}`."},"lineNumber":{"description":"The line of the file it failed on.","type":"integer","format":"int32"},"codes":{"description":"The codes it raised, in the order they were raised.","type":"array","items":{"$ref":"#/components/schemas/TvlfileErrorCode"}},"corrected":{"description":"Whether the merchant has since corrected it.","type":"boolean"},"timedOut":{"description":"Whether it failed because a check gave up waiting rather than because the data was wrong.","type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"TvlfileErrorCode":{"description":"One reason a record failed: the error code and what the checks said about it.","oneOf":[{"$ref":"#/components/schemas/TvlfileErrorCodeAttributes"}],"discriminator":{"propertyName":"type","mapping":{"TvlfileErrorCodeAttributes":"#/components/schemas/TvlfileErrorCodeAttributes"}}},"TvlfileErrorCodeAttributes":{"title":"TvlfileErrorCodeAttributes","description":"One reason a record failed: the error code and what the checks said about it.","examples":[{"type":"TvlfileErrorCodeAttributes","code":"example","message":"example"}],"type":"object","required":["type","code","message"],"properties":{"type":{"description":"Always `TvlfileErrorCodeAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvlfileErrorCodeAttributes"]},"code":{"description":"The check's code, such as `00302`.","type":"string"},"message":{"type":"string"}}},"TvlfileErrorId":{"title":"TvlfileErrorId","description":"Identifier of a failed record of a travel file.","examples":["tvlerr_9f2Kd8QpLzXw"],"type":"string"},"TvlfileErrorPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/TvlfileErrorPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"TvlfileErrorPageAttributes":"#/components/schemas/TvlfileErrorPageAttributes"}}},"TvlfileErrorPageAttributes":{"title":"TvlfileErrorPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"TvlfileErrorPageAttributes","data":[{"type":"TvlfileErrorAttributes","travelFileErrorId":"tvlerr_9f2Kd8QpLzXw","errorType":"File","travelBatchId":"tvlbat_9f2Kd8QpLzXw","travelEntryId":"tvlent_9f2Kd8QpLzXw","lineNumber":1250,"codes":[{"type":"TvlfileErrorCodeAttributes","code":"example","message":"example"}],"corrected":true,"timedOut":true,"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `TvlfileErrorPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvlfileErrorPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/TvlfileError"}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"TvlfileErrorType":{"title":"TvlfileErrorType","type":"string","enum":["File","Batch","Entry","DbiValidation","Authorisation","AuthorisationRefund","Unknown"]},"TvlfileId":{"title":"TvlfileId","examples":["tvlfile_9f2Kd8QpLzXw"],"type":"string"},"TvlfilePage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/TvlfilePageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"TvlfilePageAttributes":"#/components/schemas/TvlfilePageAttributes"}}},"TvlfilePageAttributes":{"title":"TvlfilePageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"TvlfilePageAttributes","data":[{"type":"TvlfileViewAttributes","travelFileId":"tvlfile_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","merchantCode":"example","name":"Ada Lovelace","tokenisedName":"Ada Lovelace","fileType":"Merchant","currency":"AUD","parseStatus":"NotRequired","dealStatus":"Waiting","reportStatus":"Waiting","validation":"Passed","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `TvlfilePageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvlfilePageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/TvlfileView"}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"TvlfileParseStatus":{"title":"TvlfileParseStatus","type":"string","enum":["NotRequired","Waiting","Processing","Parsed","Failed","Unknown"]},"TvlfileReportStatus":{"title":"TvlfileReportStatus","description":"Whether the file's quality-check report has gone to the partner.","type":"string","enum":["Waiting","Sent","Failed","Unknown"]},"TvlfileSort":{"title":"TvlfileSort","type":"string","enum":["createdAt","-createdAt","updatedAt","-updatedAt","name","-name"]},"TvlfileType":{"title":"TvlfileType","type":"string","enum":["Merchant","Bsp","Enrichment","Unknown"]},"TvlfileValidation":{"title":"TvlfileValidation","type":"string","enum":["Passed","Failed","Unknown"]},"TvlfileView":{"description":"One physical travel file a merchant sent. Its batches and the records that failed are read under it.","oneOf":[{"$ref":"#/components/schemas/TvlfileViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"TvlfileViewAttributes":"#/components/schemas/TvlfileViewAttributes"}}},"TvlfileViewAttributes":{"title":"TvlfileViewAttributes","description":"One physical travel file a merchant sent. Its batches and the records that failed are read under it.","examples":[{"type":"TvlfileViewAttributes","travelFileId":"tvlfile_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","merchantCode":"example","name":"Ada Lovelace","tokenisedName":"Ada Lovelace","fileType":"Merchant","currency":"AUD","parseStatus":"NotRequired","dealStatus":"Waiting","reportStatus":"Waiting","validation":"Passed","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","travelFileId","merchantId","name","fileType","parseStatus","dealStatus","reportStatus","validation","createdAt","updatedAt"],"properties":{"type":{"description":"Always `TvlfileViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvlfileViewAttributes"]},"travelFileId":{"$ref":"#/components/schemas/TvlfileId","description":"Identifier of a travel file."},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"Identifier of a merchant."},"merchantCode":{"description":"The merchant's twelve-digit code, as the file's headers state it.","type":"string"},"name":{"type":"string"},"tokenisedName":{"description":"The name of the copy of the file kept once its card numbers were tokenised.","type":"string"},"fileType":{"$ref":"#/components/schemas/TvlfileType"},"currency":{"$ref":"#/components/schemas/IsoCurrency","description":"The currency of the file's transactions, once it is known."},"parseStatus":{"$ref":"#/components/schemas/TvlfileParseStatus"},"dealStatus":{"$ref":"#/components/schemas/TvlfileDealStatus"},"reportStatus":{"$ref":"#/components/schemas/TvlfileReportStatus"},"validation":{"$ref":"#/components/schemas/TvlfileValidation","description":"Whether the file passed its checks."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"TvlsetId":{"title":"TvlsetId","description":"Identifier of a merchant's travel settings, which is the merchant's own identifier.","examples":["mcht_9f2Kd8QpLzXw"],"type":"string"},"TvlsetReminder":{"description":"When a merchant who has sent no travel file is reminded to.","oneOf":[{"$ref":"#/components/schemas/TvlsetReminderAttributes"}],"discriminator":{"propertyName":"type","mapping":{"TvlsetReminderAttributes":"#/components/schemas/TvlsetReminderAttributes"}}},"TvlsetReminderAttributes":{"title":"TvlsetReminderAttributes","description":"When a merchant who has sent no travel file is reminded to.","examples":[{"type":"TvlsetReminderAttributes","enabled":true,"schedule":"Never","weekday":"Sunday"}],"type":"object","required":["type","enabled","schedule"],"properties":{"type":{"description":"Always `TvlsetReminderAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvlsetReminderAttributes"]},"enabled":{"type":"boolean"},"schedule":{"$ref":"#/components/schemas/TvlsetReminderSchedule"},"weekday":{"$ref":"#/components/schemas/TvlsetWeekday"}}},"TvlsetReminderSchedule":{"title":"TvlsetReminderSchedule","type":"string","enum":["Never","Daily","Weekly","Unknown"]},"TvlsetUpdate":{"oneOf":[{"$ref":"#/components/schemas/TvlsetUpdateSettings"}],"discriminator":{"propertyName":"type","mapping":{"TvlsetUpdateSettings":"#/components/schemas/TvlsetUpdateSettings"}}},"TvlsetUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/TvlsetUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"TvlsetUpdateRspAttributes":"#/components/schemas/TvlsetUpdateRspAttributes"}}},"TvlsetUpdateRspAttributes":{"title":"TvlsetUpdateRspAttributes","examples":[{"type":"TvlsetUpdateRspAttributes","updated":{"type":"TvlsetViewAttributes","merchantTravelSettingsId":"mcht_9f2Kd8QpLzXw","merchantCode":"example","fileVersions":["example"],"datePostponeEnabled":true,"postponeMonths":6,"reminder":{"type":"TvlsetReminderAttributes","enabled":true,"schedule":"Never","weekday":"Sunday"},"tqcReportEmails":["ada@example.com"],"lastReminderOn":"2026-08-19","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `TvlsetUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvlsetUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/TvlsetView","description":"The resource as it stands after the change."}}},"TvlsetUpdateSettings":{"title":"TvlsetUpdateSettings","description":"Replace what the merchant may change: its file versions, date postponement, reminders and report addresses. Every field is sent.","examples":[{"type":"TvlsetUpdateSettings","fileVersions":["example"],"datePostponeEnabled":true,"postponeMonths":6,"reminder":{"type":"TvlsetReminderAttributes","enabled":true,"schedule":"Never","weekday":"Sunday"},"tqcReportEmails":["ada@example.com"]}],"type":"object","required":["type","datePostponeEnabled","postponeMonths","reminder"],"properties":{"type":{"description":"Always `TvlsetUpdateSettings`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvlsetUpdateSettings"]},"fileVersions":{"type":"array","items":{"type":"string"}},"datePostponeEnabled":{"type":"boolean"},"postponeMonths":{"type":"integer","format":"int32"},"reminder":{"$ref":"#/components/schemas/TvlsetReminder"},"tqcReportEmails":{"type":"array","items":{"type":"string"}}}},"TvlsetView":{"oneOf":[{"$ref":"#/components/schemas/TvlsetViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"TvlsetViewAttributes":"#/components/schemas/TvlsetViewAttributes"}}},"TvlsetViewAttributes":{"title":"TvlsetViewAttributes","description":"A merchant's travel (Galaxy) settings: the file versions it may send, how its dates are postponed, its reminders to send files, and who gets its quality-check reports. The merchant's own contact and trading details are the merchant's, at `/merchants/{merchantId}`.","examples":[{"type":"TvlsetViewAttributes","merchantTravelSettingsId":"mcht_9f2Kd8QpLzXw","merchantCode":"example","fileVersions":["example"],"datePostponeEnabled":true,"postponeMonths":6,"reminder":{"type":"TvlsetReminderAttributes","enabled":true,"schedule":"Never","weekday":"Sunday"},"tqcReportEmails":["ada@example.com"],"lastReminderOn":"2026-08-19","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","merchantTravelSettingsId","merchantCode","datePostponeEnabled","postponeMonths","reminder","createdAt","updatedAt"],"properties":{"type":{"description":"Always `TvlsetViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvlsetViewAttributes"]},"merchantTravelSettingsId":{"$ref":"#/components/schemas/TvlsetId"},"merchantCode":{"description":"The merchant's twelve-digit travel code.","type":"string"},"fileVersions":{"description":"The file layout versions the merchant may send, such as `V02.01`. An empty list allows none.","type":"array","items":{"type":"string"}},"datePostponeEnabled":{"description":"Whether a transaction dated before the current month is moved forward.","type":"boolean"},"postponeMonths":{"description":"How many months a date may be postponed by.","type":"integer","format":"int32"},"reminder":{"$ref":"#/components/schemas/TvlsetReminder"},"tqcReportEmails":{"description":"Who the file quality-check report is mailed to.","type":"array","items":{"type":"string"}},"lastReminderOn":{"description":"The day the merchant was last reminded.","type":"string","format":"date"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"TvlsetWeekday":{"title":"TvlsetWeekday","description":"The day of the week, for `Weekly`. Absent for the others.","type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday","Unknown"]},"TvluplCmd":{"oneOf":[{"$ref":"#/components/schemas/TvluplCmdRecord"}],"discriminator":{"propertyName":"type","mapping":{"TvluplCmdRecord":"#/components/schemas/TvluplCmdRecord"}}},"TvluplCmdRecord":{"title":"TvluplCmdRecord","description":"Record that a file is being uploaded, before it is sent. Answers with the upload, in status `Uploading`.","examples":[{"type":"TvluplCmdRecord","merchantId":"mcht_9f2Kd8QpLzXw","fileName":"Ada Lovelace","uploaderReference":"your-own-reference","uploaderName":"Ada Lovelace"}],"type":"object","required":["type","fileName"],"properties":{"type":{"description":"Always `TvluplCmdRecord`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvluplCmdRecord"]},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"The merchant the file is for. Omit it when the `Merchant-Id` header names the merchant."},"fileName":{"type":"string"},"uploaderReference":{"type":"string"},"uploaderName":{"type":"string"}}},"TvluplColumn":{"title":"TvluplColumn","type":"string","enum":["TravelUploadId","MerchantId","FileName","UploaderReference","UploaderName","Status","FailureMessage","CreatedAt","UpdatedAt"]},"TvluplCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/TvluplCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"TvluplCreateRspAttributes":"#/components/schemas/TvluplCreateRspAttributes"}}},"TvluplCreateRspAttributes":{"title":"TvluplCreateRspAttributes","examples":[{"type":"TvluplCreateRspAttributes","created":{"type":"TvluplViewAttributes","travelUploadId":"tvlupl_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","fileName":"Ada Lovelace","uploaderReference":"your-own-reference","uploaderName":"Ada Lovelace","status":"Uploading","failureMessage":"example","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `TvluplCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvluplCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/TvluplView","description":"The resource that was created."}}},"TvluplId":{"title":"TvluplId","description":"Identifier of a travel file upload.","examples":["tvlupl_9f2Kd8QpLzXw"],"type":"string"},"TvluplPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/TvluplPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"TvluplPageAttributes":"#/components/schemas/TvluplPageAttributes"}}},"TvluplPageAttributes":{"title":"TvluplPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"TvluplPageAttributes","data":[{"type":"TvluplViewAttributes","travelUploadId":"tvlupl_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","fileName":"Ada Lovelace","uploaderReference":"your-own-reference","uploaderName":"Ada Lovelace","status":"Uploading","failureMessage":"example","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `TvluplPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvluplPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/TvluplView","description":"One upload of a travel (Galaxy) file through the portal, kept as the partner's upload log: what was sent, by whom, and whether it arrived."}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"TvluplSort":{"title":"TvluplSort","type":"string","enum":["createdAt","-createdAt","updatedAt","-updatedAt","fileName","-fileName"]},"TvluplStatus":{"title":"TvluplStatus","type":"string","enum":["Uploading","Uploaded","Failed","Unknown"]},"TvluplUpdate":{"oneOf":[{"$ref":"#/components/schemas/TvluplUpdateSettle"}],"discriminator":{"propertyName":"type","mapping":{"TvluplUpdateSettle":"#/components/schemas/TvluplUpdateSettle"}}},"TvluplUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/TvluplUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"TvluplUpdateRspAttributes":"#/components/schemas/TvluplUpdateRspAttributes"}}},"TvluplUpdateRspAttributes":{"title":"TvluplUpdateRspAttributes","examples":[{"type":"TvluplUpdateRspAttributes","updated":{"type":"TvluplViewAttributes","travelUploadId":"tvlupl_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","fileName":"Ada Lovelace","uploaderReference":"your-own-reference","uploaderName":"Ada Lovelace","status":"Uploading","failureMessage":"example","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `TvluplUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvluplUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/TvluplView","description":"The resource as it stands after the change."}}},"TvluplUpdateSettle":{"title":"TvluplUpdateSettle","description":"Settle an upload: it arrived, or it failed. The portal does this once the file has been sent.","examples":[{"type":"TvluplUpdateSettle","status":"Uploading","failureMessage":"example"}],"type":"object","required":["type","status"],"properties":{"type":{"description":"Always `TvluplUpdateSettle`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvluplUpdateSettle"]},"status":{"$ref":"#/components/schemas/TvluplStatus","description":"`Uploaded` or `Failed`. `Uploading` is the state an upload starts in, not one to settle on."},"failureMessage":{"description":"Why it failed. Only with `Failed`.","type":"string"}}},"TvluplView":{"oneOf":[{"$ref":"#/components/schemas/TvluplViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"TvluplViewAttributes":"#/components/schemas/TvluplViewAttributes"}}},"TvluplViewAttributes":{"title":"TvluplViewAttributes","description":"One upload of a travel (Galaxy) file through the portal, kept as the partner's upload log: what was sent, by whom, and whether it arrived.","examples":[{"type":"TvluplViewAttributes","travelUploadId":"tvlupl_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","fileName":"Ada Lovelace","uploaderReference":"your-own-reference","uploaderName":"Ada Lovelace","status":"Uploading","failureMessage":"example","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","travelUploadId","merchantId","fileName","status","createdAt","updatedAt"],"properties":{"type":{"description":"Always `TvluplViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["TvluplViewAttributes"]},"travelUploadId":{"$ref":"#/components/schemas/TvluplId"},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"The merchant the file was uploaded for."},"fileName":{"type":"string"},"uploaderReference":{"description":"The uploader's own reference for the upload, where they gave one.","type":"string"},"uploaderName":{"description":"The name of the person who uploaded the file, where the portal recorded one.","type":"string"},"status":{"$ref":"#/components/schemas/TvluplStatus"},"failureMessage":{"description":"Why the upload failed. Present only when `status` is `Failed`.","type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"UserCmd":{"oneOf":[{"$ref":"#/components/schemas/UserCmdCreate"}],"discriminator":{"propertyName":"type","mapping":{"UserCmdCreate":"#/components/schemas/UserCmdCreate"}}},"UserCmdCreate":{"title":"UserCmdCreate","description":"Create a user and grant it permissions.","examples":[{"type":"UserCmdCreate","displayName":"Ada Lovelace","identifiedBy":[{"type":"UserIdEmail","emailAddress":"ada@example.com"}],"permissions":[{"type":"UserPermissionAttributes","domain":{"type":"UserDomainAnonymous","restrictedTo":{"type":"UserDomainCustomer","customerId":"cust_9f2Kd8QpLzXw"}},"roles":["role_9f2Kd8QpLzXw"]}],"status":"Enabled"}],"type":"object","required":["type","displayName"],"properties":{"type":{"description":"Always `UserCmdCreate`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["UserCmdCreate"]},"displayName":{"type":"string"},"identifiedBy":{"description":"How this user can be recognised. At least one identifier.","type":"array","items":{"$ref":"#/components/schemas/UserIdentifier"}},"permissions":{"description":"The domains this user holds permissions in. A user may hold several; a session selects one.","type":"array","items":{"$ref":"#/components/schemas/UserPermission"}},"status":{"$ref":"#/components/schemas/UserStatus","description":"Create the user disabled, to be enabled later. Defaults to `Enabled`."}}},"UserColumn":{"title":"UserColumn","type":"string","enum":["UserId","DisplayName","Status","CreatedAt","UpdatedAt"]},"UserCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/UserCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"UserCreateRspAttributes":"#/components/schemas/UserCreateRspAttributes"}}},"UserCreateRspAttributes":{"title":"UserCreateRspAttributes","examples":[{"type":"UserCreateRspAttributes","created":{"type":"UserViewAttributes","userId":"user_9f2Kd8QpLzXw","displayName":"Ada Lovelace","identifiedBy":[{"type":"UserIdEmail","emailAddress":"ada@example.com"}],"authorisedTo":[{"type":"UserPermissionAttributes","domain":{"type":"UserDomainAnonymous","restrictedTo":{"type":"UserDomainCustomer","customerId":"cust_9f2Kd8QpLzXw"}},"roles":["role_9f2Kd8QpLzXw"]}],"status":"Enabled","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `UserCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["UserCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/UserView","description":"The resource that was created."}}},"UserDomainAnonymous":{"title":"UserDomainAnonymous","description":"An unauthenticated caller, restricted to what the wrapped domain permits.","examples":[{"type":"UserDomainAnonymous","restrictedTo":{"type":"UserDomainCustomer","customerId":"cust_9f2Kd8QpLzXw"}}],"type":"object","required":["type","restrictedTo"],"properties":{"type":{"description":"Always `UserDomainAnonymous`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["UserDomainAnonymous"]},"restrictedTo":{"$ref":"#/components/schemas/UserPartyDomain"}}},"UserDomainCustomer":{"title":"UserDomainCustomer","description":"One customer.","examples":[{"type":"UserDomainCustomer","customerId":"cust_9f2Kd8QpLzXw"}],"type":"object","required":["type","customerId"],"properties":{"type":{"description":"Always `UserDomainCustomer`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["UserDomainCustomer"]},"customerId":{"$ref":"#/components/schemas/CustId","description":"Identifier of a customer."}}},"UserDomainDelegate":{"title":"UserDomainDelegate","description":"A delegate acting for one customer. Scoped by both, because a delegate can act for several.","examples":[{"type":"UserDomainDelegate","delegateId":"custd_9f2Kd8QpLzXw","forCustomerId":"cust_9f2Kd8QpLzXw","loanAccess":["loan_9f2Kd8QpLzXw"]}],"type":"object","required":["type","delegateId","forCustomerId"],"properties":{"type":{"description":"Always `UserDomainDelegate`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["UserDomainDelegate"]},"delegateId":{"$ref":"#/components/schemas/CustdId"},"forCustomerId":{"$ref":"#/components/schemas/CustId","description":"Identifier of a customer."},"loanAccess":{"description":"Loans this delegate may act on for this customer; absent = unrestricted.","type":"array","items":{"$ref":"#/components/schemas/LoanId","description":"Identifier of a loan."}}}},"UserDomainEnterprise":{"title":"UserDomainEnterprise","description":"One enterprise.","examples":[{"type":"UserDomainEnterprise","enterpriseId":"ent_9f2Kd8QpLzXw"}],"type":"object","required":["type","enterpriseId"],"properties":{"type":{"description":"Always `UserDomainEnterprise`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["UserDomainEnterprise"]},"enterpriseId":{"$ref":"#/components/schemas/EntId","description":"Identifier of an enterprise."}}},"UserDomainMarketplace":{"title":"UserDomainMarketplace","description":"One marketplace.","examples":[{"type":"UserDomainMarketplace","marketplaceId":"mktp_9f2Kd8QpLzXw"}],"type":"object","required":["type","marketplaceId"],"properties":{"type":{"description":"Always `UserDomainMarketplace`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["UserDomainMarketplace"]},"marketplaceId":{"$ref":"#/components/schemas/MktpId","description":"Identifier of a marketplace."}}},"UserDomainMerchant":{"title":"UserDomainMerchant","description":"One merchant.","examples":[{"type":"UserDomainMerchant","merchantId":"mcht_9f2Kd8QpLzXw"}],"type":"object","required":["type","merchantId"],"properties":{"type":{"description":"Always `UserDomainMerchant`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["UserDomainMerchant"]},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"Identifier of a merchant."}}},"UserDomainNonexistent":{"title":"UserDomainNonexistent","description":"A domain that no longer resolves, the party it named is gone.","examples":[{"type":"UserDomainNonexistent"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `UserDomainNonexistent`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["UserDomainNonexistent"]}}},"UserDomainRoot":{"title":"UserDomainRoot","description":"The whole platform. Held by platform operators.","examples":[{"type":"UserDomainRoot"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `UserDomainRoot`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["UserDomainRoot"]}}},"UserId":{"title":"UserId","description":"Identifier of a user.","examples":["user_9f2Kd8QpLzXw"],"type":"string"},"UserIdEmail":{"title":"UserIdEmail","description":"An email address.","examples":[{"type":"UserIdEmail","emailAddress":"ada@example.com"}],"type":"object","required":["type","emailAddress"],"properties":{"type":{"description":"Always `UserIdEmail`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["UserIdEmail"]},"emailAddress":{"type":"string"}}},"UserIdOidcSubject":{"title":"UserIdOidcSubject","description":"The user's identity at an external OIDC provider.","examples":[{"type":"UserIdOidcSubject","oidcProviderId":"oidcidp_9f2Kd8QpLzXw","subject":"example"}],"type":"object","required":["type","oidcProviderId","subject"],"properties":{"type":{"description":"Always `UserIdOidcSubject`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["UserIdOidcSubject"]},"oidcProviderId":{"$ref":"#/components/schemas/OidcidpId"},"subject":{"description":"The `sub` claim of that provider's ID tokens.","type":"string"}}},"UserIdPhone":{"title":"UserIdPhone","description":"A phone number, E.164 format.","examples":[{"type":"UserIdPhone","phoneNumber":"+61400000000"}],"type":"object","required":["type","phoneNumber"],"properties":{"type":{"description":"Always `UserIdPhone`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["UserIdPhone"]},"phoneNumber":{"type":"string"}}},"UserIdService":{"title":"UserIdService","description":"A service token. Instantiate several for overlapped key rolling.","examples":[{"type":"UserIdService","apiKeyId":"key_9f2Kd8QpLzXw"}],"type":"object","required":["type","apiKeyId"],"properties":{"type":{"description":"Always `UserIdService`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["UserIdService"]},"apiKeyId":{"$ref":"#/components/schemas/ApiKeyId"}}},"UserIdentifier":{"oneOf":[{"$ref":"#/components/schemas/UserIdEmail"},{"$ref":"#/components/schemas/UserIdOidcSubject"},{"$ref":"#/components/schemas/UserIdPhone"},{"$ref":"#/components/schemas/UserIdService"}],"discriminator":{"propertyName":"type","mapping":{"UserIdEmail":"#/components/schemas/UserIdEmail","UserIdOidcSubject":"#/components/schemas/UserIdOidcSubject","UserIdPhone":"#/components/schemas/UserIdPhone","UserIdService":"#/components/schemas/UserIdService"}}},"UserPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/UserPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"UserPageAttributes":"#/components/schemas/UserPageAttributes"}}},"UserPageAttributes":{"title":"UserPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"UserPageAttributes","data":[{"type":"UserViewAttributes","userId":"user_9f2Kd8QpLzXw","displayName":"Ada Lovelace","identifiedBy":[{"type":"UserIdEmail","emailAddress":"ada@example.com"}],"authorisedTo":[{"type":"UserPermissionAttributes","domain":{"type":"UserDomainAnonymous","restrictedTo":{"type":"UserDomainCustomer","customerId":"cust_9f2Kd8QpLzXw"}},"roles":["role_9f2Kd8QpLzXw"]}],"status":"Enabled","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `UserPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["UserPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/UserView","description":"A user, a person or a service principal that authenticates."}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"UserPartyDomain":{"oneOf":[{"$ref":"#/components/schemas/UserDomainCustomer"},{"$ref":"#/components/schemas/UserDomainDelegate"},{"$ref":"#/components/schemas/UserDomainEnterprise"},{"$ref":"#/components/schemas/UserDomainMarketplace"},{"$ref":"#/components/schemas/UserDomainMerchant"},{"$ref":"#/components/schemas/UserDomainRoot"}],"discriminator":{"propertyName":"type","mapping":{"UserDomainCustomer":"#/components/schemas/UserDomainCustomer","UserDomainDelegate":"#/components/schemas/UserDomainDelegate","UserDomainEnterprise":"#/components/schemas/UserDomainEnterprise","UserDomainMarketplace":"#/components/schemas/UserDomainMarketplace","UserDomainMerchant":"#/components/schemas/UserDomainMerchant","UserDomainRoot":"#/components/schemas/UserDomainRoot"}}},"UserPermission":{"description":"A domain a user holds permissions in, and the roles they hold there.","oneOf":[{"$ref":"#/components/schemas/UserPermissionAttributes"}],"discriminator":{"propertyName":"type","mapping":{"UserPermissionAttributes":"#/components/schemas/UserPermissionAttributes"}}},"UserPermissionAttributes":{"title":"UserPermissionAttributes","description":"A domain a user holds permissions in, and the roles they hold there.","examples":[{"type":"UserPermissionAttributes","domain":{"type":"UserDomainAnonymous","restrictedTo":{"type":"UserDomainCustomer","customerId":"cust_9f2Kd8QpLzXw"}},"roles":["role_9f2Kd8QpLzXw"]}],"type":"object","required":["type","domain"],"properties":{"type":{"description":"Always `UserPermissionAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["UserPermissionAttributes"]},"domain":{"$ref":"#/components/schemas/UserPermissionDomain"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/RoleId"}}}},"UserPermissionDomain":{"oneOf":[{"$ref":"#/components/schemas/UserDomainAnonymous"},{"$ref":"#/components/schemas/UserDomainCustomer"},{"$ref":"#/components/schemas/UserDomainDelegate"},{"$ref":"#/components/schemas/UserDomainEnterprise"},{"$ref":"#/components/schemas/UserDomainMarketplace"},{"$ref":"#/components/schemas/UserDomainMerchant"},{"$ref":"#/components/schemas/UserDomainNonexistent"},{"$ref":"#/components/schemas/UserDomainRoot"}],"discriminator":{"propertyName":"type","mapping":{"UserDomainAnonymous":"#/components/schemas/UserDomainAnonymous","UserDomainCustomer":"#/components/schemas/UserDomainCustomer","UserDomainDelegate":"#/components/schemas/UserDomainDelegate","UserDomainEnterprise":"#/components/schemas/UserDomainEnterprise","UserDomainMarketplace":"#/components/schemas/UserDomainMarketplace","UserDomainMerchant":"#/components/schemas/UserDomainMerchant","UserDomainNonexistent":"#/components/schemas/UserDomainNonexistent","UserDomainRoot":"#/components/schemas/UserDomainRoot"}}},"UserSort":{"title":"UserSort","type":"string","enum":["createdAt","-createdAt","updatedAt","-updatedAt"]},"UserStatus":{"title":"UserStatus","type":"string","enum":["Enabled","Disabled","Unknown"]},"UserUpdate":{"description":"Change a user. Omitted fields are left as they are.","oneOf":[{"$ref":"#/components/schemas/UserUpdateAttributes"}],"discriminator":{"propertyName":"type","mapping":{"UserUpdateAttributes":"#/components/schemas/UserUpdateAttributes"}}},"UserUpdateAttributes":{"title":"UserUpdateAttributes","description":"Change a user. Omitted fields are left as they are.","examples":[{"type":"UserUpdateAttributes","displayName":"Ada Lovelace","permissions":[{"type":"UserPermissionAttributes","domain":{"type":"UserDomainAnonymous","restrictedTo":{"type":"UserDomainCustomer","customerId":"cust_9f2Kd8QpLzXw"}},"roles":["role_9f2Kd8QpLzXw"]}],"status":"Enabled"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `UserUpdateAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["UserUpdateAttributes"]},"displayName":{"type":"string"},"permissions":{"description":"Replaces the user's permissions outright, send the full set you want. Granting a merchant, revoking one, or moving a user between merchants are all this field.","type":"array","items":{"$ref":"#/components/schemas/UserPermission"}},"status":{"$ref":"#/components/schemas/UserStatus","description":"`Disabled` stops the user signing in without deleting them."}}},"UserUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/UserUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"UserUpdateRspAttributes":"#/components/schemas/UserUpdateRspAttributes"}}},"UserUpdateRspAttributes":{"title":"UserUpdateRspAttributes","examples":[{"type":"UserUpdateRspAttributes","updated":{"type":"UserViewAttributes","userId":"user_9f2Kd8QpLzXw","displayName":"Ada Lovelace","identifiedBy":[{"type":"UserIdEmail","emailAddress":"ada@example.com"}],"authorisedTo":[{"type":"UserPermissionAttributes","domain":{"type":"UserDomainAnonymous","restrictedTo":{"type":"UserDomainCustomer","customerId":"cust_9f2Kd8QpLzXw"}},"roles":["role_9f2Kd8QpLzXw"]}],"status":"Enabled","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `UserUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["UserUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/UserView","description":"The resource as it stands after the change."}}},"UserView":{"oneOf":[{"$ref":"#/components/schemas/UserViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"UserViewAttributes":"#/components/schemas/UserViewAttributes"}}},"UserViewAttributes":{"title":"UserViewAttributes","description":"A user, a person or a service principal that authenticates.","examples":[{"type":"UserViewAttributes","userId":"user_9f2Kd8QpLzXw","displayName":"Ada Lovelace","identifiedBy":[{"type":"UserIdEmail","emailAddress":"ada@example.com"}],"authorisedTo":[{"type":"UserPermissionAttributes","domain":{"type":"UserDomainAnonymous","restrictedTo":{"type":"UserDomainCustomer","customerId":"cust_9f2Kd8QpLzXw"}},"roles":["role_9f2Kd8QpLzXw"]}],"status":"Enabled","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","userId","displayName","status","createdAt","updatedAt"],"properties":{"type":{"description":"Always `UserViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["UserViewAttributes"]},"userId":{"$ref":"#/components/schemas/UserId"},"displayName":{"type":"string"},"identifiedBy":{"description":"The identifiers this user can be recognised by.","type":"array","items":{"$ref":"#/components/schemas/UserIdentifier"}},"authorisedTo":{"type":"array","items":{"$ref":"#/components/schemas/UserPermission"}},"status":{"$ref":"#/components/schemas/UserStatus"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"WebhookCmd":{"oneOf":[{"$ref":"#/components/schemas/WebhookCmdCreate"}],"discriminator":{"propertyName":"type","mapping":{"WebhookCmdCreate":"#/components/schemas/WebhookCmdCreate"}}},"WebhookCmdCreate":{"title":"WebhookCmdCreate","description":"Subscribe an endpoint to platform events. The subscription is scoped to whoever is asking: a merchant or a marketplace credential subscribes its own events, and an administrator names the one merchant or marketplace it is for.","examples":[{"type":"WebhookCmdCreate","url":"https://example.com/callback","events":["MerchantCreated"],"description":"A short description.","metadata":{"yourKey":{}},"secret":"example","merchantId":"mcht_9f2Kd8QpLzXw","marketplaceId":"mktp_9f2Kd8QpLzXw"}],"type":"object","required":["type","url"],"properties":{"type":{"description":"Always `WebhookCmdCreate`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["WebhookCmdCreate"]},"url":{"description":"An absolute `https` (or `http`) url with a host, at most 2048 characters.","type":"string"},"events":{"description":"Event types to deliver.","type":"array","items":{"$ref":"#/components/schemas/WebhookEventType"}},"description":{"description":"What this subscription is for, in your own words.","type":"string"},"metadata":{"$ref":"#/components/schemas/Metadata","description":"Free-form data the platform stores and returns untouched."},"secret":{"description":"The secret deliveries are signed with, 16 to 256 characters with no surrounding whitespace. Write-only: it is never returned. Omit it and the platform generates one, which you then cannot read, so send your own if you mean to verify signatures.","type":"string"},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"The merchant whose events to deliver. An administrator sends exactly one of this and `marketplaceId`. A merchant credential may omit both or name only itself. A marketplace credential may omit both, name itself as `marketplaceId`, or name one of its own merchants here to narrow the subscription to that merchant."},"marketplaceId":{"$ref":"#/components/schemas/MktpId","description":"The marketplace whose events to deliver. See `merchantId`."}}},"WebhookColumn":{"title":"WebhookColumn","type":"string","enum":["WebhookId","MerchantId","MarketplaceId","Url","Status","Description","Readable","ConsecutiveFailures","LastDeliveryAt","LastDeliveryStatus","CreatedAt","UpdatedAt"]},"WebhookCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/WebhookCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"WebhookCreateRspAttributes":"#/components/schemas/WebhookCreateRspAttributes"}}},"WebhookCreateRspAttributes":{"title":"WebhookCreateRspAttributes","examples":[{"type":"WebhookCreateRspAttributes","created":{"type":"WebhookViewAttributes","webhookId":"webhook_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","marketplaceId":"mktp_9f2Kd8QpLzXw","url":"https://example.com/callback","status":"Active","events":["MerchantCreated"],"description":"A short description.","metadata":{"yourKey":{}},"readable":true,"consecutiveFailures":1250,"lastDeliveryAt":"2026-08-19T04:21:07Z","lastDeliveryStatus":"Pending","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `WebhookCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["WebhookCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/WebhookView","description":"The resource that was created."}}},"WebhookDeliveryId":{"title":"WebhookDeliveryId","description":"Identifier of one webhook delivery.","examples":["whdlv_9f2Kd8QpLzXw"],"type":"string"},"WebhookDeliveryPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/WebhookDeliveryPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"WebhookDeliveryPageAttributes":"#/components/schemas/WebhookDeliveryPageAttributes"}}},"WebhookDeliveryPageAttributes":{"title":"WebhookDeliveryPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"WebhookDeliveryPageAttributes","data":[{"type":"WebhookDeliveryViewAttributes","webhookDeliveryId":"whdlv_9f2Kd8QpLzXw","webhookId":"webhook_9f2Kd8QpLzXw","event":"MerchantCreated","status":"Pending","attempts":1250,"lastStatusCode":1250,"lastError":"example","lastAttemptAt":"2026-08-19T04:21:07Z","lastSentTo":"example","lastResponseBody":"example","lastResponseHeaders":{"type":"WebhookResponseHeadersAttributes","server":"example","via":"example","cfRay":"example","amznRequestId":"abc123","amznTraceId":"abc123","requestId":"abc123","cache":"example","location":"example"},"deliveredAt":"2026-08-19T04:21:07Z","idempotencyKey":"example","eventPublishedAt":"2026-08-19T04:21:07Z","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `WebhookDeliveryPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["WebhookDeliveryPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/WebhookDeliveryView","description":"One attempt to deliver one event to one subscription."}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"WebhookDeliverySort":{"title":"WebhookDeliverySort","type":"string","enum":["createdAt","-createdAt","updatedAt","-updatedAt"]},"WebhookDeliveryStatus":{"title":"WebhookDeliveryStatus","type":"string","enum":["Pending","PendingRetry","Delivered","Failed","Abandoned","Observed","Unknown"]},"WebhookDeliveryUpd":{"oneOf":[{"$ref":"#/components/schemas/WebhookDeliveryUpdRedeliver"}],"discriminator":{"propertyName":"type","mapping":{"WebhookDeliveryUpdRedeliver":"#/components/schemas/WebhookDeliveryUpdRedeliver"}}},"WebhookDeliveryUpdRedeliver":{"title":"WebhookDeliveryUpdRedeliver","description":"Send this delivery again. Only one that is `Failed`, `Abandoned` or `Observed` can be resent, because the others are still on their way. Your endpoint receives the body we tried to send before, not one rebuilt from the event.","examples":[{"type":"WebhookDeliveryUpdRedeliver"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `WebhookDeliveryUpdRedeliver`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["WebhookDeliveryUpdRedeliver"]}}},"WebhookDeliveryUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/WebhookDeliveryUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"WebhookDeliveryUpdateRspAttributes":"#/components/schemas/WebhookDeliveryUpdateRspAttributes"}}},"WebhookDeliveryUpdateRspAttributes":{"title":"WebhookDeliveryUpdateRspAttributes","examples":[{"type":"WebhookDeliveryUpdateRspAttributes","updated":{"type":"WebhookDeliveryViewAttributes","webhookDeliveryId":"whdlv_9f2Kd8QpLzXw","webhookId":"webhook_9f2Kd8QpLzXw","event":"MerchantCreated","status":"Pending","attempts":1250,"lastStatusCode":1250,"lastError":"example","lastAttemptAt":"2026-08-19T04:21:07Z","lastSentTo":"example","lastResponseBody":"example","lastResponseHeaders":{"type":"WebhookResponseHeadersAttributes","server":"example","via":"example","cfRay":"example","amznRequestId":"abc123","amznTraceId":"abc123","requestId":"abc123","cache":"example","location":"example"},"deliveredAt":"2026-08-19T04:21:07Z","idempotencyKey":"example","eventPublishedAt":"2026-08-19T04:21:07Z","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `WebhookDeliveryUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["WebhookDeliveryUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/WebhookDeliveryView","description":"The resource as it stands after the change."}}},"WebhookDeliveryView":{"oneOf":[{"$ref":"#/components/schemas/WebhookDeliveryViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"WebhookDeliveryViewAttributes":"#/components/schemas/WebhookDeliveryViewAttributes"}}},"WebhookDeliveryViewAttributes":{"title":"WebhookDeliveryViewAttributes","description":"One attempt to deliver one event to one subscription.","examples":[{"type":"WebhookDeliveryViewAttributes","webhookDeliveryId":"whdlv_9f2Kd8QpLzXw","webhookId":"webhook_9f2Kd8QpLzXw","event":"MerchantCreated","status":"Pending","attempts":1250,"lastStatusCode":1250,"lastError":"example","lastAttemptAt":"2026-08-19T04:21:07Z","lastSentTo":"example","lastResponseBody":"example","lastResponseHeaders":{"type":"WebhookResponseHeadersAttributes","server":"example","via":"example","cfRay":"example","amznRequestId":"abc123","amznTraceId":"abc123","requestId":"abc123","cache":"example","location":"example"},"deliveredAt":"2026-08-19T04:21:07Z","idempotencyKey":"example","eventPublishedAt":"2026-08-19T04:21:07Z","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","webhookDeliveryId","webhookId","event","status","attempts","idempotencyKey","eventPublishedAt","createdAt","updatedAt"],"properties":{"type":{"description":"Always `WebhookDeliveryViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["WebhookDeliveryViewAttributes"]},"webhookDeliveryId":{"$ref":"#/components/schemas/WebhookDeliveryId"},"webhookId":{"$ref":"#/components/schemas/WebhookId"},"event":{"$ref":"#/components/schemas/WebhookEventType","description":"The event type delivered."},"status":{"$ref":"#/components/schemas/WebhookDeliveryStatus"},"attempts":{"description":"How many times we have tried this delivery. Some attempts do not reach your endpoint at all, such as those made while the subscription is suspended; `lastError` says when that is why.","type":"integer","format":"int32"},"lastStatusCode":{"description":"The HTTP status your endpoint answered with on the most recent attempt.","type":"integer","format":"int32"},"lastError":{"description":"Why the most recent attempt did not succeed, when the reason was not an HTTP status, or what to do about a redirect, which is not followed: update the subscription url to its `location`.","type":"string"},"lastAttemptAt":{"description":"When we most recently called your endpoint.","type":"string","format":"date-time"},"lastSentTo":{"description":"The url we most recently sent this to. It is read from the subscription at the moment of the call, so correcting the url and redelivering sends the same event to the new one.","type":"string"},"lastResponseBody":{"description":"The start of what your endpoint answered with on the most recent attempt, success included, cut at 500 bytes. Absent when that attempt got no answer or an empty one.","type":"string"},"lastResponseHeaders":{"$ref":"#/components/schemas/WebhookResponseHeaders"},"deliveredAt":{"description":"When your endpoint accepted it.","type":"string","format":"date-time"},"idempotencyKey":{"description":"The identity of this delivery, stable across retries and redeliveries. Use it to make your handler idempotent: the same key is the same event for the same subscription.","type":"string"},"eventPublishedAt":{"description":"When the event itself happened. Compare it with `createdAt` to see how long we took to pick the event up, and with `lastAttemptAt` for the whole journey.","type":"string","format":"date-time"},"createdAt":{"description":"When we queued this delivery. Not when the event happened, which for a redelivery may be much earlier.","type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"WebhookEventType":{"title":"WebhookEventType","type":"string","enum":["MerchantCreated","MerchantActivated","MerchantSuspended","MerchantAvailableBalanceUpdated","MerchantBankAccountAdded","MerchantPrimaryBankAccountUpdated","PayPlanCreated","PayPlanActivated","PayPlanCompleted","PayPlanInDefault","PayInFullCreated","PayInFullAccepted","PayInFullAuthorised","PayInFullCompleted","TransactionPaid","TransactionFailed","DisputeCreated","DisputeUpdated","PayoutCreated","PayoutPending","PayoutFailed","PayoutPaid","PayoutReversed","InvoiceIssued","InvoiceDue","InvoicePaymentFailed","InvoicePaid","PaymentSourceCreated","PaymentSourceMethodUpdated","PaymentSourceDeleted","LoanCreated","LoanStatementCreated","LoanStatementIssued","LoanStatementDue","LoanStatementPaid","LoanPaymentFailed","Unknown"]},"WebhookId":{"title":"WebhookId","description":"Identifier of a webhook subscription.","examples":["webhook_9f2Kd8QpLzXw"],"type":"string"},"WebhookPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/WebhookPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"WebhookPageAttributes":"#/components/schemas/WebhookPageAttributes"}}},"WebhookPageAttributes":{"title":"WebhookPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"WebhookPageAttributes","data":[{"type":"WebhookViewAttributes","webhookId":"webhook_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","marketplaceId":"mktp_9f2Kd8QpLzXw","url":"https://example.com/callback","status":"Active","events":["MerchantCreated"],"description":"A short description.","metadata":{"yourKey":{}},"readable":true,"consecutiveFailures":1250,"lastDeliveryAt":"2026-08-19T04:21:07Z","lastDeliveryStatus":"Pending","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `WebhookPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["WebhookPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/WebhookView","description":"A subscription delivering platform events to an endpoint you control."}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"WebhookResponseHeaders":{"description":"Who answered the most recent attempt, from the response headers that identify a server, CDN or firewall. Absent when that attempt got no answer, or an answer carrying none of them.","oneOf":[{"$ref":"#/components/schemas/WebhookResponseHeadersAttributes"}],"discriminator":{"propertyName":"type","mapping":{"WebhookResponseHeadersAttributes":"#/components/schemas/WebhookResponseHeadersAttributes"}}},"WebhookResponseHeadersAttributes":{"title":"WebhookResponseHeadersAttributes","description":"Response headers that identify what answered a webhook call. Only these are kept, never cookies or credentials.","examples":[{"type":"WebhookResponseHeadersAttributes","server":"example","via":"example","cfRay":"example","amznRequestId":"abc123","amznTraceId":"abc123","requestId":"abc123","cache":"example","location":"example"}],"type":"object","required":["type"],"properties":{"type":{"description":"Always `WebhookResponseHeadersAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["WebhookResponseHeadersAttributes"]},"server":{"type":"string"},"via":{"type":"string"},"cfRay":{"description":"`cf-ray`: present when Cloudflare answered, or sits in front of your endpoint.","type":"string"},"amznRequestId":{"description":"`x-amzn-requestid`: present when an AWS service such as API Gateway answered.","type":"string"},"amznTraceId":{"description":"`x-amzn-trace-id`: present when an AWS load balancer passed the call on.","type":"string"},"requestId":{"description":"`x-request-id`.","type":"string"},"cache":{"description":"`x-cache`: present when a CDN answered.","type":"string"},"location":{"description":"Where a redirect pointed. We do not follow redirects, so this is the url to subscribe instead.","type":"string"}}},"WebhookSort":{"title":"WebhookSort","type":"string","enum":["createdAt","-createdAt","updatedAt","-updatedAt"]},"WebhookStatus":{"title":"WebhookStatus","type":"string","enum":["Active","Suspended","Unknown"]},"WebhookUpdate":{"oneOf":[{"$ref":"#/components/schemas/WebhookUpdateAttributes"},{"$ref":"#/components/schemas/WebhookUpdateRotateSecret"},{"$ref":"#/components/schemas/WebhookUpdateStatus"}],"discriminator":{"propertyName":"type","mapping":{"WebhookUpdateAttributes":"#/components/schemas/WebhookUpdateAttributes","WebhookUpdateRotateSecret":"#/components/schemas/WebhookUpdateRotateSecret","WebhookUpdateStatus":"#/components/schemas/WebhookUpdateStatus"}}},"WebhookUpdateAttributes":{"title":"WebhookUpdateAttributes","description":"Set the subscription's own attributes: its url and event types are replaced, and its description too when given.","examples":[{"type":"WebhookUpdateAttributes","url":"https://example.com/callback","events":["MerchantCreated"],"description":"A short description."}],"type":"object","required":["type","url","events"],"properties":{"type":{"description":"Always `WebhookUpdateAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["WebhookUpdateAttributes"]},"url":{"description":"Where to deliver from now on, by the same rules as on create. Deliveries already owed go to the new url, as do redeliveries.","type":"string"},"events":{"description":"The event types to deliver from now on, at least one, replacing the whole list.","type":"array","minItems":1,"items":{"$ref":"#/components/schemas/WebhookEventType"}},"description":{"description":"What this subscription is for, in your own words. Omit it to leave it unchanged; an empty string clears it.","type":"string"}}},"WebhookUpdateRotateSecret":{"title":"WebhookUpdateRotateSecret","description":"Rotate the signing secret, 16 to 256 characters: every delivery sent from now on, including retries of ones already owed, is signed with it. Write-only: it is never returned.","examples":[{"type":"WebhookUpdateRotateSecret","secret":"example"}],"type":"object","required":["type","secret"],"properties":{"type":{"description":"Always `WebhookUpdateRotateSecret`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["WebhookUpdateRotateSecret"]},"secret":{"type":"string"}}},"WebhookUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/WebhookUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"WebhookUpdateRspAttributes":"#/components/schemas/WebhookUpdateRspAttributes"}}},"WebhookUpdateRspAttributes":{"title":"WebhookUpdateRspAttributes","examples":[{"type":"WebhookUpdateRspAttributes","updated":{"type":"WebhookViewAttributes","webhookId":"webhook_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","marketplaceId":"mktp_9f2Kd8QpLzXw","url":"https://example.com/callback","status":"Active","events":["MerchantCreated"],"description":"A short description.","metadata":{"yourKey":{}},"readable":true,"consecutiveFailures":1250,"lastDeliveryAt":"2026-08-19T04:21:07Z","lastDeliveryStatus":"Pending","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `WebhookUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["WebhookUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/WebhookView","description":"The resource as it stands after the change."}}},"WebhookUpdateStatus":{"title":"WebhookUpdateStatus","description":"Suspend or resume delivery. `Suspended` stops delivery and keeps the subscription; `Active` starts it again.","examples":[{"type":"WebhookUpdateStatus","status":"Active"}],"type":"object","required":["type","status"],"properties":{"type":{"description":"Always `WebhookUpdateStatus`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["WebhookUpdateStatus"]},"status":{"$ref":"#/components/schemas/WebhookStatus"}}},"WebhookView":{"oneOf":[{"$ref":"#/components/schemas/WebhookViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"WebhookViewAttributes":"#/components/schemas/WebhookViewAttributes"}}},"WebhookViewAttributes":{"title":"WebhookViewAttributes","description":"A subscription delivering platform events to an endpoint you control.","examples":[{"type":"WebhookViewAttributes","webhookId":"webhook_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","marketplaceId":"mktp_9f2Kd8QpLzXw","url":"https://example.com/callback","status":"Active","events":["MerchantCreated"],"description":"A short description.","metadata":{"yourKey":{}},"readable":true,"consecutiveFailures":1250,"lastDeliveryAt":"2026-08-19T04:21:07Z","lastDeliveryStatus":"Pending","createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","webhookId","url","status","readable","consecutiveFailures","createdAt","updatedAt"],"properties":{"type":{"description":"Always `WebhookViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["WebhookViewAttributes"]},"webhookId":{"$ref":"#/components/schemas/WebhookId"},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"The merchant whose events this delivers. Absent for a marketplace-wide subscription."},"marketplaceId":{"$ref":"#/components/schemas/MktpId","description":"The marketplace whose events this delivers."},"url":{"type":"string"},"status":{"$ref":"#/components/schemas/WebhookStatus"},"events":{"description":"The event types delivered.","type":"array","items":{"$ref":"#/components/schemas/WebhookEventType"}},"description":{"description":"What this subscription is for, in your own words.","type":"string"},"metadata":{"$ref":"#/components/schemas/Metadata","description":"Free-form data the platform stores and returns untouched."},"readable":{"description":"Whether the caller may read this subscription's detail. A subscription can be *listed* by a principal that may not see the endpoint it delivers to.","type":"boolean"},"consecutiveFailures":{"description":"How many deliveries created since the newest one your endpoint accepted are `Failed` or `Abandoned`; every such delivery when none was ever accepted, and 0 when there are none. Counted by when each delivery was created, so redelivering an old failure that then succeeds does not reset it. The platform does not suspend a subscription on its own, however high this goes.","type":"integer","format":"int32"},"lastDeliveryAt":{"description":"When we most recently tried to deliver anything to this subscription. Absent until the first attempt.","type":"string","format":"date-time"},"lastDeliveryStatus":{"$ref":"#/components/schemas/WebhookDeliveryStatus","description":"The status of this subscription's newest delivery. Absent when it has none."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"XaccCmd":{"oneOf":[{"$ref":"#/components/schemas/XaccCmdCreate"}],"discriminator":{"propertyName":"type","mapping":{"XaccCmdCreate":"#/components/schemas/XaccCmdCreate"}}},"XaccCmdCreate":{"title":"XaccCmdCreate","description":"Add a bank account the merchant can be paid out to.","examples":[{"type":"XaccCmdCreate","merchantId":"mcht_9f2Kd8QpLzXw","accountName":"Ada Lovelace","bankName":"Ada Lovelace","accountNumber":"example","routingNumber":"example","country":"AU","currency":"AUD","primary":true,"reference":"your-own-reference","requesterId":"abc123"}],"type":"object","required":["type","merchantId","accountName","accountNumber","routingNumber","country","currency","primary"],"properties":{"type":{"description":"Always `XaccCmdCreate`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["XaccCmdCreate"]},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"Whose account this is. The platform's operation is merchant-scoped and cannot resolve one otherwise."},"accountName":{"description":"Name of the person or business that holds the account.","type":"string"},"bankName":{"description":"Name of the financial institution.","type":"string"},"accountNumber":{"description":"Write-only. Digits only, and only the last four are ever returned.","type":"string"},"routingNumber":{"description":"Bank-state-branch for Australian accounts, six digits. Leave blank for New Zealand.","type":"string"},"country":{"description":"Two-letter country code the account is held in. Not derivable from the currency.","type":"string"},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"primary":{"description":"Whether payouts in this currency should go to this account. Required: the platform defaults it to `true`, which silently redirects a merchant's payouts.","type":"boolean"},"reference":{"description":"Your own reference for this account. Must be unique for the merchant.","type":"string"},"requesterId":{"description":"Who is asking. Required where the merchant's policy verifies accounts, because the verification is recorded against a person.","type":"string"}}},"XaccColumn":{"title":"XaccColumn","type":"string","enum":["ExternalAccountId","MerchantId","Reference","AccountName","BankName","RoutingNumber","Last4","Country","Currency","Status","BlockReason","Primary","Verified","VerificationOutcome","VerificationMatchedName","VerificationMessage","VerificationProvider","VerificationFailureMessage","VerificationVerifiedAt","CreatedAt","UpdatedAt"]},"XaccCreateRsp":{"oneOf":[{"$ref":"#/components/schemas/XaccCreateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"XaccCreateRspAttributes":"#/components/schemas/XaccCreateRspAttributes"}}},"XaccCreateRspAttributes":{"title":"XaccCreateRspAttributes","examples":[{"type":"XaccCreateRspAttributes","created":{"type":"XaccViewAttributes","externalAccountId":"xacc_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","reference":"your-own-reference","accountName":"Ada Lovelace","bankName":"Ada Lovelace","routingNumber":"example","last4":"4242","country":"AU","currency":"AUD","status":"Pending","blockReason":"Requested by the customer.","primary":true,"verified":true,"verification":{"type":"XaccVerificationAttributes","outcome":"Match","matchedName":"Ada Lovelace","message":"example","provider":"example","failureMessage":"example","verifiedAt":"2026-08-19T04:21:07Z"},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","created"],"properties":{"type":{"description":"Always `XaccCreateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["XaccCreateRspAttributes"]},"created":{"$ref":"#/components/schemas/XaccView","description":"The resource that was created."}}},"XaccId":{"title":"XaccId","examples":["xacc_9f2Kd8QpLzXw"],"type":"string"},"XaccPage":{"description":"A page of results, with the counts for whichever pagination mode was requested.","oneOf":[{"$ref":"#/components/schemas/XaccPageAttributes"}],"discriminator":{"propertyName":"type","mapping":{"XaccPageAttributes":"#/components/schemas/XaccPageAttributes"}}},"XaccPageAttributes":{"title":"XaccPageAttributes","description":"A page of results, with the counts for whichever pagination mode was requested.","examples":[{"type":"XaccPageAttributes","data":[{"type":"XaccViewAttributes","externalAccountId":"xacc_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","reference":"your-own-reference","accountName":"Ada Lovelace","bankName":"Ada Lovelace","routingNumber":"example","last4":"4242","country":"AU","currency":"AUD","status":"Pending","blockReason":"Requested by the customer.","primary":true,"verified":true,"verification":{"type":"XaccVerificationAttributes","outcome":"Match","matchedName":"Ada Lovelace","message":"example","provider":"example","failureMessage":"example","verifiedAt":"2026-08-19T04:21:07Z"},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"hasMore":true,"nextStartingAfter":"example","totalCount":42,"page":1250,"totalPages":1250}],"type":"object","required":["type","hasMore"],"properties":{"type":{"description":"Always `XaccPageAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["XaccPageAttributes"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/XaccView","description":"A bank account the platform pays a merchant out to."}},"hasMore":{"description":"Whether further items exist after this page.","type":"boolean"},"nextStartingAfter":{"description":"Id to pass as `startingAfter` to fetch the next page. Present in cursor mode only.","type":"string"},"totalCount":{"description":"Total items matching the query.","type":"integer","format":"int64"},"page":{"description":"The 1-based page returned. Present in offset mode only.","type":"integer","format":"int32"},"totalPages":{"description":"Total pages available. Present in offset mode only.","type":"integer","format":"int32"}}},"XaccStatus":{"title":"XaccStatus","type":"string","enum":["Pending","Active","Blocked","Deleted","Unknown"]},"XaccUpdate":{"oneOf":[{"$ref":"#/components/schemas/XaccUpdateRemove"},{"$ref":"#/components/schemas/XaccUpdateSetPrimary"},{"$ref":"#/components/schemas/XaccUpdateVerify"}],"discriminator":{"propertyName":"type","mapping":{"XaccUpdateRemove":"#/components/schemas/XaccUpdateRemove","XaccUpdateSetPrimary":"#/components/schemas/XaccUpdateSetPrimary","XaccUpdateVerify":"#/components/schemas/XaccUpdateVerify"}}},"XaccUpdateRemove":{"title":"XaccUpdateRemove","description":"Remove the account. It becomes `Deleted` rather than disappearing, because payouts already made to it still name it.","examples":[{"type":"XaccUpdateRemove","merchantId":"mcht_9f2Kd8QpLzXw"}],"type":"object","required":["type","merchantId"],"properties":{"type":{"description":"Always `XaccUpdateRemove`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["XaccUpdateRemove"]},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"Identifier of a merchant."}}},"XaccUpdateRsp":{"oneOf":[{"$ref":"#/components/schemas/XaccUpdateRspAttributes"}],"discriminator":{"propertyName":"type","mapping":{"XaccUpdateRspAttributes":"#/components/schemas/XaccUpdateRspAttributes"}}},"XaccUpdateRspAttributes":{"title":"XaccUpdateRspAttributes","examples":[{"type":"XaccUpdateRspAttributes","updated":{"type":"XaccViewAttributes","externalAccountId":"xacc_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","reference":"your-own-reference","accountName":"Ada Lovelace","bankName":"Ada Lovelace","routingNumber":"example","last4":"4242","country":"AU","currency":"AUD","status":"Pending","blockReason":"Requested by the customer.","primary":true,"verified":true,"verification":{"type":"XaccVerificationAttributes","outcome":"Match","matchedName":"Ada Lovelace","message":"example","provider":"example","failureMessage":"example","verifiedAt":"2026-08-19T04:21:07Z"},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}}],"type":"object","required":["type","updated"],"properties":{"type":{"description":"Always `XaccUpdateRspAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["XaccUpdateRspAttributes"]},"updated":{"$ref":"#/components/schemas/XaccView","description":"The resource as it stands after the change."}}},"XaccUpdateSetPrimary":{"title":"XaccUpdateSetPrimary","description":"Make this the account payouts in its currency go to. Edge's `SetMerchantPrimaryBankAccount`.","examples":[{"type":"XaccUpdateSetPrimary","merchantId":"mcht_9f2Kd8QpLzXw"}],"type":"object","required":["type","merchantId"],"properties":{"type":{"description":"Always `XaccUpdateSetPrimary`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["XaccUpdateSetPrimary"]},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"Identifier of a merchant."}}},"XaccUpdateVerify":{"title":"XaccUpdateVerify","description":"Ask the bank to confirm the account belongs to the merchant. Edge's `VerifyMerchantBankAccount`.","examples":[{"type":"XaccUpdateVerify","merchantId":"mcht_9f2Kd8QpLzXw","requesterId":"abc123"}],"type":"object","required":["type","merchantId","requesterId"],"properties":{"type":{"description":"Always `XaccUpdateVerify`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["XaccUpdateVerify"]},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"Identifier of a merchant."},"requesterId":{"description":"Who is asking. Required, the verification is recorded against a person.","type":"string"}}},"XaccVerification":{"description":"What the bank said about the name on the account. Present only where the merchant's policy returns it.","oneOf":[{"$ref":"#/components/schemas/XaccVerificationAttributes"}],"discriminator":{"propertyName":"type","mapping":{"XaccVerificationAttributes":"#/components/schemas/XaccVerificationAttributes"}}},"XaccVerificationAttributes":{"title":"XaccVerificationAttributes","description":"What the bank said about the name on the account.","examples":[{"type":"XaccVerificationAttributes","outcome":"Match","matchedName":"Ada Lovelace","message":"example","provider":"example","failureMessage":"example","verifiedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","outcome","provider","verifiedAt"],"properties":{"type":{"description":"Always `XaccVerificationAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["XaccVerificationAttributes"]},"outcome":{"$ref":"#/components/schemas/MchtVerificationOutcome"},"matchedName":{"description":"The name the bank holds for the account, where it returned one. This is what to compare against.","type":"string"},"message":{"description":"The bank's own words about the match.","type":"string"},"provider":{"description":"Which provider was asked.","type":"string"},"failureMessage":{"description":"Why the verification call itself failed, as opposed to the name not matching.","type":"string"},"verifiedAt":{"description":"When the bank answered.","type":"string","format":"date-time"}}},"XaccView":{"oneOf":[{"$ref":"#/components/schemas/XaccViewAttributes"}],"discriminator":{"propertyName":"type","mapping":{"XaccViewAttributes":"#/components/schemas/XaccViewAttributes"}}},"XaccViewAttributes":{"title":"XaccViewAttributes","description":"A bank account the platform pays a merchant out to.","examples":[{"type":"XaccViewAttributes","externalAccountId":"xacc_9f2Kd8QpLzXw","merchantId":"mcht_9f2Kd8QpLzXw","reference":"your-own-reference","accountName":"Ada Lovelace","bankName":"Ada Lovelace","routingNumber":"example","last4":"4242","country":"AU","currency":"AUD","status":"Pending","blockReason":"Requested by the customer.","primary":true,"verified":true,"verification":{"type":"XaccVerificationAttributes","outcome":"Match","matchedName":"Ada Lovelace","message":"example","provider":"example","failureMessage":"example","verifiedAt":"2026-08-19T04:21:07Z"},"createdAt":"2026-08-19T04:21:07Z","updatedAt":"2026-08-19T04:21:07Z"}],"type":"object","required":["type","externalAccountId","merchantId","routingNumber","last4","country","currency","status","primary","createdAt","updatedAt"],"properties":{"type":{"description":"Always `XaccViewAttributes`. Present so a payload says what it is, and so this shape can gain siblings without a breaking change.","type":"string","enum":["XaccViewAttributes"]},"externalAccountId":{"$ref":"#/components/schemas/XaccId","description":"Identifier of an external account."},"merchantId":{"$ref":"#/components/schemas/MchtId","description":"Identifier of a merchant."},"reference":{"description":"The merchant's own reference for this account. Unique per merchant, and how a merchant's own systems name it.","type":"string"},"accountName":{"description":"Name of the person or business that holds the account. Absent on accounts recorded before the field existed.","type":"string"},"bankName":{"description":"Name of the financial institution.","type":"string"},"routingNumber":{"description":"Bank-state-branch for Australian accounts, routing number elsewhere. Blank for New Zealand.","type":"string"},"last4":{"description":"Last four digits of the account number. The full number is never returned.","type":"string"},"country":{"description":"Two-letter country code the account is held in.","type":"string"},"currency":{"$ref":"#/components/schemas/IsoCurrency"},"status":{"$ref":"#/components/schemas/XaccStatus"},"blockReason":{"description":"Why the account was blocked. Present only when `status` is `Blocked`, and this is what to show a merchant whose payouts have stopped.","type":"string"},"primary":{"description":"Whether payouts in this currency go to this account. Derived by comparing against the merchant's primary.","type":"boolean"},"verified":{"description":"Whether verification succeeded. Absent where the merchant's policy does not verify accounts at all.","type":"boolean"},"verification":{"$ref":"#/components/schemas/XaccVerification"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"DisputeEvent":{"title":"DisputeEvent","description":"Delivered for `DisputeCreated` and `DisputeUpdated`.","type":"object","required":["webhookSubscriptionId","webhookEventType","merchantId","marketplaceId","metadata","event","timestamp","requestId"],"properties":{"webhookSubscriptionId":{"$ref":"#/components/schemas/WebhookId","description":"The subscription this delivery is for."},"webhookEventType":{"$ref":"#/components/schemas/WebhookEventType","description":"Which event this is. Always the event type this payload is published under."},"merchantId":{"description":"The merchant the event belongs to, `null` when it has none.","anyOf":[{"$ref":"#/components/schemas/MchtId"},{"type":"null"}]},"marketplaceId":{"description":"The marketplace the event belongs to, `null` when it has none.","anyOf":[{"$ref":"#/components/schemas/MktpId"},{"type":"null"}]},"metadata":{"anyOf":[{"description":"The subscription's own `metadata`, exactly as you stored it, `null` when it has none."},{"type":"null"}]},"event":{"$ref":"#/components/schemas/DisputeEventBody"},"timestamp":{"description":"When this attempt was sent, not when the event happened: a redelivery of the same event carries a later one.","type":"string","format":"date-time"},"requestId":{"description":"The platform request that caused the event, for quoting to support. `null` when there was none.","type":["string","null"]}}},"DisputeEventBody":{"title":"DisputeEventBody","description":"The event itself, as an object with one key naming its kind.","type":"object","required":["DisputeEvent"],"properties":{"DisputeEvent":{"$ref":"#/components/schemas/DisputeEventData"}}},"DisputeEventData":{"title":"DisputeEventData","description":"The dispute as it stands after the event.","type":"object","required":["disputeId","disputeAmount","disputeFee","transactionId","orderId","reason","state","outcome","payType","marketplaceId","merchantId","customerId","createdAt","updatedAt"],"properties":{"disputeId":{"type":"string"},"disputeAmount":{"description":"In minor units of the disputed transaction's currency.","type":"integer","format":"int64"},"disputeFee":{"description":"In minor units of the disputed transaction's currency.","type":"integer","format":"int64"},"transactionId":{"type":"string"},"orderId":{"type":"string"},"reason":{"type":"string"},"state":{"type":"string"},"outcome":{"type":"string"},"payType":{"description":"`PayInFull`, `PayPlan` or `Subscription`.","type":"string"},"marketplaceId":{"type":["string","null"]},"merchantId":{"type":"string"},"customerId":{"type":["string","null"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"LoanEvent":{"title":"LoanEvent","description":"Delivered for `LoanCreated`, `LoanStatementCreated`, `LoanStatementIssued`, `LoanStatementDue` and `LoanStatementPaid`, for trading account loans.","type":"object","required":["webhookSubscriptionId","webhookEventType","merchantId","marketplaceId","metadata","event","timestamp","requestId"],"properties":{"webhookSubscriptionId":{"$ref":"#/components/schemas/WebhookId","description":"The subscription this delivery is for."},"webhookEventType":{"$ref":"#/components/schemas/WebhookEventType","description":"Which event this is. Always the event type this payload is published under."},"merchantId":{"description":"The merchant the event belongs to, `null` when it has none.","anyOf":[{"$ref":"#/components/schemas/MchtId"},{"type":"null"}]},"marketplaceId":{"description":"The marketplace the event belongs to, `null` when it has none.","anyOf":[{"$ref":"#/components/schemas/MktpId"},{"type":"null"}]},"metadata":{"anyOf":[{"description":"The subscription's own `metadata`, exactly as you stored it, `null` when it has none."},{"type":"null"}]},"event":{"$ref":"#/components/schemas/LoanEventBody"},"timestamp":{"description":"When this attempt was sent, not when the event happened: a redelivery of the same event carries a later one.","type":"string","format":"date-time"},"requestId":{"description":"The platform request that caused the event, for quoting to support. `null` when there was none.","type":["string","null"]}}},"LoanEventBody":{"title":"LoanEventBody","description":"The event itself, as an object with one key naming its kind.","type":"object","required":["LoanEvent"],"properties":{"LoanEvent":{"$ref":"#/components/schemas/LoanEventData"}}},"LoanEventData":{"title":"LoanEventData","description":"The loan as it stands after the event.","type":"object","required":["loanId","referenceLoanId","loanAccountName","loanProductType","timeZone","borrowerCustomerId","borrowerMerchantId","borrowerMarketplaceId","currency","loanCreatedAt","loanUpdatedAt","loanStatement"],"properties":{"loanId":{"type":"string"},"referenceLoanId":{"type":["string","null"]},"loanAccountName":{"type":"string"},"loanProductType":{"description":"Always `TradingAccount`: no other kind of loan is delivered.","type":"string"},"timeZone":{"description":"The loan's IANA timezone, such as `Australia/Sydney`.","type":"string"},"borrowerCustomerId":{"type":"string"},"borrowerMerchantId":{"type":"string"},"borrowerMarketplaceId":{"type":["string","null"]},"currency":{"type":"string"},"loanCreatedAt":{"type":"string","format":"date-time"},"loanUpdatedAt":{"type":"string","format":"date-time"},"loanStatement":{"anyOf":[{"$ref":"#/components/schemas/LoanEventStatement"},{"type":"null"}]}}},"LoanEventStatement":{"title":"LoanEventStatement","description":"The statement the event is about, `null` on `LoanCreated`.","type":"object","required":["loanStatementId","referenceStatementId","startDate","endDate","billingDate","dueDate","status","netAmount","insuranceAmount","taxAmount","billedAmount","lateFeeAmount","outstandingAmount","createdAt","updatedAt"],"properties":{"loanStatementId":{"type":"string"},"referenceStatementId":{"type":"string"},"startDate":{"type":"string","format":"date"},"endDate":{"type":"string","format":"date"},"billingDate":{"type":"string","format":"date"},"dueDate":{"type":"string","format":"date"},"status":{"type":"string"},"netAmount":{"type":"integer","format":"int64"},"insuranceAmount":{"type":"integer","format":"int64"},"taxAmount":{"type":"integer","format":"int64"},"billedAmount":{"type":"integer","format":"int64"},"lateFeeAmount":{"description":"The late fee including its tax, 0 when there is none.","type":"integer","format":"int64"},"outstandingAmount":{"type":"integer","format":"int64"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"MchtEvent":{"title":"MchtEvent","description":"Delivered for `MerchantCreated`, `MerchantActivated`, `MerchantSuspended`, `MerchantAvailableBalanceUpdated`, `MerchantBankAccountAdded` and `MerchantPrimaryBankAccountUpdated`.","type":"object","required":["webhookSubscriptionId","webhookEventType","merchantId","marketplaceId","metadata","event","timestamp","requestId"],"properties":{"webhookSubscriptionId":{"$ref":"#/components/schemas/WebhookId","description":"The subscription this delivery is for."},"webhookEventType":{"$ref":"#/components/schemas/WebhookEventType","description":"Which event this is. Always the event type this payload is published under."},"merchantId":{"description":"The merchant the event belongs to, `null` when it has none.","anyOf":[{"$ref":"#/components/schemas/MchtId"},{"type":"null"}]},"marketplaceId":{"description":"The marketplace the event belongs to, `null` when it has none.","anyOf":[{"$ref":"#/components/schemas/MktpId"},{"type":"null"}]},"metadata":{"anyOf":[{"description":"The subscription's own `metadata`, exactly as you stored it, `null` when it has none."},{"type":"null"}]},"event":{"$ref":"#/components/schemas/MchtEventBody"},"timestamp":{"description":"When this attempt was sent, not when the event happened: a redelivery of the same event carries a later one.","type":"string","format":"date-time"},"requestId":{"description":"The platform request that caused the event, for quoting to support. `null` when there was none.","type":["string","null"]}}},"MchtEventBankAccount":{"title":"MchtEventBankAccount","type":"object","required":["accountId","accountName","bankName","currency","country","bsb","accountNumber","createdAt","isPrimaryForCurrency","referenceAccountId"],"properties":{"accountId":{"type":"string"},"accountName":{"type":"string"},"bankName":{"type":"string"},"currency":{"type":"string"},"country":{"type":"string"},"bsb":{"description":"The routing number, `null` where the country has none.","type":["string","null"]},"accountNumber":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"isPrimaryForCurrency":{"description":"Whether this is the merchant's primary account, the one automated payouts are paid to.","type":"boolean"},"referenceAccountId":{"type":["string","null"]}}},"MchtEventBody":{"title":"MchtEventBody","description":"The event itself, as an object with one key naming its kind.","type":"object","required":["MerchantEvent"],"properties":{"MerchantEvent":{"$ref":"#/components/schemas/MchtEventData"}}},"MchtEventData":{"title":"MchtEventData","description":"The merchant as it stands after the event.","type":"object","required":["marketplaceId","merchantId","referenceMerchantId","businessName","merchantType","status","tradingCurrency","availableBalance","bankAccounts","createdAt","updatedAt"],"properties":{"marketplaceId":{"type":["string","null"]},"merchantId":{"type":"string"},"referenceMerchantId":{"type":"string"},"businessName":{"type":"string"},"merchantType":{"type":"string"},"status":{"description":"`Pending` on `MerchantCreated`; otherwise the merchant's state, such as `Active` or `Suspended`.","type":"string"},"tradingCurrency":{"type":"string"},"availableBalance":{"description":"In minor units of `tradingCurrency`. Always 0 on `MerchantCreated`.","type":"integer","format":"int64"},"bankAccounts":{"description":"Empty on `MerchantCreated`.","type":["array","null"],"items":{"$ref":"#/components/schemas/MchtEventBankAccount"}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"MinvEvent":{"title":"MinvEvent","description":"Delivered for `InvoiceIssued`, `InvoiceDue`, `InvoicePaymentFailed` and `InvoicePaid`.","type":"object","required":["webhookSubscriptionId","webhookEventType","merchantId","marketplaceId","metadata","event","timestamp","requestId"],"properties":{"webhookSubscriptionId":{"$ref":"#/components/schemas/WebhookId","description":"The subscription this delivery is for."},"webhookEventType":{"$ref":"#/components/schemas/WebhookEventType","description":"Which event this is. Always the event type this payload is published under."},"merchantId":{"description":"The merchant the event belongs to, `null` when it has none.","anyOf":[{"$ref":"#/components/schemas/MchtId"},{"type":"null"}]},"marketplaceId":{"description":"The marketplace the event belongs to, `null` when it has none.","anyOf":[{"$ref":"#/components/schemas/MktpId"},{"type":"null"}]},"metadata":{"anyOf":[{"description":"The subscription's own `metadata`, exactly as you stored it, `null` when it has none."},{"type":"null"}]},"event":{"$ref":"#/components/schemas/MinvEventBody"},"timestamp":{"description":"When this attempt was sent, not when the event happened: a redelivery of the same event carries a later one.","type":"string","format":"date-time"},"requestId":{"description":"The platform request that caused the event, for quoting to support. `null` when there was none.","type":["string","null"]}}},"MinvEventBody":{"title":"MinvEventBody","description":"The event itself, as an object with one key naming its kind.","type":"object","required":["InvoiceEvent"],"properties":{"InvoiceEvent":{"$ref":"#/components/schemas/MinvEventData"}}},"MinvEventData":{"title":"MinvEventData","description":"The invoice as it stands after the event. `merchantId` and `marketplaceId` are the payer's.","type":"object","required":["invoiceId","invoiceReference","invoiceAmount","currency","paidAmount","invoiceStartDate","invoiceEndDate","dueDate","status","summary","failureReason","marketplaceId","merchantId","createdAt","updatedAt"],"properties":{"invoiceId":{"type":"string"},"invoiceReference":{"type":"string"},"invoiceAmount":{"description":"In minor units of `currency`: cents for AUD.","type":"integer","format":"int64"},"currency":{"type":"string"},"paidAmount":{"description":"In minor units of `currency`: cents for AUD.","type":"integer","format":"int64"},"invoiceStartDate":{"type":"string","format":"date"},"invoiceEndDate":{"type":"string","format":"date"},"dueDate":{"type":"string","format":"date"},"status":{"type":"string"},"summary":{"type":"string"},"failureReason":{"description":"Set on `InvoicePaymentFailed` only.","type":["string","null"]},"marketplaceId":{"type":["string","null"]},"merchantId":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"PayoutEvent":{"title":"PayoutEvent","description":"Delivered for `PayoutCreated`, `PayoutPending`, `PayoutFailed`, `PayoutPaid` and `PayoutReversed`.","type":"object","required":["webhookSubscriptionId","webhookEventType","merchantId","marketplaceId","metadata","event","timestamp","requestId"],"properties":{"webhookSubscriptionId":{"$ref":"#/components/schemas/WebhookId","description":"The subscription this delivery is for."},"webhookEventType":{"$ref":"#/components/schemas/WebhookEventType","description":"Which event this is. Always the event type this payload is published under."},"merchantId":{"description":"The merchant the event belongs to, `null` when it has none.","anyOf":[{"$ref":"#/components/schemas/MchtId"},{"type":"null"}]},"marketplaceId":{"description":"The marketplace the event belongs to, `null` when it has none.","anyOf":[{"$ref":"#/components/schemas/MktpId"},{"type":"null"}]},"metadata":{"anyOf":[{"description":"The subscription's own `metadata`, exactly as you stored it, `null` when it has none."},{"type":"null"}]},"event":{"$ref":"#/components/schemas/PayoutEventBody"},"timestamp":{"description":"When this attempt was sent, not when the event happened: a redelivery of the same event carries a later one.","type":"string","format":"date-time"},"requestId":{"description":"The platform request that caused the event, for quoting to support. `null` when there was none.","type":["string","null"]}}},"PayoutEventBody":{"title":"PayoutEventBody","description":"The event itself, as an object with one key naming its kind.","type":"object","required":["PayoutEvent"],"properties":{"PayoutEvent":{"$ref":"#/components/schemas/PayoutEventData"}}},"PayoutEventData":{"title":"PayoutEventData","description":"The payout as it stands after the event.","type":"object","required":["payoutId","referencePayoutId","payoutAmount","currency","openingBalance","closingBalance","arrivalDate","settlementDate","status","failureReason","statementDescriptor","marketplaceId","merchantId","createdAt","updatedAt"],"properties":{"payoutId":{"type":"string"},"referencePayoutId":{"type":["string","null"]},"payoutAmount":{"description":"In minor units of `currency`: cents for AUD.","type":"integer","format":"int64"},"currency":{"type":"string"},"openingBalance":{"description":"In minor units of `currency`: cents for AUD.","type":"integer","format":"int64"},"closingBalance":{"description":"In minor units of `currency`: cents for AUD.","type":"integer","format":"int64"},"arrivalDate":{"description":"`null` until the payout has an arrival date, and always on `PayoutCreated`.","type":["string","null"],"format":"date-time"},"settlementDate":{"type":["string","null"],"format":"date"},"status":{"description":"`Created`, `Pending`, `Failed`, `Paid` or `Reversed`.","type":"string"},"failureReason":{"type":["string","null"]},"statementDescriptor":{"type":["string","null"]},"marketplaceId":{"type":["string","null"]},"merchantId":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"PlanEvent":{"title":"PlanEvent","description":"Delivered for `PayPlanCreated`, `PayPlanActivated`, `PayPlanCompleted` and `PayPlanInDefault`. Deprecated: pay plans are not on Bezel, and no Bezel operation creates or reads one. Still delivered to a subscription that names it.","deprecated":true,"type":"object","required":["webhookSubscriptionId","webhookEventType","merchantId","marketplaceId","metadata","event","timestamp","requestId"],"properties":{"webhookSubscriptionId":{"$ref":"#/components/schemas/WebhookId","description":"The subscription this delivery is for."},"webhookEventType":{"$ref":"#/components/schemas/WebhookEventType","description":"Which event this is. Always the event type this payload is published under."},"merchantId":{"description":"The merchant the event belongs to, `null` when it has none.","anyOf":[{"$ref":"#/components/schemas/MchtId"},{"type":"null"}]},"marketplaceId":{"description":"The marketplace the event belongs to, `null` when it has none.","anyOf":[{"$ref":"#/components/schemas/MktpId"},{"type":"null"}]},"metadata":{"anyOf":[{"description":"The subscription's own `metadata`, exactly as you stored it, `null` when it has none."},{"type":"null"}]},"event":{"$ref":"#/components/schemas/PlanEventBody"},"timestamp":{"description":"When this attempt was sent, not when the event happened: a redelivery of the same event carries a later one.","type":"string","format":"date-time"},"requestId":{"description":"The platform request that caused the event, for quoting to support. `null` when there was none.","type":["string","null"]}}},"PlanEventBody":{"title":"PlanEventBody","description":"The event itself, as an object with one key naming its kind.","deprecated":true,"type":"object","required":["PayPlanEvent"],"properties":{"PayPlanEvent":{"$ref":"#/components/schemas/PlanEventData"}}},"PlanEventData":{"title":"PlanEventData","description":"The pay plan as it stands after the event. Deprecated: pay plans are not on Bezel, and no Bezel operation creates or reads one. Still delivered to a subscription that names it.","deprecated":true,"type":"object","required":["payPlanId","planAmount","initialAmount","outstandingAmount","currency","payPlanVariant","state","marketplaceId","merchantId","customerId","orderId","referenceOrderId","transactionId","createdAt","updatedAt"],"properties":{"payPlanId":{"type":"string"},"planAmount":{"description":"In minor units of `currency`: cents for AUD.","type":"integer","format":"int64"},"initialAmount":{"description":"In minor units of `currency`: cents for AUD.","type":"integer","format":"int64"},"outstandingAmount":{"description":"In minor units of `currency`: cents for AUD.","type":"integer","format":"int64"},"currency":{"type":"string"},"payPlanVariant":{"type":"string"},"state":{"description":"`Created`, `Active`, `Completed` or `InDefault`.","type":"string"},"marketplaceId":{"type":["string","null"]},"merchantId":{"type":"string"},"customerId":{"type":"string"},"orderId":{"type":["string","null"]},"referenceOrderId":{"type":["string","null"]},"transactionId":{"type":["string","null"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"PsrcEvent":{"title":"PsrcEvent","description":"Delivered for `PaymentSourceCreated`, `PaymentSourceMethodUpdated` and `PaymentSourceDeleted`, for a source that belongs to a customer.","type":"object","required":["webhookSubscriptionId","webhookEventType","merchantId","marketplaceId","metadata","event","timestamp","requestId"],"properties":{"webhookSubscriptionId":{"$ref":"#/components/schemas/WebhookId","description":"The subscription this delivery is for."},"webhookEventType":{"$ref":"#/components/schemas/WebhookEventType","description":"Which event this is. Always the event type this payload is published under."},"merchantId":{"description":"The merchant the event belongs to, `null` when it has none.","anyOf":[{"$ref":"#/components/schemas/MchtId"},{"type":"null"}]},"marketplaceId":{"description":"The marketplace the event belongs to, `null` when it has none.","anyOf":[{"$ref":"#/components/schemas/MktpId"},{"type":"null"}]},"metadata":{"anyOf":[{"description":"The subscription's own `metadata`, exactly as you stored it, `null` when it has none."},{"type":"null"}]},"event":{"$ref":"#/components/schemas/PsrcEventBody"},"timestamp":{"description":"When this attempt was sent, not when the event happened: a redelivery of the same event carries a later one.","type":"string","format":"date-time"},"requestId":{"description":"The platform request that caused the event, for quoting to support. `null` when there was none.","type":["string","null"]}}},"PsrcEventBody":{"title":"PsrcEventBody","description":"The event itself, as an object with one key naming its kind.","type":"object","required":["PaymentSourceEvent"],"properties":{"PaymentSourceEvent":{"$ref":"#/components/schemas/PsrcEventData"}}},"PsrcEventCard":{"title":"PsrcEventCard","type":"object","required":["cardBin","last4","brand","funding","expiryMonth","expiryYear","country"],"properties":{"cardBin":{"type":"string"},"last4":{"type":"string"},"brand":{"type":"string"},"funding":{"type":"string"},"expiryMonth":{"type":"integer","format":"int32"},"expiryYear":{"type":"integer","format":"int32"},"country":{"type":"string"}}},"PsrcEventData":{"title":"PsrcEventData","description":"The payment source as it stands after the event.","type":"object","required":["paymentSourceId","customerId","merchantId","customerDelegateId","delegateEmailAddress","marketplaceId","sourceMethod","usageScope","createdAt","updatedAt"],"properties":{"paymentSourceId":{"type":"string"},"customerId":{"type":["string","null"]},"merchantId":{"type":"string"},"customerDelegateId":{"type":["string","null"]},"delegateEmailAddress":{"type":["string","null"]},"marketplaceId":{"type":["string","null"]},"sourceMethod":{"anyOf":[{"$ref":"#/components/schemas/PsrcEventMethod"},{"type":"null"}]},"usageScope":{"type":["string","null"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"PsrcEventDirectDebit":{"title":"PsrcEventDirectDebit","type":"object","required":["emailAddress","agreementAcceptedDate","accountName","currency","routingNumber","accountNumber"],"properties":{"emailAddress":{"type":"string"},"agreementAcceptedDate":{"description":"When the direct debit agreement was accepted, in milliseconds since the epoch.","type":"integer","format":"int64"},"accountName":{"type":"string"},"currency":{"type":"string"},"routingNumber":{"type":"string"},"accountNumber":{"type":"string"}}},"PsrcEventMethod":{"description":"What the source pays with, `null` when it holds no method.","oneOf":[{"$ref":"#/components/schemas/PsrcEventMethodCard"},{"$ref":"#/components/schemas/PsrcEventMethodDirectDebit"},{"$ref":"#/components/schemas/PsrcEventMethodNetworkToken"},{"$ref":"#/components/schemas/PsrcEventMethodPayTo"}]},"PsrcEventMethodCard":{"title":"PsrcEventMethodCard","description":"An object with one key naming the kind of method.","type":"object","required":["CardMethod"],"properties":{"CardMethod":{"$ref":"#/components/schemas/PsrcEventCard"}}},"PsrcEventMethodDirectDebit":{"title":"PsrcEventMethodDirectDebit","description":"An object with one key naming the kind of method.","type":"object","required":["DirectDebit"],"properties":{"DirectDebit":{"$ref":"#/components/schemas/PsrcEventDirectDebit"}}},"PsrcEventMethodNetworkToken":{"title":"PsrcEventMethodNetworkToken","description":"An object with one key naming the kind of method.","type":"object","required":["NetworkToken"],"properties":{"NetworkToken":{"$ref":"#/components/schemas/PsrcEventNetworkToken"}}},"PsrcEventMethodPayTo":{"title":"PsrcEventMethodPayTo","description":"An object with one key naming the kind of method.","type":"object","required":["PayTo"],"properties":{"PayTo":{"$ref":"#/components/schemas/PsrcEventPayTo"}}},"PsrcEventNetworkToken":{"title":"PsrcEventNetworkToken","type":"object","required":["country","cardToken","last4","brand","expMonth","expYear","funding","cardBin","networkType"],"properties":{"country":{"type":"string"},"cardToken":{"type":"string"},"last4":{"type":"string"},"brand":{"type":"string"},"expMonth":{"type":"integer","format":"int32"},"expYear":{"type":"integer","format":"int32"},"funding":{"type":"string"},"cardBin":{"type":"string"},"networkType":{"type":"string"}}},"PsrcEventPayTo":{"title":"PsrcEventPayTo","type":"object","required":["agreementUid","accountHint"],"properties":{"agreementUid":{"type":"string"},"accountHint":{"type":"string"}}},"PtknEvent":{"title":"PtknEvent","description":"Delivered for `PayInFullCreated`, `PayInFullAccepted`, `PayInFullAuthorised` and `PayInFullCompleted`.","type":"object","required":["webhookSubscriptionId","webhookEventType","merchantId","marketplaceId","metadata","event","timestamp","requestId"],"properties":{"webhookSubscriptionId":{"$ref":"#/components/schemas/WebhookId","description":"The subscription this delivery is for."},"webhookEventType":{"$ref":"#/components/schemas/WebhookEventType","description":"Which event this is. Always the event type this payload is published under."},"merchantId":{"description":"The merchant the event belongs to, `null` when it has none.","anyOf":[{"$ref":"#/components/schemas/MchtId"},{"type":"null"}]},"marketplaceId":{"description":"The marketplace the event belongs to, `null` when it has none.","anyOf":[{"$ref":"#/components/schemas/MktpId"},{"type":"null"}]},"metadata":{"anyOf":[{"description":"The subscription's own `metadata`, exactly as you stored it, `null` when it has none."},{"type":"null"}]},"event":{"$ref":"#/components/schemas/PtknEventBody"},"timestamp":{"description":"When this attempt was sent, not when the event happened: a redelivery of the same event carries a later one.","type":"string","format":"date-time"},"requestId":{"description":"The platform request that caused the event, for quoting to support. `null` when there was none.","type":["string","null"]}}},"PtknEventBody":{"title":"PtknEventBody","description":"The event itself, as an object with one key naming its kind.","type":"object","required":["PayInFullEvent"],"properties":{"PayInFullEvent":{"$ref":"#/components/schemas/PtknEventData"}}},"PtknEventData":{"title":"PtknEventData","description":"The pay-in-full payment as it stands after the event.","type":"object","required":["amount","currency","state","marketplaceId","merchantId","customerId","orderId","referenceOrderId","orderType","orderMetadata","transactionId","createdAt","updatedAt"],"properties":{"amount":{"description":"In minor units of `currency`: cents for AUD.","type":"integer","format":"int64"},"currency":{"type":"string"},"state":{"description":"`Created`, `Accepted`, `Authorised` or `Completed`.","type":"string"},"marketplaceId":{"type":["string","null"]},"merchantId":{"type":"string"},"customerId":{"type":["string","null"]},"orderId":{"description":"`null` on `PayInFullCreated`, which comes before any order.","type":["string","null"]},"referenceOrderId":{"type":["string","null"]},"orderType":{"description":"The order's type in lower case, `paybylink` for a manual order. `null` on `PayInFullCreated`.","type":["string","null"]},"orderMetadata":{"anyOf":[{"description":"The order's metadata, exactly as stored, `null` when it has none."},{"type":"null"}]},"transactionId":{"type":["string","null"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"TranEvent":{"title":"TranEvent","description":"Delivered for `TransactionPaid` and `TransactionFailed`.","type":"object","required":["webhookSubscriptionId","webhookEventType","merchantId","marketplaceId","metadata","event","timestamp","requestId"],"properties":{"webhookSubscriptionId":{"$ref":"#/components/schemas/WebhookId","description":"The subscription this delivery is for."},"webhookEventType":{"$ref":"#/components/schemas/WebhookEventType","description":"Which event this is. Always the event type this payload is published under."},"merchantId":{"description":"The merchant the event belongs to, `null` when it has none.","anyOf":[{"$ref":"#/components/schemas/MchtId"},{"type":"null"}]},"marketplaceId":{"description":"The marketplace the event belongs to, `null` when it has none.","anyOf":[{"$ref":"#/components/schemas/MktpId"},{"type":"null"}]},"metadata":{"anyOf":[{"description":"The subscription's own `metadata`, exactly as you stored it, `null` when it has none."},{"type":"null"}]},"event":{"$ref":"#/components/schemas/TranEventBody"},"timestamp":{"description":"When this attempt was sent, not when the event happened: a redelivery of the same event carries a later one.","type":"string","format":"date-time"},"requestId":{"description":"The platform request that caused the event, for quoting to support. `null` when there was none.","type":["string","null"]}}},"TranEventBody":{"title":"TranEventBody","description":"The event itself, as an object with one key naming its kind.","type":"object","required":["TransactionEvent"],"properties":{"TransactionEvent":{"$ref":"#/components/schemas/TranEventData"}}},"TranEventData":{"title":"TranEventData","description":"The transaction as it stands after the event.","type":"object","required":["amount","currency","transactionId","transactionStatus","marketplaceId","merchantId","referenceMerchantId","customerId","referenceCustomerId","orderId","referenceOrderId","payType","orderType","orderMetadata","availableOn","errorCode","errorMessage","errorDetails","createdAt","updatedAt"],"properties":{"amount":{"description":"In minor units of `currency`: cents for AUD.","type":"integer","format":"int64"},"currency":{"type":"string"},"transactionId":{"type":"string"},"transactionStatus":{"description":"The transaction's status in lower case: `paid` or `pending` on `TransactionPaid`, `failed` on `TransactionFailed`.","type":"string"},"marketplaceId":{"type":["string","null"]},"merchantId":{"type":"string"},"referenceMerchantId":{"type":["string","null"]},"customerId":{"type":["string","null"]},"referenceCustomerId":{"type":["string","null"]},"orderId":{"type":"string"},"referenceOrderId":{"type":["string","null"]},"payType":{"description":"`PayInFull`, `PayPlan` or `Subscription`.","type":"string"},"orderType":{"description":"The order's type in lower case, `paybylink` for a manual order.","type":"string"},"orderMetadata":{"anyOf":[{"description":"The order's metadata, exactly as stored, `null` when it has none."},{"type":"null"}]},"availableOn":{"description":"When the funds become available to the merchant, `null` when not known.","type":["string","null"],"format":"date"},"errorCode":{"description":"Why the payment failed, when it did and the provider said.","type":["string","null"]},"errorMessage":{"type":["string","null"]},"errorDetails":{"type":["string","null"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}}},"securitySchemes":{"Admin JWT | IAM User JWT":{"type":"http","description":"Admin JWT or IAM User JWT","scheme":"bearer"},"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Customer JWT | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":{"type":"http","description":"Marketplace API Key or Enterprise API Key or Merchant Secret Token or Customer JWT or Merchant JWT or Marketplace JWT or Admin JWT or IAM User JWT","scheme":"bearer"},"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Marketplace JWT | Admin JWT | IAM User JWT":{"type":"http","description":"Marketplace API Key or Enterprise API Key or Merchant Secret Token or Marketplace JWT or Admin JWT or IAM User JWT","scheme":"bearer"},"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":{"type":"http","description":"Marketplace API Key or Enterprise API Key or Merchant Secret Token or Merchant JWT or Marketplace JWT or Admin JWT or Customer JWT or IAM User JWT","scheme":"bearer"},"Marketplace API Key | Enterprise API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":{"type":"http","description":"Marketplace API Key or Enterprise API Key or Merchant Secret Token or Merchant JWT or Marketplace JWT or Admin JWT or IAM User JWT","scheme":"bearer"},"Marketplace API Key | Merchant Public Token | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":{"type":"http","description":"Marketplace API Key or Merchant Public Token or Merchant Secret Token or Merchant JWT or Marketplace JWT or Admin JWT or Customer JWT or IAM User JWT","scheme":"bearer"},"Marketplace API Key | Merchant Secret Token | Admin JWT | IAM User JWT":{"type":"http","description":"Marketplace API Key or Merchant Secret Token or Admin JWT or IAM User JWT","scheme":"bearer"},"Marketplace API Key | Merchant Secret Token | Customer JWT | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":{"type":"http","description":"Marketplace API Key or Merchant Secret Token or Customer JWT or Merchant JWT or Marketplace JWT or Admin JWT or IAM User JWT","scheme":"bearer"},"Marketplace API Key | Merchant Secret Token | IAM User JWT | Customer JWT | Merchant JWT | Marketplace JWT | Admin JWT":{"type":"http","description":"Marketplace API Key or Merchant Secret Token or IAM User JWT or Customer JWT or Merchant JWT or Marketplace JWT or Admin JWT","scheme":"bearer"},"Marketplace API Key | Merchant Secret Token | Magic Link Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":{"type":"http","description":"Marketplace API Key or Merchant Secret Token or Magic Link Token or Merchant JWT or Marketplace JWT or Admin JWT or Customer JWT or IAM User JWT","scheme":"bearer"},"Marketplace API Key | Merchant Secret Token | Marketplace JWT | Admin JWT | IAM User JWT":{"type":"http","description":"Marketplace API Key or Merchant Secret Token or Marketplace JWT or Admin JWT or IAM User JWT","scheme":"bearer"},"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT | IAM User JWT":{"type":"http","description":"Marketplace API Key or Merchant Secret Token or Merchant JWT or Marketplace JWT or Admin JWT or Customer JWT or IAM User JWT","scheme":"bearer"},"Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | IAM User JWT":{"type":"http","description":"Marketplace API Key or Merchant Secret Token or Merchant JWT or Marketplace JWT or Admin JWT or IAM User JWT","scheme":"bearer"},"Marketplace API Key | Merchant Secret Token | User Auth Token | IAM User JWT | Customer JWT | Merchant JWT | Marketplace JWT | Admin JWT":{"type":"http","description":"Optional. Marketplace API Key or Merchant Secret Token or User Auth Token or IAM User JWT or Customer JWT or Merchant JWT or Marketplace JWT or Admin JWT","scheme":"bearer"},"httpAuth":{"type":"http","scheme":"basic"},"httpAuth1":{"type":"http","scheme":"bearer"}}}}