{"items":[{"type":"link","label":"Omno Cashier API","link":"/apis/cashier-api/openapi","routeSlug":"/apis/cashier-api/openapi","content":{"contentType":"overview","meta":{"name":"Omno Cashier API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/apis/cashier-api/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/apis/cashier-api/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.omno.com","description":"Production"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Omno Cashier API (3.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Cashier API operations, on "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"/v3/public/..."},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Single source of truth; the canonical reference for every operation is under Other APIs."},"children":[],"type":"text"}],"type":"paragraph"}]}],"sectionId":"/"}],"sectionId":"/"}]}]}},{"type":"group","label":"Cashier","link":"/apis/cashier-api/openapi/cashier","routeSlug":"/apis/cashier-api/openapi/cashier","items":[],"content":{"contentType":"group","meta":{"name":"Cashier"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cashier","showPageActions":true},{"nodeType":"markdoc","content":"Create a Cashier session and verify the resulting transactions."}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cashier"}],"panels":[]}]}},{"type":"group","label":"Cashier Session","link":"/apis/cashier-api/openapi/cashier-session","routeSlug":"/apis/cashier-api/openapi/cashier-session","items":[{"label":"Create cashier session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/cashier-api/openapi/cashier-session/createcashiersession","routeSlug":"/apis/cashier-api/openapi/cashier-session/createcashiersession","metadata":{"seo":{"title":"Create cashier session","description":"Creates a cashier session for a customer and returns the sessionId, the hosted URLs, and a short-lived token used to open the session. Open the session on your frontend with the Web SDK, forwarding both sessionId and token; see the Guides topic Integrating the Cashier for how the backend call and the frontend fit together."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCashierSession","name":"Create cashier session","isWebhook":false,"pointer":"/paths/~1v3~1public~1cashier~1session/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create cashier session","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Creates a cashier session for a customer and returns the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"sessionId"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", the hosted URLs, and a short-lived "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" used to open the session. Open the session on your frontend with the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.omno.com/cashier/sdk/quick-start"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Web SDK"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", forwarding both "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"sessionId"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"; see the Guides topic "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.omno.com/cashier/integrate"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Integrating the Cashier"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for how the backend call and the frontend fit together."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ℹ️ Treat "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" like a credential: pass it from your backend to the > frontend only to open this session, and never log it. Omno verifies it > against its published signing keys (JWKS) — you do not validate it > yourself."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{"level":3,"id":"cashier-session/createcashiersession/request/selecting-payment-types","deepLinkHash":"/cashier-session/createcashiersession#cashier-session/createcashiersession/request/selecting-payment-types"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Selecting payment types"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"paymentTypes"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" controls which methods appear in the cashier. Allowed values: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"CARD"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"APM"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"CRYPTO"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Provide one value or any combination."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"⚠️ Only the listed types are shown. To accept card payments you "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"must"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" include "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"CARD"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"; a method you omit is not available to the customer."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Examples: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"[\"CARD\"]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" (card only — also used for a Single Payment card session and for Hosted Payment Fields), "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"[\"APM\"]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" (APM only), "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"[\"CARD\",\"CRYPTO\"]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"[\"CARD\",\"APM\",\"CRYPTO\"]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". The JSON key is "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"paymentTypes"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"level":3,"id":"cashier-session/createcashiersession/request/deposit-only-withdrawal-only","deepLinkHash":"/cashier-session/createcashiersession#cashier-session/createcashiersession/request/deposit-only-withdrawal-only"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Deposit-only / withdrawal-only"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Set "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"disallowWithdrawal: true"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for a deposit-only session, or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"disallowDeposit: true"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for a withdrawal-only session. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"balance"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is shown on the withdrawal widget. Don't set both "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"disallowDeposit"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"disallowWithdrawal"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"true"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"level":3,"id":"cashier-session/createcashiersession/request/customer-identification","deepLinkHash":"/cashier-session/createcashiersession#cashier-session/createcashiersession/request/customer-identification"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Customer identification"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Identify the customer with exactly one of: an inline "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"customer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object, an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"externalCustomerId"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", or an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"internalCustomerId"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" (Omno customer ID). Send exactly one."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"level":3,"id":"cashier-session/createcashiersession/request/session-lifetime","deepLinkHash":"/cashier-session/createcashiersession#cashier-session/createcashiersession/request/session-lifetime"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Session lifetime"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The session — and its "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" — is valid for "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"15 minutes from creation"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". The token can be reused for the same session until it expires. Create the session right before you open the Cashier, not at page load."},"children":[],"type":"text"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateCashierSessionRequest"}},"schemaId":"components/schemas/CreateCashierSessionRequest","pointer":"/paths/~1v3~1public~1cashier~1session/post/requestBody","description":"Create Cashier Request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/public/cashier/session","servers":[{"url":"https://api.omno.com","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateCashierSessionRequest"}},"responseCodes":["200","400","401","403","404","409","500"],"pointer":"/v3/public/cashier/session","href":"cashier-session/createcashiersession","openApiOperationId":"createCashierSession","summary":"Create cashier session"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.omno.com","description":"Production"}],"schemaId":"components/schemas/CreateCashierSessionRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateCashierSessionRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Cashier session created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateCashierSessionResponse"}},"schemaId":"components/schemas/CreateCashierSessionResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v3~1public~1cashier~1session/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreateCashierSessionResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateCashierSessionResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"409","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cashier-session/createcashiersession"}],"panels":[]}]},"httpPath":"/v3/public/cashier/session"}],"content":{"contentType":"group","meta":{"name":"Cashier Session"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cashier Session","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/public/cashier/session","summary":"Create cashier session","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cashier-session/createcashiersession","deprecated":false}]}]}]}]}},{"type":"group","label":"Customer","link":"/apis/cashier-api/openapi/customer","routeSlug":"/apis/cashier-api/openapi/customer","items":[{"label":"Create or update customer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/cashier-api/openapi/customer/createorupdatecustomer","routeSlug":"/apis/cashier-api/openapi/customer/createorupdatecustomer","metadata":{"seo":{"title":"Create or update customer","description":"Creates or updates a customer for the authenticated merchant. Calling again with the same externalUserId updates the existing customer. customerGroups and kyc.kycLevels drive PSP eligibility — see Routing & PSP Eligibility."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createOrUpdateCustomer","name":"Create or update customer","isWebhook":false,"pointer":"/paths/~1v3~1public~1customer/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create or update customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Creates or updates a customer for the authenticated merchant. Calling again with the same "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"externalUserId"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" updates the existing customer. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"customerGroups"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"kyc.kycLevels"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" drive PSP eligibility — see "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://docs.omno.com/guides/concepts/routing"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Routing & PSP Eligibility"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomerRequest"}},"schemaId":"components/schemas/CustomerRequest","pointer":"/paths/~1v3~1public~1customer/post/requestBody","description":"Create customer request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/public/customer","servers":[{"url":"https://api.omno.com","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CustomerRequest"}},"responseCodes":["200","400","401","403","404","409","500"],"pointer":"/v3/public/customer","href":"customer/createorupdatecustomer","openApiOperationId":"createOrUpdateCustomer","summary":"Create or update customer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.omno.com","description":"Production"}],"schemaId":"components/schemas/CustomerRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomerRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Customer created or updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerResponse"}},"schemaId":"components/schemas/CustomerResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v3~1public~1customer/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomerResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"409","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer/createorupdatecustomer"}],"panels":[]}]},"httpPath":"/v3/public/customer"}],"content":{"contentType":"group","meta":{"name":"Customer"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Customer","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/public/customer","summary":"Create or update customer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/customer/createorupdatecustomer","deprecated":false}]}]}]}]}},{"type":"group","label":"Get Transaction Info","link":"/apis/cashier-api/openapi/get-transaction-info","routeSlug":"/apis/cashier-api/openapi/get-transaction-info","items":[{"label":"Fetch payin transaction","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/cashier-api/openapi/get-transaction-info/fetchpayintransaction","routeSlug":"/apis/cashier-api/openapi/get-transaction-info/fetchpayintransaction","metadata":{"seo":{"title":"Fetch payin transaction","description":"Returns the pay-in transaction for the given ID. This is the authoritative status check for a pay-in, used alongside webhooks. Never rely on redirects or client-side events for the final status."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"fetchPayInTransaction","name":"Fetch payin transaction","isWebhook":false,"pointer":"/paths/~1v3~1public~1payin~1{payinId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch payin transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the pay-in transaction for the given ID. This is the authoritative status check for a pay-in, used alongside webhooks. Never rely on redirects or client-side events for the final status."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payinId","in":"path","schemaId":"schema_0","description":"Payment transaction ID","required":true,"example":"944732c4608c441aa91379478b91f76e"}],"pointer":"/paths/~1v3~1public~1payin~1{payinId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/public/payin/{payinId}","servers":[{"url":"https://api.omno.com","description":"Production"}],"parameters":{"path":[{"name":"payinId","in":"path","required":true,"example":"944732c4608c441aa91379478b91f76e","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","500"],"pointer":"/v3/public/payin/{payinId}","href":"get-transaction-info/fetchpayintransaction","openApiOperationId":"fetchPayInTransaction","summary":"Fetch payin transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.omno.com","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Payment transaction details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayInTransaction","exampleIds":["paths/~1v3~1public~1payin~1{payinId}/get/responses/200/content/application~1json/examples/success","paths/~1v3~1public~1payin~1{payinId}/get/responses/200/content/application~1json/examples/declined"]}},"schemaId":"components/schemas/PayInTransaction","exampleIds":["paths/~1v3~1public~1payin~1{payinId}/get/responses/200/content/application~1json/examples/success","paths/~1v3~1public~1payin~1{payinId}/get/responses/200/content/application~1json/examples/declined"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v3~1public~1payin~1{payinId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PayInTransaction","exampleIds":["paths/~1v3~1public~1payin~1{payinId}/get/responses/200/content/application~1json/examples/success","paths/~1v3~1public~1payin~1{payinId}/get/responses/200/content/application~1json/examples/declined"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayInTransaction","exampleIds":["paths/~1v3~1public~1payin~1{payinId}/get/responses/200/content/application~1json/examples/success","paths/~1v3~1public~1payin~1{payinId}/get/responses/200/content/application~1json/examples/declined"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"409","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/get-transaction-info/fetchpayintransaction"}],"panels":[]}]},"httpPath":"/v3/public/payin/{payinId}"},{"label":"Fetch payout transaction","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/cashier-api/openapi/get-transaction-info/fetchpayouttransaction","routeSlug":"/apis/cashier-api/openapi/get-transaction-info/fetchpayouttransaction","metadata":{"seo":{"title":"Fetch payout transaction","description":"Returns the payout transaction for the given ID. This is the authoritative status check for a payout, used alongside webhooks. Never rely on redirects or client-side events for the final status."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"fetchPayoutTransaction","name":"Fetch payout transaction","isWebhook":false,"pointer":"/paths/~1v3~1public~1payout~1{payoutId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch payout transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the payout transaction for the given ID. This is the authoritative status check for a payout, used alongside webhooks. Never rely on redirects or client-side events for the final status."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payoutId","in":"path","schemaId":"schema_0","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Payout ID. Returned by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"createPayout"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"required":true,"example":"944732c4608c441aa91379478b91f76e"}],"pointer":"/paths/~1v3~1public~1payout~1{payoutId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/public/payout/{payoutId}","servers":[{"url":"https://api.omno.com","description":"Production"}],"parameters":{"path":[{"name":"payoutId","in":"path","required":true,"example":"944732c4608c441aa91379478b91f76e","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","500"],"pointer":"/v3/public/payout/{payoutId}","href":"get-transaction-info/fetchpayouttransaction","openApiOperationId":"fetchPayoutTransaction","summary":"Fetch payout transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.omno.com","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Payout transaction","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutTransaction","exampleIds":["paths/~1v3~1public~1payout~1{payoutId}/get/responses/200/content/application~1json/examples/processed"]}},"schemaId":"components/schemas/PayoutTransaction","exampleIds":["paths/~1v3~1public~1payout~1{payoutId}/get/responses/200/content/application~1json/examples/processed"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v3~1public~1payout~1{payoutId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PayoutTransaction","exampleIds":["paths/~1v3~1public~1payout~1{payoutId}/get/responses/200/content/application~1json/examples/processed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutTransaction","exampleIds":["paths/~1v3~1public~1payout~1{payoutId}/get/responses/200/content/application~1json/examples/processed"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"409","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/get-transaction-info/fetchpayouttransaction"}],"panels":[]}]},"httpPath":"/v3/public/payout/{payoutId}"}],"content":{"contentType":"group","meta":{"name":"Get Transaction Info"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Transaction Info","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/public/payin/{payinId}","summary":"Fetch payin transaction","prefix":{"name":"get","color":"get"},"badges":[],"link":"/get-transaction-info/fetchpayintransaction","deprecated":false},{"title":"/v3/public/payout/{payoutId}","summary":"Fetch payout transaction","prefix":{"name":"get","color":"get"},"badges":[],"link":"/get-transaction-info/fetchpayouttransaction","deprecated":false}]}]}]}]}},{"type":"group","label":"Confirm / Reject Payout","link":"/apis/cashier-api/openapi/confirm-reject-payout","routeSlug":"/apis/cashier-api/openapi/confirm-reject-payout","items":[{"label":"Confirm payout transaction","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/cashier-api/openapi/confirm-reject-payout/confirmpayout","routeSlug":"/apis/cashier-api/openapi/confirm-reject-payout/confirmpayout","metadata":{"seo":{"title":"Confirm payout transaction","description":"Confirms a payout that is in WAITING_FOR_CONFIRMATION. After confirmation the transaction starts processing and its status becomes PENDING. Used when a payout requires manual approval, across Cashier, Direct Link and Payment Page flows."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"confirmPayout","name":"Confirm payout transaction","isWebhook":false,"pointer":"/paths/~1v3~1public~1payout~1{payoutId}~1confirm/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Confirm payout transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Confirms a payout that is in "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"WAITING_FOR_CONFIRMATION"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". After confirmation the transaction starts processing and its status becomes "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"PENDING"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Used when a payout requires manual approval, across Cashier, Direct Link and Payment Page flows."},"children":[],"type":"text"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payoutId","in":"path","schemaId":"schema_0","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Payout ID. Returned by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"createPayout"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"required":true,"example":"944732c4608c441aa91379478b91f76e"}],"pointer":"/paths/~1v3~1public~1payout~1{payoutId}~1confirm/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/public/payout/{payoutId}/confirm","servers":[{"url":"https://api.omno.com","description":"Production"}],"parameters":{"path":[{"name":"payoutId","in":"path","required":true,"example":"944732c4608c441aa91379478b91f76e","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","409","500"],"pointer":"/v3/public/payout/{payoutId}/confirm","href":"confirm-reject-payout/confirmpayout","openApiOperationId":"confirmPayout","summary":"Confirm payout transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.omno.com","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Payout transaction confirmed. Status becomes "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"PENDING"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"409","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Conflict. The payout is not in "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"WAITING_FOR_CONFIRMATION"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and cannot be confirmed."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v3~1public~1payout~1{payoutId}~1confirm/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"409","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/confirm-reject-payout/confirmpayout"}],"panels":[]}]},"httpPath":"/v3/public/payout/{payoutId}/confirm"},{"label":"Reject payout transaction","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/cashier-api/openapi/confirm-reject-payout/rejectpayout","routeSlug":"/apis/cashier-api/openapi/confirm-reject-payout/rejectpayout","metadata":{"seo":{"title":"Reject payout transaction","description":"Rejects a payout that is in WAITING_FOR_CONFIRMATION. After rejection the transaction is not sent to a PSP and its status becomes REJECTED. Used when a payout requires manual approval, across Cashier, Direct Link and Payment Page flows."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"rejectPayout","name":"Reject payout transaction","isWebhook":false,"pointer":"/paths/~1v3~1public~1payout~1{payoutId}~1reject/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reject payout transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Rejects a payout that is in "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"WAITING_FOR_CONFIRMATION"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". After rejection the transaction is "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"not"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" sent to a PSP and its status becomes "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"REJECTED"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Used when a payout requires manual approval, across Cashier, Direct Link and Payment Page flows."},"children":[],"type":"text"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payoutId","in":"path","schemaId":"schema_0","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Payout ID. Returned by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"createPayout"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"required":true,"example":"944732c4608c441aa91379478b91f76e"}],"pointer":"/paths/~1v3~1public~1payout~1{payoutId}~1reject/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/public/payout/{payoutId}/reject","servers":[{"url":"https://api.omno.com","description":"Production"}],"parameters":{"path":[{"name":"payoutId","in":"path","required":true,"example":"944732c4608c441aa91379478b91f76e","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","409","500"],"pointer":"/v3/public/payout/{payoutId}/reject","href":"confirm-reject-payout/rejectpayout","openApiOperationId":"rejectPayout","summary":"Reject payout transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.omno.com","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Payout transaction rejected. Status becomes "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"REJECTED"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"409","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Conflict. The payout is not in "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"WAITING_FOR_CONFIRMATION"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and cannot be rejected."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v3~1public~1payout~1{payoutId}~1reject/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"409","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/confirm-reject-payout/rejectpayout"}],"panels":[]}]},"httpPath":"/v3/public/payout/{payoutId}/reject"}],"content":{"contentType":"group","meta":{"name":"Confirm / Reject Payout"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Confirm / Reject Payout","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/public/payout/{payoutId}/confirm","summary":"Confirm payout transaction","prefix":{"name":"put","color":"put"},"badges":[],"link":"/confirm-reject-payout/confirmpayout","deprecated":false},{"title":"/v3/public/payout/{payoutId}/reject","summary":"Reject payout transaction","prefix":{"name":"put","color":"put"},"badges":[],"link":"/confirm-reject-payout/rejectpayout","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/CustomerBilling":{"id":"components/schemas/CustomerBilling","kind":"json-schema","title":"CustomerBilling","data":{"required":["address","city","countryCode","postalCode","state"],"type":"object","properties":{"address":{"type":"string","description":"Customer billing address.","example":"123 Main St"},"city":{"type":"string","description":"Customer billing city.","example":"Atlanta"},"state":{"type":"string","description":"Customer billing state.","example":"GA"},"countryCode":{"type":"string","description":"Customer billing country code (ISO 3166-1 alpha-2).","example":"US"},"postalCode":{"type":"string","description":"Customer billing postal code.","example":"30308"}},"description":"Customer billing information"}},"components/schemas/CustomerKyc":{"id":"components/schemas/CustomerKyc","kind":"json-schema","title":"CustomerKyc","data":{"type":"object","properties":{"idType":{"type":"string","description":"Identity document type.","example":"passport"},"idNumber":{"type":"string","description":"Identity document number.","example":"A12345678"},"idCountry":{"type":"string","description":"Country that issued the identity document (ISO 3166-1 alpha-2).","example":"US"},"idExpirationDate":{"type":"string","format":"date","description":"Identity document expiration date.","example":"2030-12-31"},"nationality":{"type":"string","description":"Customer nationality (ISO 3166-1 alpha-2).","example":"US"},"countryOfBirth":{"type":"string","description":"Customer country of birth (ISO 3166-1 alpha-2).","example":"US"},"kycLevels":{"type":"array","description":"KYC levels associated with the customer. Merchant-defined string labels, matched against each provider's KYC rules during eligibility filtering.","items":{"type":"string"},"example":["Identity Check","Mail Verification"]},"allowBypass":{"type":"boolean","description":"Whether KYC requirements may be bypassed for this customer.","example":true}},"description":"Customer KYC information"}},"components/schemas/CustomerRequest":{"id":"components/schemas/CustomerRequest","kind":"json-schema","title":"CustomerRequest","data":{"required":["billing","dateOfBirth","email","externalUserId","firstName","lastName","phoneNumber"],"type":"object","properties":{"externalUserId":{"type":"string","description":"Your unique identifier for this customer. Calling the customer endpoint again with the same value updates the existing customer.","example":"3183818381183"},"firstName":{"type":"string","description":"Customer first name.","example":"John"},"lastName":{"type":"string","description":"Customer last name.","example":"Doe"},"email":{"type":"string","description":"Customer email.","example":"john.doe@example.com"},"phoneNumber":{"type":"string","description":"Customer phone number.","example":"1 1234567890"},"dateOfBirth":{"type":"string","description":"Customer date of birth.","format":"date","example":"1990-12-01"},"userName":{"type":"string","description":"Customer username.","example":"John123"},"customerGroups":{"type":"array","description":"Customer groups the customer belongs to. Merchant-defined string labels, matched against each provider's group rules during eligibility filtering.","items":{"type":"string"},"example":["Vipgroup"]},"billing":{"$ref":"#/components/schemas/CustomerBilling"},"kyc":{"$ref":"#/components/schemas/CustomerKyc"}},"description":"Customer information"}},"components/schemas/CreateCashierSessionRequest":{"id":"components/schemas/CreateCashierSessionRequest","kind":"json-schema","title":"CreateCashierSessionRequest","data":{"required":["currency"],"type":"object","properties":{"customer":{"$ref":"#/components/schemas/CustomerRequest"},"externalCustomerId":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Existing merchant-side customer identifier. Optional alternative to an inline "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"customer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object."},"children":[],"type":"text"}],"type":"paragraph"}]},"internalCustomerId":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Existing Omno customer ID. Optional alternative to an inline "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"customer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object."},"children":[],"type":"text"}],"type":"paragraph"}]},"currency":{"type":"string","description":"Currency for the cashier session, in which all pay-in/pay-out transactions are created (ISO 4217).","example":"EUR"},"amount":{"type":"string","description":"Pre-fills the deposit amount for the session.","example":"1000.50"},"balance":{"type":"string","description":"Current balance of the customer. Shown on the withdrawal widget.","example":"1000.50"},"kycVerified":{"type":"boolean","description":"Whether this customer is KYC verified in your system.","example":true},"previousTransactionCount":{"type":"integer","description":"Number of previous transactions the customer made in your system.","minimum":0,"example":5},"paymentTypes":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Payment methods shown in the cashier. Provide one value or any combination. Only the listed types are shown; to accept card payments you must include "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"CARD"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Provide a single value (for example "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"[\"CARD\"]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") for a Single Payment or Hosted Payment Fields session."},"children":[],"type":"text"}],"type":"paragraph"}],"minItems":1,"items":{"type":"string","enum":["CARD","APM","CRYPTO"]},"example":["CARD","APM","CRYPTO"]},"disallowDeposit":{"type":"boolean","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"When "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"true"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", deposits are not offered in the session (withdrawal-only session). Don't set both "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"disallowDeposit"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"disallowWithdrawal"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"true"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"example":false},"disallowWithdrawal":{"type":"boolean","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"When "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"true"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", withdrawals are not offered in the session (deposit-only session). Don't set both "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"disallowDeposit"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"disallowWithdrawal"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"true"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"example":false},"merchantTransactionId":{"type":"string","description":"Merchant's external transaction reference."}}}},"components/schemas/CreateCashierSessionResponse":{"id":"components/schemas/CreateCashierSessionResponse","kind":"json-schema","title":"CreateCashierSessionResponse","data":{"required":["sessionId"],"type":"object","properties":{"sessionId":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Cashier session ID. Pass this to the Web SDK "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"open({ sessionId, token })"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"25aee2fd-fd2a-4a1c-a127-df26206b2a30"},"token":{"type":"string","format":"jwt","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"JWT that authorizes opening this Cashier session and nothing else. Required: pass it with "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"sessionId"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"open()"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" in the Web SDK (or as the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"omCashierToken"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" query parameter — "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"ct"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is an accepted alias — on hosted URLs). Valid for the session's lifetime — 15 minutes from creation. It authorizes only this one session. Treat it as a credential: never log or store it. You don't need to decode or validate it."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"eyJhbGciOiJSUzI1NiIsImtpZCI6Imtf..."},"checkoutUrl":{"type":"string","format":"url","description":"Hosted cashier URL (both deposit and withdrawal).","example":"https://checkout.omno.com/payments/cashier/25aee2fd-fd2a-4a1c-a127-df26206b2a30"},"depositUrl":{"type":"string","format":"url","description":"Hosted cashier URL that lands directly on deposit.","example":"https://checkout.omno.com/payments/cashier/25aee2fd-fd2a-4a1c-a127-df26206b2a30/deposit"},"withdrawalUrl":{"type":"string","format":"url","description":"Hosted cashier URL that lands directly on withdrawal.","example":"https://checkout.omno.com/payments/cashier/25aee2fd-fd2a-4a1c-a127-df26206b2a30/withdraw"}}}},"components/schemas/ErrorResponse":{"id":"components/schemas/ErrorResponse","kind":"json-schema","title":"ErrorResponse","data":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Standard error envelope. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"VALIDATION_ERROR"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" (on "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"400"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") is the confirmed key. The full "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"errorKey"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" catalogue and error mapping are provided and handled by the Omno integration team during integration."},"children":[],"type":"text"}],"type":"paragraph"}],"properties":{"errorKey":{"type":"string","description":"Machine-readable error identifier.","example":"VALIDATION_ERROR"},"errorMessage":{"type":"string","description":"Human-readable error description.","example":"currency must not be null"},"errorCode":{"type":"integer","format":"int32","description":"HTTP status code associated with the error.","example":400}}}},"components/schemas/CustomerResponse":{"id":"components/schemas/CustomerResponse","kind":"json-schema","title":"CustomerResponse","data":{"required":["dateOfBirth","email","externalUserId","firstName","id","lastName","merchantId","phoneNumber"],"type":"object","properties":{"id":{"type":"string","description":"Omno customer ID.","example":"123456789"},"firstName":{"type":"string","description":"Customer first name.","example":"John"},"lastName":{"type":"string","description":"Customer last name.","example":"Doe"},"externalUserId":{"type":"string","description":"Merchant-specified customer external user ID.","example":"3183818381183"},"merchantId":{"type":"string","description":"Merchant ID associated with the customer.","example":"123456789"},"email":{"type":"string","description":"Customer email.","example":"john.doe@example.com"},"phoneNumber":{"type":"string","description":"Customer phone number.","example":"1 1234567890"},"dateOfBirth":{"type":"string","description":"Customer date of birth (YYYY-MM-DD).","example":"1990-12-01"}}}},"components/schemas/ReturnUrls":{"id":"components/schemas/ReturnUrls","kind":"json-schema","title":"ReturnUrls","data":{"required":["failure","success"],"type":"object","properties":{"success":{"type":"string","description":"URL the customer is redirected to after a successful transaction.","example":"https://merchant.example.com/success"},"failure":{"type":"string","description":"URL the customer is redirected to after a failed transaction.","example":"https://merchant.example.com/failure"}},"description":"Return URLs after the transaction is finished. A redirect does not confirm the final status; use webhooks or the GET transaction endpoint."}},"components/schemas/PayInStatusWithReason":{"id":"components/schemas/PayInStatusWithReason","kind":"json-schema","title":"PayInStatusWithReason","data":{"type":"object","description":"PayIn transaction status with a detailed reason.","properties":{"reason":{"type":"string","description":"Human-readable reason for the current status."},"detailedStatus":{"type":"string","description":"Detailed status code. See the Transaction Lifecycle guide for meanings.","enum":["GENERAL_DECLINE","BANK_ISSUES","PSP_ISSUES","CUSTOMER_ISSUES","CVV_INVALID","CARD_EXPIRED","CARD_BLOCKED","CARD_NOT_SUPPORTED","NO_PROVIDER_AVAILABLE","OTHER","PROVIDER_NOT_SUITABLE","PROVIDER_NOT_IN_ROUTE","FRAUD_SCORE_ABOVE_THRESHOLD","BLACKLISTED","BLOCKED_CARD","BLOCKED_CUSTOMER","INVALID_CREDENTIALS","AUTHENTICATION_FAILED","ACCESS_DENIED","CARD_DECLINED","TRANSACTION_NOT_ALLOWED","VALIDATION_ERROR","INVALID_CARD_NUMBER","INVALID_EXPIRY_DATE","CVV_MISMATCH","SYSTEM_ERROR","DUPLICATE_TRANSACTION","MARKED_AS_FRAUD","PSP_UNREACHABLE","INVALID_REQUEST_FORMAT","OTHER_FAILURES","UNMAPPED_ERRORS","INSUFFICIENT_FUNDS","THREE_DS_NOT_SUPPORTED","TRANSACTION_TIMEOUT","REFUND_ERROR","REFUND_ALREADY_PROCESSED","PARTIAL_REFUND_NOT_ALLOWED"]},"status":{"type":"string","enum":["CREATED","PENDING","PENDING_3DS","SUCCESS","REFUNDED","PARTIALLY_REFUNDED","DECLINED","FAILED","TIMEOUT","REFUND_FAILED","REFUND_PENDING"]}}}},"components/schemas/IpInfo":{"id":"components/schemas/IpInfo","kind":"json-schema","title":"IpInfo","data":{"type":"object","description":"IP geolocation and network information for the transaction.","properties":{"country":{"type":"string"},"asn":{"type":"string"},"vpn":{"type":"boolean"},"proxy":{"type":"boolean"},"anonymousIp":{"type":"boolean"}}}},"components/schemas/ProxyDetectionResponse":{"id":"components/schemas/ProxyDetectionResponse","kind":"json-schema","title":"ProxyDetectionResponse","data":{"type":"object","description":"Proxy, VPN and Tor detection signals for the transaction.","properties":{"proxy":{"type":"boolean"},"host":{"type":"string"},"ISP":{"type":"string"},"Organization":{"type":"string"},"ASN":{"type":"integer","format":"int32"},"country_code":{"type":"string"},"city":{"type":"string"},"region":{"type":"string"},"timezone":{"type":"string"},"latitude":{"type":"number","format":"float"},"longitude":{"type":"number","format":"float"},"zip_code":{"type":"string"},"is_crawler":{"type":"boolean"},"connection_type":{"type":"string"},"recent_abuse":{"type":"boolean"},"abuse_velocity":{"type":"string"},"bot_status":{"type":"boolean"},"vpn":{"type":"boolean"},"tor":{"type":"boolean"},"active_vpn":{"type":"boolean"},"active_tor":{"type":"boolean"},"mobile":{"type":"boolean"},"fraud_score":{"type":"number","format":"float"},"frequent_abuser":{"type":"boolean"},"high_risk_attacks":{"type":"boolean"},"shared_connection":{"type":"boolean"},"dynamic_connection":{"type":"boolean"},"security_scanner":{"type":"boolean"},"trusted_network":{"type":"boolean"},"request_id":{"type":"string"},"operating_system":{"type":"string"},"browser":{"type":"string"},"device_brand":{"type":"string"},"device_model":{"type":"string"},"success":{"type":"boolean"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"string"}}}}},"components/schemas/FirstSeen":{"id":"components/schemas/FirstSeen","kind":"json-schema","title":"FirstSeen","data":{"type":"object","properties":{"human":{"type":"string"},"timestamp":{"type":"integer","format":"int64"},"iso":{"type":"string"}}}},"components/schemas/DomainAge":{"id":"components/schemas/DomainAge","kind":"json-schema","title":"DomainAge","data":{"type":"object","properties":{"human":{"type":"string"},"timestamp":{"type":"integer","format":"int64"},"iso":{"type":"string"}}}},"components/schemas/EmailValidationResponse":{"id":"components/schemas/EmailValidationResponse","kind":"json-schema","title":"EmailValidationResponse","data":{"type":"object","description":"Email validation and risk signals for the transaction.","properties":{"valid":{"type":"boolean"},"disposable":{"type":"boolean"},"timed_out":{"type":"boolean"},"deliverability":{"type":"string"},"catch_all":{"type":"boolean"},"leaked":{"type":"boolean"},"suspect":{"type":"boolean"},"smtp_score":{"type":"integer","format":"int32"},"overall_score":{"type":"integer","format":"int32"},"first_name":{"type":"string"},"common":{"type":"boolean"},"generic":{"type":"boolean"},"dns_valid":{"type":"boolean"},"honeypot":{"type":"boolean"},"spam_trap_score":{"type":"string"},"recent_abuse":{"type":"boolean"},"fraud_score":{"type":"number","format":"float"},"frequent_complainer":{"type":"boolean"},"suggested_domain":{"type":"string"},"domain_velocity":{"type":"string"},"domain_trust":{"type":"string"},"user_activity":{"type":"string"},"mx_records":{"type":"array","items":{"type":"string"}},"a_records":{"type":"array","items":{"type":"string"}},"risky_tld":{"type":"boolean"},"spf_record":{"type":"boolean"},"dmarc_record":{"type":"boolean"},"first_seen":{"$ref":"#/components/schemas/FirstSeen"},"domain_age":{"$ref":"#/components/schemas/DomainAge"},"sanitized_email":{"type":"string"},"request_id":{"type":"string"},"success":{"type":"boolean"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"string"}}}}},"components/schemas/PhoneValidationResponse":{"id":"components/schemas/PhoneValidationResponse","kind":"json-schema","title":"PhoneValidationResponse","data":{"type":"object","description":"Phone validation and risk signals for the transaction.","properties":{"valid":{"type":"boolean"},"active":{"type":"boolean"},"formatted":{"type":"string"},"local_format":{"type":"string"},"fraud_score":{"type":"integer","format":"int32"},"recent_abuse":{"type":"boolean"},"VOIP":{"type":"boolean"},"prepaid":{"type":"boolean"},"risky":{"type":"boolean"},"name":{"type":"string"},"carrier":{"type":"string"},"line_type":{"type":"string"},"country":{"type":"string"},"region":{"type":"string"},"city":{"type":"string"},"accurate_country_code":{"type":"boolean"},"zip_code":{"type":"string"},"timezone":{"type":"string"},"dialing_code":{"type":"integer","format":"int32"},"do_not_call":{"type":"boolean"},"leaked":{"type":"boolean"},"spammer":{"type":"boolean"},"active_status":{"type":"string"},"user_activity":{"type":"string"},"mcc":{"type":"string"},"mnc":{"type":"string"},"message":{"type":"string"},"success":{"type":"boolean"},"request_id":{"type":"string"},"errors":{"type":"array","items":{"type":"string"}}}}},"components/schemas/TransactionMetadata":{"id":"components/schemas/TransactionMetadata","kind":"json-schema","title":"TransactionMetadata","data":{"type":"object","properties":{"ipAddress":{"type":"string","description":"Customer IP address recorded for the transaction."},"ipInfo":{"$ref":"#/components/schemas/IpInfo"},"deviceType":{"type":"string","description":"Device type inferred for the transaction.","enum":["MOBILE","DESKTOP","TABLET","UNKNOWN"]},"proxyDetection":{"$ref":"#/components/schemas/ProxyDetectionResponse"},"emailValidation":{"$ref":"#/components/schemas/EmailValidationResponse"},"phoneValidation":{"$ref":"#/components/schemas/PhoneValidationResponse"}},"description":"Transaction metadata"}},"components/schemas/PayInTransaction":{"id":"components/schemas/PayInTransaction","kind":"json-schema","title":"PayInTransaction","data":{"required":["amount","createdAt","currency","customerId","id","initialAmount","initialCurrency","merchantId","orderId","returnUrls","status","updatedAt"],"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the pay-in transaction.","example":"944732c4608c441aa91379478b91f76e"},"amount":{"type":"number","description":"Processed pay-in amount.","example":100},"merchantId":{"type":"string","description":"Unique identifier for the merchant.","example":"944732c4608c441aa91379478b91f76e"},"customerId":{"type":"string","description":"Omno customer ID.","example":"944732c4608c441aa91379478b91f76e"},"orderId":{"type":"string","description":"Merchant-specified order identifier.","example":"order-2026-000201"},"currency":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Processed pay-in currency (may differ from "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"initialCurrency"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" after conversion)."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"EUR"},"status":{"type":"string","description":"PayIn transaction status.","example":"SUCCESS","enum":["CREATED","PENDING","PENDING_3DS","SUCCESS","REFUNDED","PARTIALLY_REFUNDED","DECLINED","FAILED","TIMEOUT","REFUND_FAILED","REFUND_PENDING"]},"initialAmount":{"type":"number","description":"Requested pay-in amount.","example":100},"initialCurrency":{"type":"string","description":"Requested pay-in currency.","example":"EUR"},"routerId":{"type":"string","description":"Router the transaction was processed through."},"returnUrls":{"$ref":"#/components/schemas/ReturnUrls"},"cardId":{"type":"string","description":"Unique identifier for the card, if the card was saved.","example":"944732c4608c441aa91379478b91f76e"},"cardMask":{"type":"string","description":"Masked card number, if a card was used.","example":"1234 56** **** 1234"},"cardBrand":{"type":"string","description":"Card brand, if a card was used.","example":"VISA"},"cardHash":{"type":"string","description":"Card hash, if a card was used.","example":"7094c34678b3a4e29bcb5149266d1c811de2b6fc9370be9d5acdd7a334d8852b"},"merchantPspId":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ID of the PSP that processed the transaction. For test transactions this equals the fake PSP ID provided by Omno — never credit or debit real balances for these."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"944732c4-608c-441a-a913-79478b91f76e"},"pspTransactionId":{"type":"string","description":"PSP-side transaction ID.","example":"944732c4-608c-441a-a913-79478b91f76e"},"statusReason":{"$ref":"#/components/schemas/PayInStatusWithReason"},"previousTransactionCount":{"type":"integer","description":"Number of previous transactions the customer made in your system.","format":"int32"},"metadata":{"$ref":"#/components/schemas/TransactionMetadata"},"transactionType":{"type":"string","description":"Transaction type.","example":"CARD","enum":["CARD","BANK","WALLET","CASH","CRYPTO","OTHER"]},"additionalData":{"type":"object","additionalProperties":{"type":"object","description":"User-provided additional data for Alternative Payment Methods."},"description":"User-provided additional data for Alternative Payment Methods."},"pspAdditionalData":{"type":"object","additionalProperties":{"type":"object","description":"Additional data obtained from the PSP during processing."},"description":"Additional data obtained from the PSP during processing."},"createdAt":{"type":"string","description":"Transaction creation time in UTC.","format":"date-time"},"updatedAt":{"type":"string","description":"Transaction last update time in UTC.","format":"date-time"}}}},"components/schemas/PayoutStatusWithReason":{"id":"components/schemas/PayoutStatusWithReason","kind":"json-schema","title":"PayoutStatusWithReason","data":{"type":"object","description":"Payout transaction status with a detailed reason.","properties":{"reason":{"type":"string","description":"Human-readable reason for the current status."},"detailedStatus":{"type":"string","description":"Detailed status code. See the Transaction Lifecycle guide for meanings.","enum":["NO_PROVIDER_AVAILABLE","AMOUNT_TOO_LOW","AMOUNT_TOO_HIGH","OTHER","PROVIDER_NOT_SUITABLE","PROVIDER_NOT_IN_ROUTE","FRAUD_SCORE_ABOVE_THRESHOLD","BLACKLISTED","BLOCKED_CARD","BLOCKED_CUSTOMER","REJECTED_BY_MERCHANT","PSP_CHANGED_AFTER_APPROVAL","INVALID_CREDENTIALS","AUTHENTICATION_FAILED","ACCESS_DENIED","CARD_DECLINED","TRANSACTION_NOT_ALLOWED","VALIDATION_ERROR","INVALID_CARD_NUMBER","INVALID_EXPIRY_DATE","CVV_MISMATCH","SYSTEM_ERROR","DUPLICATE_TRANSACTION","MARKED_AS_FRAUD","PSP_UNREACHABLE","INVALID_REQUEST_FORMAT","OTHER_FAILURES","UNMAPPED_ERRORS","INSUFFICIENT_FUNDS","TRANSACTION_REJECTED_BY_PROVIDER"]},"status":{"type":"string","enum":["CREATED","WAITING_FOR_CONFIRMATION","PENDING","PROCESSED","REJECTED","FAILED","TIMEOUT"]}}}},"components/schemas/Browser":{"id":"components/schemas/Browser","kind":"json-schema","title":"Browser","data":{"type":"object","description":"Customer browser information, collected client-side and required for Direct Link processing (used for 3DS and fraud checks).","properties":{"acceptHeader":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Value of the browser "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Accept"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" header."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"text/html,application/xhtml+xml"},"userAgent":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Browser user-agent string ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"navigator.userAgent"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"Mozilla/5.0 (Windows NT 10.0; Win64; x64)"},"language":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Browser language ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"navigator.language"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"en-US"},"timeZoneOffset":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Time-zone offset in minutes ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Date.getTimezoneOffset()"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"example":-60},"timeZone":{"type":"string","description":"IANA time-zone name.","example":"Europe/Berlin"},"colorDepth":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Screen color depth in bits ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"screen.colorDepth"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"example":24},"screenHeight":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Screen height in pixels ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"screen.height"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"example":1080},"screenWidth":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Screen width in pixels ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"screen.width"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"example":1920},"windowHeight":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Browser window inner height in pixels ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"window.innerHeight"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"example":969},"windowWidth":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Browser window inner width in pixels ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"window.innerWidth"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"example":1920},"javaEnabled":{"type":"boolean","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Whether Java is enabled ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"navigator.javaEnabled()"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"example":false},"javascriptEnabled":{"type":"boolean","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Whether JavaScript is enabled. Always "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"true"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" when collected in-browser."},"children":[],"type":"text"}],"type":"paragraph"}],"example":true},"customerIp":{"type":"string","description":"Customer IP address.","example":"203.0.113.10"}}}},"components/schemas/PayoutTransaction":{"id":"components/schemas/PayoutTransaction","kind":"json-schema","title":"PayoutTransaction","data":{"required":["amount","createdAt","currency","customerId","id","initialAmount","initialCurrency","merchantId","orderId","status","updatedAt"],"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the payout transaction.","example":"944732c4608c441aa91379478b91f76e"},"amount":{"type":"number","description":"Processed payout amount.","example":100},"merchantId":{"type":"string","description":"Unique identifier for the merchant.","example":"944732c4608c441aa91379478b91f76e"},"customerId":{"type":"string","description":"Omno customer ID.","example":"944732c4608c441aa91379478b91f76e"},"orderId":{"type":"string","description":"Merchant-specified order identifier.","example":"order-2026-000123"},"currency":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Processed payout currency (may differ from "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"initialCurrency"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" after conversion)."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"EUR"},"status":{"type":"string","description":"Payout transaction status.","example":"PROCESSED","enum":["CREATED","WAITING_FOR_CONFIRMATION","PENDING","PROCESSED","REJECTED","FAILED","TIMEOUT"]},"initialAmount":{"type":"number","description":"Requested payout amount.","example":100},"initialCurrency":{"type":"string","description":"Requested payout currency.","example":"EUR"},"routerId":{"type":"string","description":"Router the transaction was processed through."},"cardId":{"type":"string","description":"Unique identifier for the card, if a saved card was used."},"cardMask":{"type":"string","description":"Masked card number, if a card was used.","example":"1234 56** **** 1234"},"cardBrand":{"type":"string","description":"Card brand, if a card was used.","example":"VISA"},"cardHash":{"type":"string","description":"Card hash, if a card was used."},"predictedPspId":{"type":"string","description":"PSP predicted by routing before processing."},"processorPspId":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ID of the PSP that processed the transaction. For test transactions this equals the fake PSP ID provided by Omno — never credit or debit real balances for these."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"944732c4608c441aa91379478b91f76e"},"pspTransactionId":{"type":"string","description":"PSP-side transaction ID."},"previousTransactionCount":{"type":"integer","format":"int32","description":"Number of previous transactions the customer made in your system."},"statusReason":{"$ref":"#/components/schemas/PayoutStatusWithReason"},"metadata":{"$ref":"#/components/schemas/TransactionMetadata"},"transactionType":{"type":"string","description":"Transaction type.","example":"BANK","enum":["CARD","BANK","WALLET","CASH","CRYPTO","OTHER"]},"browser":{"$ref":"#/components/schemas/Browser"},"additionalData":{"type":"object","description":"Method-specific data provided when processing the payout.","additionalProperties":{"type":"object"}},"pspAdditionalData":{"type":"object","description":"Additional data returned by the PSP during processing.","additionalProperties":{"type":"object"}},"createdAt":{"type":"string","format":"date-time","description":"Transaction creation time in UTC."},"updatedAt":{"type":"string","format":"date-time","description":"Transaction last update time in UTC."}}}},"schema_0":{"kind":"json-schema","data":{"type":"string"},"id":"schema_0"}},"exampleStore":{"paths/~1v3~1public~1payin~1{payinId}/get/responses/200/content/application~1json/examples/success":{"value":{"id":"944732c4608c441aa91379478b91f76e","amount":100,"merchantId":"944732c4608c441aa91379478b91f76e","customerId":"944732c4608c441aa91379478b91f76e","orderId":"order-2026-000201","currency":"EUR","status":"SUCCESS","initialAmount":100,"initialCurrency":"EUR","cardMask":"1234 56** **** 1234","cardBrand":"VISA","merchantPspId":"944732c4-608c-441a-a913-79478b91f76e","pspTransactionId":"944732c4-608c-441a-a913-79478b91f76e","transactionType":"CARD","createdAt":"2026-09-25T10:00:00Z","updatedAt":"2026-09-25T10:00:05Z"},"key":"success","summary":"Successful card pay-in","id":"paths/~1v3~1public~1payin~1{payinId}/get/responses/200/content/application~1json/examples/success"},"paths/~1v3~1public~1payin~1{payinId}/get/responses/200/content/application~1json/examples/declined":{"value":{"id":"944732c4608c441aa91379478b91f76e","amount":100,"merchantId":"944732c4608c441aa91379478b91f76e","customerId":"944732c4608c441aa91379478b91f76e","orderId":"order-2026-000202","currency":"EUR","status":"DECLINED","initialAmount":100,"initialCurrency":"EUR","cardMask":"1234 56** **** 1234","cardBrand":"VISA","merchantPspId":"944732c4-608c-441a-a913-79478b91f76e","pspTransactionId":"944732c4-608c-441a-a913-79478b91f76e","transactionType":"CARD","statusReason":{"reason":"Insufficient funds","detailedStatus":"INSUFFICIENT_FUNDS","status":"DECLINED"},"createdAt":"2026-09-25T10:00:00Z","updatedAt":"2026-09-25T10:00:04Z"},"key":"declined","summary":"Declined card pay-in","id":"paths/~1v3~1public~1payin~1{payinId}/get/responses/200/content/application~1json/examples/declined"},"paths/~1v3~1public~1payout~1{payoutId}/get/responses/200/content/application~1json/examples/processed":{"value":{"id":"944732c4608c441aa91379478b91f76e","amount":100,"merchantId":"944732c4608c441aa91379478b91f76e","customerId":"944732c4608c441aa91379478b91f76e","orderId":"order-2026-000123","currency":"EUR","status":"PROCESSED","initialAmount":100,"initialCurrency":"EUR","processorPspId":"944732c4608c441aa91379478b91f76e","pspTransactionId":"944732c4-608c-441a-a913-79478b91f76e","transactionType":"BANK","createdAt":"2026-09-25T10:00:00Z","updatedAt":"2026-09-25T10:00:08Z"},"key":"processed","summary":"Processed payout","id":"paths/~1v3~1public~1payout~1{payoutId}/get/responses/200/content/application~1json/examples/processed"}},"securitySchemeStore":{"bearerAuth":{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}},"specVersion":"3.0.1","servers":[{"url":"https://api.omno.com","description":"Production"}],"specType":"openapi"},"options":{"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/cashier-api/openapi.json?download"},{"url":"/_bundle/apis/cashier-api/openapi.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false,"asyncapi":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Omno Cashier API","description":"Cashier API operations, on `/v3/public/...`. Single source of truth; the canonical reference for every operation is under Other APIs."}},"baseSlug":"/apis/cashier-api/openapi","routesMapping":{}}