{"items":[{"type":"link","label":"OMNO API Documentation","link":"/apis/payments/openapi","routeSlug":"/apis/payments/openapi","content":{"contentType":"overview","meta":{"name":"OMNO API Documentation"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/apis/payments/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/apis/payments/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"email","title":"E-mail","titleTranslationKey":"info.contact.name","email":"support@omno.com","label":"support@omno.com","withCopyButton":true,"copyContent":"support@omno.com"}]},{"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 API Documentation (2.2.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OMNO is a payment orchestration platform that processes Pay-In and Pay-Out transactions across multiple PSPs through a single API."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OMNO provides a single production environment. Testing is done in production using fake PSPs configured by OMNO; see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.omno.com/guides/getting-started/testing-in-production"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Testing in Production"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" guide."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The final result of any transaction comes from webhooks or the GET transaction endpoints, never from redirects or client-side events."},"children":[]}]}]}]}],"sectionId":"/apis/payments/openapi"}],"sectionId":"/apis/payments/openapi"}]}]}},{"type":"separator","label":"Customers","content":null},{"type":"group","label":"Customers","link":"/apis/payments/openapi/customer","routeSlug":"/apis/payments/openapi/customer","items":[{"label":"Create or update customer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments/openapi/customer/createorupdatecustomer","routeSlug":"/apis/payments/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/~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","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates or updates a customer for the authenticated merchant. Calling again with the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalUserId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" updates the existing customer. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customerGroups"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kyc.kycLevels"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" drive PSP eligibility — see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.omno.com/guides/reference/routing-and-psp-eligibility"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Routing & PSP Eligibility"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sso.omno.com/realms/omno/protocol/openid-connect/token","scopes":{}}}}]}]},{"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/~1public~1customer/post/requestBody","description":"Create customer request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/public/customer","servers":[{"url":"https://api.omno.com","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sso.omno.com/realms/omno/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CustomerRequest"}},"responseCodes":["200","400","401","403","404","409","500"],"pointer":"/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/~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":"/public/customer"}],"content":{"contentType":"group","meta":{"name":"Customer"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Customers","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A customer represents an end user (player) in your system. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalUserId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is your merchant-side unique key: creating a customer again with the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalUserId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the existing record (create-or-update semantics)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When creating a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Cashier-Session"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cashier Session"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you can identify the customer in one of three ways: an inline "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object, an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalCustomerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (your key), or an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"internalCustomerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the OMNO customer ID returned here). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customerGroups"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kyc.kycLevels"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" also drive PSP eligibility — see the Guides topic "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.omno.com/guides/reference/routing-and-psp-eligibility"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Routing & PSP Eligibility"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/public/customer","summary":"Create or update customer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/customer/createorupdatecustomer","deprecated":false}]}]}]}]}},{"type":"separator","label":"Payments","content":null},{"type":"group","label":"Cashier Session","link":"/apis/payments/openapi/cashier-session","routeSlug":"/apis/payments/openapi/cashier-session","items":[{"label":"Create cashier session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments/openapi/cashier-session/createcashiersession","routeSlug":"/apis/payments/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/~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","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a cashier session for a customer and returns the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sessionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the hosted URLs, and a short-lived "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used to open the session. Open the session on your frontend with the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.omno.com/guides/cashier/web-sdk-reference"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Web SDK"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", forwarding both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sessionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; see the Guides topic "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.omno.com/guides/cashier/integrating-the-cashier"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integrating the Cashier"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for how the backend call and the frontend fit together."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ℹ️ Treat "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token"},"children":[]},{"$$mdtype":"Node","type":"text","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":[]}]}]}]},{"$$mdtype":"Node","type":"heading","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","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Selecting payment types"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentTypes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" controls which methods appear in the cashier. Allowed values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CARD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CRYPTO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Provide one value or any combination."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ Only the listed types are shown. To accept card payments you "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"must"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CARD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; a method you omit is not available to the customer."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[\"CARD\"]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (card only), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[\"APM\"]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (APM only), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[\"CARD\",\"CRYPTO\"]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[\"CARD\",\"APM\",\"CRYPTO\"]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[TBD: behavior when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentTypes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is omitted]"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[TBD: confirm exact JSON key casing — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PaymentTypes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" vs "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentTypes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","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","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deposit-only / withdrawal-only"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disallowWithdrawal: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a deposit-only session, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disallowDeposit: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a withdrawal-only session. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"balance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is shown on the withdrawal widget. [TBD: behavior when both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disallowDeposit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disallowWithdrawal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are true]"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"cashier-session/createcashiersession/request/customer-identification","deepLinkHash":"/cashier-session/createcashiersession#cashier-session/createcashiersession/request/customer-identification"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer identification"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identify the customer with exactly one of: an inline "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object, an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalCustomerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"internalCustomerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (OMNO customer ID). [TBD: precedence if more than one is sent]"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[TBD: session lifetime / expiry and whether a session can be reused]"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sso.omno.com/realms/omno/protocol/openid-connect/token","scopes":{}}}}]}]},{"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/~1public~1cashier~1session/post/requestBody","description":"Create Cashier Request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/public/cashier/session","servers":[{"url":"https://api.omno.com","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sso.omno.com/realms/omno/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateCashierSessionRequest"}},"responseCodes":["200","400","401","403","404","409","500"],"pointer":"/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/~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":"/public/cashier/session"}],"content":{"contentType":"group","meta":{"name":"Cashier Session"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cashier Session","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a hosted cashier session for card, APM and crypto. The cashier supports deposit and withdrawal in a single session, with KYC and routing handled inside the flow. This is the authoritative reference for the request and response; see the Guides topic "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.omno.com/guides/cashier/integrating-the-cashier"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integrating the Cashier"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for how the backend call and the frontend Web SDK fit together."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/public/cashier/session","summary":"Create cashier session","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cashier-session/createcashiersession","deprecated":false}]}]}]}]}},{"type":"group","label":"PayIn","link":"/apis/payments/openapi/payin","routeSlug":"/apis/payments/openapi/payin","items":[{"label":"Create payin transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments/openapi/payin/createpayin","routeSlug":"/apis/payments/openapi/payin/createpayin","metadata":{"seo":{"title":"Create payin transaction","description":"Creates a pay-in transaction. Used by the Direct Link flow (via directRouteId) and the Payment Page (Legacy) flow (via returnUrls and the returned iframe URLs). See Direct Link Pay-In: APM and Payment Page (Legacy)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPayIn","name":"Create payin transaction","isWebhook":false,"pointer":"/paths/~1public~1payin/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create payin transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a pay-in transaction. Used by the Direct Link flow (via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"directRouteId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and the Payment Page (Legacy) flow (via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"returnUrls"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the returned iframe URLs). See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.omno.com/guides/direct-link/payin-apm"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Direct Link Pay-In: APM"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.omno.com/guides/payment-page/pay-in-flow"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Page (Legacy)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sso.omno.com/realms/omno/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePayInRequest","exampleIds":["paths/~1public~1payin/post/requestBody/content/application~1json/examples/paymentPageLegacy","paths/~1public~1payin/post/requestBody/content/application~1json/examples/directLink"]}},"schemaId":"components/schemas/CreatePayInRequest","exampleIds":["paths/~1public~1payin/post/requestBody/content/application~1json/examples/paymentPageLegacy","paths/~1public~1payin/post/requestBody/content/application~1json/examples/directLink"],"pointer":"/paths/~1public~1payin/post/requestBody","description":"Create payin transaction request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/public/payin","servers":[{"url":"https://api.omno.com","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sso.omno.com/realms/omno/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreatePayInRequest","exampleIds":["paths/~1public~1payin/post/requestBody/content/application~1json/examples/paymentPageLegacy","paths/~1public~1payin/post/requestBody/content/application~1json/examples/directLink"]}},"responseCodes":["200","400","401","403","404","409","500"],"pointer":"/public/payin","href":"payin/createpayin","openApiOperationId":"createPayIn","summary":"Create payin transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.omno.com","description":"Production"}],"schemaId":"components/schemas/CreatePayInRequest","exampleIds":["paths/~1public~1payin/post/requestBody/content/application~1json/examples/paymentPageLegacy","paths/~1public~1payin/post/requestBody/content/application~1json/examples/directLink"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePayInRequest","exampleIds":["paths/~1public~1payin/post/requestBody/content/application~1json/examples/paymentPageLegacy","paths/~1public~1payin/post/requestBody/content/application~1json/examples/directLink"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Payin transaction created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayInResponse"}},"schemaId":"components/schemas/PayInResponse"},{"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/~1public~1payin/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PayInResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayInResponse"}}},{"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":"/payin/createpayin"}],"panels":[]}]},"httpPath":"/public/payin"},{"label":"Start direct link payin processing","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments/openapi/payin/startdirectlinkpayinprocessing","routeSlug":"/apis/payments/openapi/payin/startdirectlinkpayinprocessing","metadata":{"seo":{"title":"Start direct link payin processing","description":"Starts processing for a Direct Link pay-in created with a directRouteId. Provide the collected browser data and any method-specific additionalData. The response contains a redirectUrl the customer must be sent to. See Direct Link Pay-In: APM."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"startDirectLinkPayinProcessing","name":"Start direct link payin processing","isWebhook":false,"pointer":"/paths/~1public~1payin~1{payinId}~1process~1direct-link/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Start direct link payin processing","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Starts processing for a Direct Link pay-in created with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"directRouteId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Provide the collected "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"browser"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" data and any method-specific "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"additionalData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"redirectUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the customer must be sent to. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.omno.com/guides/direct-link/payin-apm"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Direct Link Pay-In: APM"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sso.omno.com/realms/omno/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payinId","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payin ID. Returned by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createPayIn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"944732c4608c441aa91379478b91f76e"}],"pointer":"/paths/~1public~1payin~1{payinId}~1process~1direct-link/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StartDirectLinkPayinProcessingRequest"}},"schemaId":"components/schemas/StartDirectLinkPayinProcessingRequest","pointer":"/paths/~1public~1payin~1{payinId}~1process~1direct-link/post/requestBody","description":"Start direct link payin processing request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/public/payin/{payinId}/process/direct-link","servers":[{"url":"https://api.omno.com","description":"Production"}],"parameters":{"path":[{"name":"payinId","in":"path","required":true,"example":"944732c4608c441aa91379478b91f76e","schemaId":"schema_5"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sso.omno.com/realms/omno/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/StartDirectLinkPayinProcessingRequest"}},"responseCodes":["200","400","401","403","404","409","500"],"pointer":"/public/payin/{payinId}/process/direct-link","href":"payin/startdirectlinkpayinprocessing","openApiOperationId":"startDirectLinkPayinProcessing","summary":"Start direct link payin processing"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.omno.com","description":"Production"}],"schemaId":"components/schemas/StartDirectLinkPayinProcessingRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StartDirectLinkPayinProcessingRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Payin processing started response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StartApmPayInProcessingResponse"}},"schemaId":"components/schemas/StartApmPayInProcessingResponse"},{"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/~1public~1payin~1{payinId}~1process~1direct-link/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StartApmPayInProcessingResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StartApmPayInProcessingResponse"}}},{"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":"/payin/startdirectlinkpayinprocessing"}],"panels":[]}]},"httpPath":"/public/payin/{payinId}/process/direct-link"}],"content":{"contentType":"group","meta":{"name":"PayIn"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"PayIn","showPageActions":true},{"nodeType":"markdoc","content":"Create and process pay-in transactions. Used by the Direct Link and Payment Page (Legacy) flows."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/public/payin","summary":"Create payin transaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payin/createpayin","deprecated":false},{"title":"/public/payin/{payinId}/process/direct-link","summary":"Start direct link payin processing","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payin/startdirectlinkpayinprocessing","deprecated":false}]}]}]}]}},{"type":"group","label":"Payout","link":"/apis/payments/openapi/payout","routeSlug":"/apis/payments/openapi/payout","items":[{"label":"Create payout transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments/openapi/payout/createpayout","routeSlug":"/apis/payments/openapi/payout/createpayout","metadata":{"seo":{"title":"Create payout transaction","description":"Creates a payout transaction. Used by the Cashier flow (standard routing via routerId or default routing), the Direct Link flow (via directRouteId), and the Payment Page (Legacy) flow (load iframeUrls.card / iframeUrls.apm from the response). If the payout requires manual approval it enters WAITING_FOR_CONFIRMATION — see Confirm / Reject Payout. Guides: Direct Link Pay-Out, Payment Page Pay-Out."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPayout","name":"Create payout transaction","isWebhook":false,"pointer":"/paths/~1public~1payout/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create 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","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a payout transaction. Used by the Cashier flow (standard routing via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"routerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or default routing), the Direct Link flow (via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"directRouteId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and the Payment Page (Legacy) flow (load "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"iframeUrls.card"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"iframeUrls.apm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the response). If the payout requires manual approval it enters "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WAITING_FOR_CONFIRMATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Confirm-Reject-Payout"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Confirm / Reject Payout"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Guides: "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.omno.com/guides/direct-link/payout"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Direct Link Pay-Out"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.omno.com/guides/payment-page/pay-out-flow"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Page Pay-Out"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sso.omno.com/realms/omno/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePayoutRequest","exampleIds":["paths/~1public~1payout/post/requestBody/content/application~1json/examples/standard","paths/~1public~1payout/post/requestBody/content/application~1json/examples/directLink","paths/~1public~1payout/post/requestBody/content/application~1json/examples/paymentPage"]}},"schemaId":"components/schemas/CreatePayoutRequest","exampleIds":["paths/~1public~1payout/post/requestBody/content/application~1json/examples/standard","paths/~1public~1payout/post/requestBody/content/application~1json/examples/directLink","paths/~1public~1payout/post/requestBody/content/application~1json/examples/paymentPage"],"pointer":"/paths/~1public~1payout/post/requestBody","description":"Create Payout Request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/public/payout","servers":[{"url":"https://api.omno.com","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sso.omno.com/realms/omno/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreatePayoutRequest","exampleIds":["paths/~1public~1payout/post/requestBody/content/application~1json/examples/standard","paths/~1public~1payout/post/requestBody/content/application~1json/examples/directLink","paths/~1public~1payout/post/requestBody/content/application~1json/examples/paymentPage"]}},"responseCodes":["200","400","401","403","404","409","500"],"pointer":"/public/payout","href":"payout/createpayout","openApiOperationId":"createPayout","summary":"Create payout transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.omno.com","description":"Production"}],"schemaId":"components/schemas/CreatePayoutRequest","exampleIds":["paths/~1public~1payout/post/requestBody/content/application~1json/examples/standard","paths/~1public~1payout/post/requestBody/content/application~1json/examples/directLink","paths/~1public~1payout/post/requestBody/content/application~1json/examples/paymentPage"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePayoutRequest","exampleIds":["paths/~1public~1payout/post/requestBody/content/application~1json/examples/standard","paths/~1public~1payout/post/requestBody/content/application~1json/examples/directLink","paths/~1public~1payout/post/requestBody/content/application~1json/examples/paymentPage"]}},"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 created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutResponse"}},"schemaId":"components/schemas/PayoutResponse"},{"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/~1public~1payout/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PayoutResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutResponse"}}},{"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":"/payout/createpayout"}],"panels":[]}]},"httpPath":"/public/payout"},{"label":"Start direct link payout processing","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments/openapi/payout/startdirectlinkpayoutprocessing","routeSlug":"/apis/payments/openapi/payout/startdirectlinkpayoutprocessing","metadata":{"seo":{"title":"Start direct link payout processing","description":"Starts processing for a Direct Link payout created with a directRouteId. Provide the collected browser data and any method-specific additionalData. See Direct Link Pay-Out."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"startDirectLinkPayoutProcessing","name":"Start direct link payout processing","isWebhook":false,"pointer":"/paths/~1public~1payout~1{payoutId}~1process~1direct-link/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Start direct link payout processing","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Starts processing for a Direct Link payout created with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"directRouteId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Provide the collected "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"browser"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" data and any method-specific "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"additionalData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.omno.com/guides/direct-link/payout"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Direct Link Pay-Out"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sso.omno.com/realms/omno/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payoutId","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payout ID. Returned by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createPayout"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"944732c4608c441aa91379478b91f76e"}],"pointer":"/paths/~1public~1payout~1{payoutId}~1process~1direct-link/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StartDirectLinkPayoutProcessingRequest"}},"schemaId":"components/schemas/StartDirectLinkPayoutProcessingRequest","pointer":"/paths/~1public~1payout~1{payoutId}~1process~1direct-link/post/requestBody","description":"Start direct link payout processing request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/public/payout/{payoutId}/process/direct-link","servers":[{"url":"https://api.omno.com","description":"Production"}],"parameters":{"path":[{"name":"payoutId","in":"path","required":true,"example":"944732c4608c441aa91379478b91f76e","schemaId":"schema_5"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sso.omno.com/realms/omno/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/StartDirectLinkPayoutProcessingRequest"}},"responseCodes":["200","400","401","403","404","409","500"],"pointer":"/public/payout/{payoutId}/process/direct-link","href":"payout/startdirectlinkpayoutprocessing","openApiOperationId":"startDirectLinkPayoutProcessing","summary":"Start direct link payout processing"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.omno.com","description":"Production"}],"schemaId":"components/schemas/StartDirectLinkPayoutProcessingRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StartDirectLinkPayoutProcessingRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Payout processing started response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutProcessingResponse"}},"schemaId":"components/schemas/PayoutProcessingResponse"},{"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/~1public~1payout~1{payoutId}~1process~1direct-link/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PayoutProcessingResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutProcessingResponse"}}},{"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":"/payout/startdirectlinkpayoutprocessing"}],"panels":[]}]},"httpPath":"/public/payout/{payoutId}/process/direct-link"}],"content":{"contentType":"group","meta":{"name":"Payout"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payout","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create and process pay-out transactions. Used by the Cashier, Direct Link and Payment Page (Legacy) flows. Manual-approval handling lives under "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Confirm-Reject-Payout"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Confirm / Reject Payout"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/public/payout","summary":"Create payout transaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payout/createpayout","deprecated":false},{"title":"/public/payout/{payoutId}/process/direct-link","summary":"Start direct link payout processing","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payout/startdirectlinkpayoutprocessing","deprecated":false}]}]}]}]}},{"type":"group","label":"Confirm / Reject Payout","link":"/apis/payments/openapi/confirm-reject-payout","routeSlug":"/apis/payments/openapi/confirm-reject-payout","items":[{"label":"Reject payout transaction","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments/openapi/confirm-reject-payout/rejectpayout","routeSlug":"/apis/payments/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/~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","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rejects a payout that is in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WAITING_FOR_CONFIRMATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". After rejection the transaction is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sent to a PSP and its status becomes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REJECTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Used when a payout requires manual approval, across Cashier, Direct Link and Payment Page flows."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sso.omno.com/realms/omno/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payoutId","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payout ID. Returned by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createPayout"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"944732c4608c441aa91379478b91f76e"}],"pointer":"/paths/~1public~1payout~1{payoutId}~1reject/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/public/payout/{payoutId}/reject","servers":[{"url":"https://api.omno.com","description":"Production"}],"parameters":{"path":[{"name":"payoutId","in":"path","required":true,"example":"944732c4608c441aa91379478b91f76e","schemaId":"schema_5"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sso.omno.com/realms/omno/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["204","400","401","403","404","409","500"],"pointer":"/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","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payout transaction rejected. Status becomes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REJECTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"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","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conflict. The payout is not in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WAITING_FOR_CONFIRMATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and cannot be rejected."},"children":[]}]}]}],"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/~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":"/public/payout/{payoutId}/reject"},{"label":"Confirm payout transaction","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments/openapi/confirm-reject-payout/confirmpayout","routeSlug":"/apis/payments/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/~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","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Confirms a payout that is in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WAITING_FOR_CONFIRMATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". After confirmation the transaction starts processing and its status becomes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Used when a payout requires manual approval, across Cashier, Direct Link and Payment Page flows."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sso.omno.com/realms/omno/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payoutId","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payout ID. Returned by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createPayout"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"944732c4608c441aa91379478b91f76e"}],"pointer":"/paths/~1public~1payout~1{payoutId}~1confirm/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/public/payout/{payoutId}/confirm","servers":[{"url":"https://api.omno.com","description":"Production"}],"parameters":{"path":[{"name":"payoutId","in":"path","required":true,"example":"944732c4608c441aa91379478b91f76e","schemaId":"schema_5"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sso.omno.com/realms/omno/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["204","400","401","403","404","409","500"],"pointer":"/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","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payout transaction confirmed. Status becomes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"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","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conflict. The payout is not in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WAITING_FOR_CONFIRMATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and cannot be confirmed."},"children":[]}]}]}],"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/~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":"/public/payout/{payoutId}/confirm"}],"content":{"contentType":"group","meta":{"name":"Confirm / Reject Payout"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Confirm / Reject Payout","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a payout requires manual approval it enters "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WAITING_FOR_CONFIRMATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; confirm it to start processing ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or reject it so it is never sent to a PSP ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REJECTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). This applies to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flows that create payouts — Cashier, Direct Link and Payment Page — not Cashier only."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status flow:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With manual approval:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CREATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WAITING_FOR_CONFIRMATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → confirm → "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or → reject → "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REJECTED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Without manual approval:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CREATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" directly"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[TBD: what configuration triggers manual approval / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WAITING_FOR_CONFIRMATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/public/payout/{payoutId}/reject","summary":"Reject payout transaction","prefix":{"name":"put","color":"put"},"badges":[],"link":"/confirm-reject-payout/rejectpayout","deprecated":false},{"title":"/public/payout/{payoutId}/confirm","summary":"Confirm payout transaction","prefix":{"name":"put","color":"put"},"badges":[],"link":"/confirm-reject-payout/confirmpayout","deprecated":false}]}]}]}]}},{"type":"group","label":"Get Transaction Info","link":"/apis/payments/openapi/get-transaction-info","routeSlug":"/apis/payments/openapi/get-transaction-info","items":[{"label":"Fetch payout transaction","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments/openapi/get-transaction-info/fetchpayouttransaction","routeSlug":"/apis/payments/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/~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":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sso.omno.com/realms/omno/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payoutId","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payout ID. Returned by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createPayout"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"944732c4608c441aa91379478b91f76e"}],"pointer":"/paths/~1public~1payout~1{payoutId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/payout/{payoutId}","servers":[{"url":"https://api.omno.com","description":"Production"}],"parameters":{"path":[{"name":"payoutId","in":"path","required":true,"example":"944732c4608c441aa91379478b91f76e","schemaId":"schema_5"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sso.omno.com/realms/omno/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","500"],"pointer":"/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/~1public~1payout~1{payoutId}/get/responses/200/content/application~1json/examples/processed"]}},"schemaId":"components/schemas/PayoutTransaction","exampleIds":["paths/~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/~1public~1payout~1{payoutId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PayoutTransaction","exampleIds":["paths/~1public~1payout~1{payoutId}/get/responses/200/content/application~1json/examples/processed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutTransaction","exampleIds":["paths/~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":"/public/payout/{payoutId}"},{"label":"Fetch payin transaction","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments/openapi/get-transaction-info/fetchpayintransaction","routeSlug":"/apis/payments/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/~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":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sso.omno.com/realms/omno/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payinId","in":"path","schemaId":"schema_5","description":"Payment transaction ID","required":true,"example":"944732c4608c441aa91379478b91f76e"}],"pointer":"/paths/~1public~1payin~1{payinId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/payin/{payinId}","servers":[{"url":"https://api.omno.com","description":"Production"}],"parameters":{"path":[{"name":"payinId","in":"path","required":true,"example":"944732c4608c441aa91379478b91f76e","schemaId":"schema_5"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sso.omno.com/realms/omno/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","500"],"pointer":"/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/~1public~1payin~1{payinId}/get/responses/200/content/application~1json/examples/success","paths/~1public~1payin~1{payinId}/get/responses/200/content/application~1json/examples/declined"]}},"schemaId":"components/schemas/PayInTransaction","exampleIds":["paths/~1public~1payin~1{payinId}/get/responses/200/content/application~1json/examples/success","paths/~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/~1public~1payin~1{payinId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PayInTransaction","exampleIds":["paths/~1public~1payin~1{payinId}/get/responses/200/content/application~1json/examples/success","paths/~1public~1payin~1{payinId}/get/responses/200/content/application~1json/examples/declined"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayInTransaction","exampleIds":["paths/~1public~1payin~1{payinId}/get/responses/200/content/application~1json/examples/success","paths/~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":"/public/payin/{payinId}"}],"content":{"contentType":"group","meta":{"name":"Get Transaction Info"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Transaction Info","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve the authoritative status of a pay-in or pay-out transaction. Use these endpoints alongside webhooks to confirm final outcomes — never rely on redirects or client-side events. For test transactions, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchantPspId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (pay-in) / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"processorPspId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (pay-out) equals the fake PSP ID provided by OMNO; do not credit or debit real balances for those."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/public/payout/{payoutId}","summary":"Fetch payout transaction","prefix":{"name":"get","color":"get"},"badges":[],"link":"/get-transaction-info/fetchpayouttransaction","deprecated":false},{"title":"/public/payin/{payinId}","summary":"Fetch payin transaction","prefix":{"name":"get","color":"get"},"badges":[],"link":"/get-transaction-info/fetchpayintransaction","deprecated":false}]}]}]}]}},{"type":"separator","label":"PSP","content":null},{"type":"group","label":"PSP","link":"/apis/payments/openapi/psp","routeSlug":"/apis/payments/openapi/psp","items":[{"label":"Fetch merchant enabled PSP","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments/openapi/psp/fetchmerchantenabledpsp","routeSlug":"/apis/payments/openapi/psp/fetchmerchantenabledpsp","metadata":{"seo":{"title":"Fetch merchant enabled PSP","description":"Returns the merchant-enabled PSP configuration for the given ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"fetchMerchantEnabledPsp","name":"Fetch merchant enabled PSP","isWebhook":false,"pointer":"/paths/~1public~1psp~1{merchantEnabledPspId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch merchant enabled PSP","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the merchant-enabled PSP configuration for the given ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sso.omno.com/realms/omno/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"merchantEnabledPspId","in":"path","schemaId":"schema_5","description":"Merchant enabled PSP ID","required":true,"example":"944732c4608c441aa91379478b91f76e"}],"pointer":"/paths/~1public~1psp~1{merchantEnabledPspId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/psp/{merchantEnabledPspId}","servers":[{"url":"https://api.omno.com","description":"Production"}],"parameters":{"path":[{"name":"merchantEnabledPspId","in":"path","required":true,"example":"944732c4608c441aa91379478b91f76e","schemaId":"schema_5"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sso.omno.com/realms/omno/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","500"],"pointer":"/public/psp/{merchantEnabledPspId}","href":"psp/fetchmerchantenabledpsp","openApiOperationId":"fetchMerchantEnabledPsp","summary":"Fetch merchant enabled PSP"},"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":"Merchant enabled PSP details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MerchantEnabledPsp"}},"schemaId":"components/schemas/MerchantEnabledPsp"},{"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/~1public~1psp~1{merchantEnabledPspId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/MerchantEnabledPsp","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MerchantEnabledPsp"}}},{"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":"/psp/fetchmerchantenabledpsp"}],"panels":[]}]},"httpPath":"/public/psp/{merchantEnabledPspId}"}],"content":{"contentType":"group","meta":{"name":"PSP"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"PSP","showPageActions":true},{"nodeType":"markdoc","content":"Retrieve merchant-enabled PSP configuration."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/public/psp/{merchantEnabledPspId}","summary":"Fetch merchant enabled PSP","prefix":{"name":"get","color":"get"},"badges":[],"link":"/psp/fetchmerchantenabledpsp","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/ErrorResponse":{"id":"components/schemas/ErrorResponse","kind":"json-schema","title":"ErrorResponse","data":{"type":"object","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/CreatePayoutRequest":{"id":"components/schemas/CreatePayoutRequest","kind":"json-schema","title":"CreatePayoutRequest","data":{"required":["currency","customer","kycVerified","orderId","value"],"type":"object","properties":{"orderId":{"type":"string","description":"Merchant-defined unique identifier for this payout.","example":"order-2026-000123"},"value":{"type":"number","description":"Payout transaction amount.","example":100},"currency":{"type":"string","description":"Payout transaction currency (ISO 4217). If the processing PSP does not support this currency and conversion is enabled, the amount is converted automatically and the final transaction currency is set accordingly.","example":"EUR"},"kycVerified":{"type":"boolean","description":"Whether this customer is KYC verified in your system. Used to determine the right PSP to process this payout.","example":true},"customer":{"$ref":"#/components/schemas/CustomerRequest"},"routerId":{"type":"string","description":"Specific router ID to process the transaction with.","example":"944732c4608c441aa91379478b91f76e"},"directRouteId":{"type":"string","description":"Direct Link route ID to process the transaction with.","example":"944732c4608c441aa91379478b91f76e"},"merchantAdditionalData":{"type":"object","additionalProperties":{"type":"object","description":"Additional data for the transaction."},"description":"Additional data for the transaction."}}}},"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":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KYC levels associated with the customer. [TBD: allowed values and meaning of each level]."},"children":[]}]}]}],"items":{"type":"string"},"example":["Level1"]},"allowBypass":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether KYC requirements may be bypassed for this customer. [TBD: exact meaning and effect]."},"children":[]}]}]}],"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":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer username. [TBD: usage and constraints]."},"children":[]}]}]}],"example":"John123"},"customerGroups":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer groups the customer belongs to. [TBD: item type and meaning]."},"children":[]}]}]}],"items":{"type":"string"},"example":[]},"billing":{"$ref":"#/components/schemas/CustomerBilling"},"kyc":{"$ref":"#/components/schemas/CustomerKyc"}},"description":"Customer information"}},"components/schemas/IframeUrls":{"id":"components/schemas/IframeUrls","kind":"json-schema","title":"IframeUrls","data":{"required":["apm","card"],"type":"object","properties":{"card":{"type":"string","description":"Card iframe URL.","example":"https://checkout.omno.com/payments/payin/944732c4608c441aa91379478b91f76e/card"},"apm":{"type":"string","description":"Alternative Payment Method iframe URL.","example":"https://checkout.omno.com/payments/payin/944732c4608c441aa91379478b91f76e/apm"}},"description":"Payment iframe URLs (Payment Page / Legacy flow)"}},"components/schemas/PayoutResponse":{"id":"components/schemas/PayoutResponse","kind":"json-schema","title":"PayoutResponse","data":{"required":["iframeUrls","payoutId","status"],"type":"object","properties":{"payoutId":{"type":"string","description":"Payout ID.","example":"944732c4608c441aa91379478b91f76e"},"status":{"type":"string","description":"Payout status.","example":"CREATED","enum":["CREATED","WAITING_FOR_CONFIRMATION","PENDING","PROCESSED","REJECTED","FAILED","TIMEOUT"]},"iframeUrls":{"$ref":"#/components/schemas/IframeUrls"}}}},"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","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value of the browser "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"example":"text/html,application/xhtml+xml"},"userAgent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Browser user-agent string ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.userAgent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"Mozilla/5.0 (Windows NT 10.0; Win64; x64)"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Browser language ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.language"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"en-US"},"timeZoneOffset":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time-zone offset in minutes ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Date.getTimezoneOffset()"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":-60},"timeZone":{"type":"string","description":"IANA time-zone name.","example":"Europe/Berlin"},"colorDepth":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Screen color depth in bits ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"screen.colorDepth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":24},"screenHeight":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Screen height in pixels ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"screen.height"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":1080},"screenWidth":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Screen width in pixels ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"screen.width"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":1920},"windowHeight":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Browser window inner height in pixels ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"window.innerHeight"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":969},"windowWidth":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Browser window inner width in pixels ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"window.innerWidth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":1920},"javaEnabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether Java is enabled ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.javaEnabled()"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":false},"javascriptEnabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether JavaScript is enabled. Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when collected in-browser."},"children":[]}]}]}],"example":true},"customerIp":{"type":"string","description":"Customer IP address.","example":"203.0.113.10"}}}},"components/schemas/StartDirectLinkPayoutProcessingRequest":{"id":"components/schemas/StartDirectLinkPayoutProcessingRequest","kind":"json-schema","title":"StartDirectLinkPayoutProcessingRequest","data":{"required":["additionalData","browser"],"type":"object","properties":{"browser":{"$ref":"#/components/schemas/Browser"},"additionalData":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Method-specific data required to process the payout (for example, the destination wallet or account details). [TBD: required keys per APM / payout method]."},"children":[]}]}]}],"additionalProperties":{"type":"object"}}}}},"components/schemas/PayoutProcessingResponse":{"id":"components/schemas/PayoutProcessingResponse","kind":"json-schema","title":"PayoutProcessingResponse","data":{"required":["payoutId","status"],"type":"object","properties":{"payoutId":{"type":"string","description":"Payout ID.","example":"944732c4608c441aa91379478b91f76e"},"status":{"type":"string","description":"Payout status after processing started.","example":"PENDING","enum":["CREATED","WAITING_FOR_CONFIRMATION","PENDING","PROCESSED","REJECTED","FAILED","TIMEOUT"]},"redirectUrl":{"type":"string","description":"URL the customer must be redirected to, when applicable.","example":"https://psp.example.com/redirect/944732c4608c441aa91379478b91f76e"},"message":{"type":"string","description":"Optional informational message."}}}},"components/schemas/CreatePayInRequest":{"id":"components/schemas/CreatePayInRequest","kind":"json-schema","title":"CreatePayInRequest","data":{"required":["amount","currency","customer","kycVerified","orderId","previousTransactionCount","returnUrls"],"type":"object","properties":{"orderId":{"type":"string","description":"Merchant-defined unique identifier for this pay-in.","example":"order-2026-000201"},"amount":{"type":"number","description":"PayIn transaction amount.","example":100},"currency":{"type":"string","description":"PayIn transaction currency (ISO 4217). If the processing PSP does not support this currency and conversion is enabled, the amount is converted automatically and the final transaction currency is set accordingly.","example":"EUR"},"kycVerified":{"type":"boolean","description":"Whether this customer is KYC verified in your system. Used to determine the right PSP to process this pay-in.","example":true},"customer":{"$ref":"#/components/schemas/CustomerRequest"},"previousTransactionCount":{"type":"integer","description":"Number of previous transactions the customer made in your system.","format":"int32","example":5},"returnUrls":{"$ref":"#/components/schemas/ReturnUrls"},"routerId":{"type":"string","description":"Specific router ID to process the transaction with.","example":"944732c4608c441aa91379478b91f76e"},"directRouteId":{"type":"string","description":"Direct Link route ID to process the transaction with.","example":"944732c4608c441aa91379478b91f76e"},"merchantAdditionalData":{"type":"object","additionalProperties":{"type":"object","description":"Additional data for the transaction."},"description":"Additional data for the transaction."}}}},"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/PayInResponse":{"id":"components/schemas/PayInResponse","kind":"json-schema","title":"PayInResponse","data":{"required":["iframeUrls","paymentId","status"],"type":"object","properties":{"paymentId":{"type":"string","description":"Payment (pay-in) ID.","example":"944732c4608c441aa91379478b91f76e"},"status":{"type":"string","description":"Payment status.","example":"CREATED","enum":["CREATED","PENDING","PENDING_3DS","SUCCESS","REFUNDED","PARTIALLY_REFUNDED","DECLINED","FAILED","TIMEOUT","REFUND_FAILED","REFUND_PENDING"]},"iframeUrls":{"$ref":"#/components/schemas/IframeUrls"}}}},"components/schemas/StartDirectLinkPayinProcessingRequest":{"id":"components/schemas/StartDirectLinkPayinProcessingRequest","kind":"json-schema","title":"StartDirectLinkPayinProcessingRequest","data":{"required":["additionalData","browser"],"type":"object","properties":{"browser":{"$ref":"#/components/schemas/Browser"},"additionalData":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Method-specific data required to process the pay-in (for example, APM-specific fields). [TBD: required keys per APM]."},"children":[]}]}]}],"additionalProperties":{"type":"object"}}}}},"components/schemas/StartApmPayInProcessingResponse":{"id":"components/schemas/StartApmPayInProcessingResponse","kind":"json-schema","title":"StartApmPayInProcessingResponse","data":{"required":["paymentId","status"],"type":"object","properties":{"paymentId":{"type":"string","description":"Payment (pay-in) ID.","example":"944732c4608c441aa91379478b91f76e"},"status":{"type":"string","description":"Payment status after processing started.","example":"PENDING","enum":["CREATED","PENDING","PENDING_3DS","SUCCESS","REFUNDED","PARTIALLY_REFUNDED","DECLINED","FAILED","TIMEOUT","REFUND_FAILED","REFUND_PENDING"]},"redirectUrl":{"type":"string","description":"URL the customer must be redirected to in order to complete payment.","example":"https://psp.example.com/redirect/944732c4608c441aa91379478b91f76e"}}}},"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/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","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Existing merchant-side customer identifier. Optional alternative to an inline "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}]},"internalCustomerId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Existing OMNO customer ID. Optional alternative to an inline "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}]},"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":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deposit amount for the session. [TBD: whether it pre-fills or fixes the deposit amount]."},"children":[]}]}]}],"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},"fee":{"$ref":"#/components/schemas/FixedFee"},"paymentTypes":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","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":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CARD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". [TBD: behavior when omitted]. [TBD: confirm exact JSON key casing — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PaymentTypes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" vs "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentTypes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]."},"children":[]}]}]}],"minItems":1,"items":{"type":"string","enum":["CARD","APM","CRYPTO"]},"example":["CARD","APM","CRYPTO"]},"disallowDeposit":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", deposits are not offered in the session (withdrawal-only session). [TBD: behavior when both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disallowDeposit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disallowWithdrawal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are true]."},"children":[]}]}]}],"example":false},"disallowWithdrawal":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", withdrawals are not offered in the session (deposit-only session). [TBD: behavior when both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disallowDeposit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disallowWithdrawal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are true]."},"children":[]}]}]}],"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","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cashier session ID. Pass this to the Web SDK "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"open({ sessionId, token })"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"25aee2fd-fd2a-4a1c-a127-df26206b2a30"},"token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Short-lived, signed checkout token (JWT) that authorizes opening this session. Forward it from your backend to the Web SDK as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"open({ sessionId, token })"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the SDK attaches it to the cashier URL); if you open the hosted URL directly, append it as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ct"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter. The token is bound to your merchant account and expires with the session (default ~2 hours). Required once checkout token verification is enabled for your account — without it, opening the session is rejected. OMNO verifies the token's signature against its published keys (JWKS); you do not need to validate it yourself."},"children":[]}]}]}],"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/FixedFee":{"id":"components/schemas/FixedFee","kind":"json-schema","title":"FixedFee","data":{"type":"object","description":"Fixed fee applied to the session.","properties":{"amount":{"type":"string","description":"Fee amount.","example":"0.05"},"feeType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the fee is included in, or added on top of, the amount. [TBD: exact meaning of each — whether the fee is deducted from or added to the amount]."},"children":[]}]}]}],"enum":["INCLUDED","NOT_INCLUDED"],"example":"INCLUDED"}}}},"components/schemas/FTDConfiguration":{"id":"components/schemas/FTDConfiguration","kind":"json-schema","title":"FTDConfiguration","data":{"required":["configurationType","initialTransactionSupported"],"type":"object","properties":{"configurationType":{"type":"string","description":"FTD configuration type. Per card or per customer.","example":"LIMIT_PER_CARD","enum":["LIMIT_PER_CARD","LIMIT_PER_CUSTOMER"]},"initialTransactionSupported":{"type":"boolean","description":"Whether an initial transaction is supported.","example":true},"allowAfterTimesOfDeposit":{"type":"integer","description":"Allow deposit only after the specified number of transactions.","format":"int64","example":5}},"description":"Restrictions on first-time deposits"}},"components/schemas/MerchantEnabledPsp":{"id":"components/schemas/MerchantEnabledPsp","kind":"json-schema","title":"MerchantEnabledPsp","data":{"required":["authorized","constraints","feature","ftdConfigurations","id","merchantId","name","paymentServiceProviderId","paymentServiceProviderName","restrictions"],"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the merchant-enabled PSP.","example":"944732c4608c441aa91379478b91f76e"},"merchantId":{"type":"string","description":"Unique identifier for the merchant.","example":"944732c4608c441aa91379478b91f76e"},"name":{"type":"string","description":"Merchant-assigned name for the PSP."},"paymentServiceProviderId":{"type":"string","description":"Unique identifier for the PSP.","example":"944732c4608c441aa91379478b91f76e"},"paymentServiceProviderName":{"type":"string","description":"PSP name."},"feature":{"type":"string","description":"PSP feature. Pay-In or Pay-Out.","example":"PAY_IN","enum":["PAY_IN","PAY_OUT"]},"limits":{"$ref":"#/components/schemas/PspLimits"},"kycRequired":{"type":"boolean","description":"Whether KYC is required for this PSP.","example":true},"defaultCurrency":{"type":"string","description":"Currency used by default if a currency isn't specified in the transaction.","example":"EUR"},"enabledCurrencies":{"uniqueItems":true,"type":"array","description":"Supported currencies.","items":{"type":"string"}},"constraints":{"type":"array","description":"Constraints (countries and card brands) for which this PSP applies.","items":{"$ref":"#/components/schemas/MerchantEnabledPspConstraint"}},"ftdConfigurations":{"type":"array","description":"Restrictions on first-time deposits.","items":{"$ref":"#/components/schemas/FTDConfiguration"}},"restrictions":{"type":"array","description":"Restrictions on the max number of transactions per card or per customer.","items":{"$ref":"#/components/schemas/RestrictionConfiguration"}},"authorized":{"type":"boolean","description":"Whether the PSP is authorized.","example":true},"displayLogo":{"type":"string","description":"PSP display logo URL."}}}},"components/schemas/MerchantEnabledPspConstraint":{"id":"components/schemas/MerchantEnabledPspConstraint","kind":"json-schema","title":"MerchantEnabledPspConstraint","data":{"required":["cardBrand","country"],"type":"object","properties":{"country":{"type":"array","description":"Countries for which the constraint applies.","example":["DE"],"items":{"type":"string"}},"cardBrand":{"type":"array","description":"Card brands for which the constraint applies.","example":["VISA"],"items":{"type":"string"}}},"description":"Constraints. Countries and card brands for which this constraint applies."}},"components/schemas/PspLimitByTypeAndTimeframe":{"id":"components/schemas/PspLimitByTypeAndTimeframe","kind":"json-schema","title":"PspLimitByTypeAndTimeframe","data":{"required":["amount","count","timeframe","type"],"type":"object","properties":{"amount":{"type":"number","description":"Total amount limit for transactions in a timeframe.","example":100},"count":{"type":"integer","description":"Limit for the total number of transactions in a timeframe.","format":"int64","example":100},"type":{"type":"string","description":"Limit type.","example":"TRANSACTION_LIMIT","enum":["CARD_LIMIT","TRANSACTION_LIMIT"]},"timeframe":{"type":"string","description":"Timeframe for which the limit is checked.","example":"MONTH","enum":["DAY","WEEK","MONTH"]}},"description":"Limit for CARD/TRANSACTION for a specified timeframe."}},"components/schemas/PspLimits":{"id":"components/schemas/PspLimits","kind":"json-schema","title":"PspLimits","data":{"required":["baseCurrency","maxAmount","minAmount","pspLimitsByTypeAndTimeframe"],"type":"object","properties":{"baseCurrency":{"type":"string","description":"Currency for the specified limit.","example":"EUR"},"minAmount":{"type":"number","description":"Minimum transaction amount for the specified limit.","example":100},"maxAmount":{"type":"number","description":"Maximum transaction amount for the specified limit.","example":100},"pspLimitsByTypeAndTimeframe":{"type":"array","description":"Limits for CARD/TRANSACTION for a specified timeframe.","items":{"$ref":"#/components/schemas/PspLimitByTypeAndTimeframe"}}},"description":"PSP limits"}},"components/schemas/RestrictionConfiguration":{"id":"components/schemas/RestrictionConfiguration","kind":"json-schema","title":"RestrictionConfiguration","data":{"required":["configurationType","enabled","maxSuccessfulTransactions"],"type":"object","properties":{"configurationType":{"type":"string","description":"Restriction configuration type. Per card or per customer.","example":"LIMIT_PER_CARD","enum":["LIMIT_PER_CARD","LIMIT_PER_CUSTOMER"]},"enabled":{"type":"boolean","description":"Whether the restriction configuration is enabled.","example":true},"maxSuccessfulTransactions":{"type":"integer","description":"Maximum number of successful transactions.","format":"int32","example":10}},"description":"Restrictions on the max number of transactions per card or per customer."}},"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/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/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/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/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","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processed payout currency (may differ from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initialCurrency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" after conversion)."},"children":[]}]}]}],"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","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","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":[]}]}]}],"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."}}}},"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/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/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/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/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","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processed pay-in currency (may differ from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initialCurrency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" after conversion)."},"children":[]}]}]}],"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","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","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":[]}]}]}],"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"}}}},"schema_5":{"kind":"json-schema","data":{"type":"string"},"id":"schema_5"}},"exampleStore":{"paths/~1public~1payin/post/requestBody/content/application~1json/examples/paymentPageLegacy":{"value":{"orderId":"order-2026-000201","amount":100,"currency":"EUR","kycVerified":true,"previousTransactionCount":5,"customer":{"externalUserId":"3183818381183","firstName":"John","lastName":"Doe","email":"john.doe@example.com","phoneNumber":"1 1234567890","dateOfBirth":"1990-12-01","billing":{"address":"123 Main St","city":"Atlanta","state":"GA","countryCode":"US","postalCode":"30308"}},"returnUrls":{"success":"https://merchant.example.com/success","failure":"https://merchant.example.com/failure"}},"key":"paymentPageLegacy","summary":"Payment Page (Legacy)","id":"paths/~1public~1payin/post/requestBody/content/application~1json/examples/paymentPageLegacy"},"paths/~1public~1payin/post/requestBody/content/application~1json/examples/directLink":{"value":{"orderId":"order-2026-000202","amount":100,"currency":"EUR","kycVerified":true,"previousTransactionCount":5,"customer":{"externalUserId":"3183818381183","firstName":"John","lastName":"Doe","email":"john.doe@example.com","phoneNumber":"1 1234567890","dateOfBirth":"1990-12-01","billing":{"address":"123 Main St","city":"Atlanta","state":"GA","countryCode":"US","postalCode":"30308"}},"directRouteId":"944732c4608c441aa91379478b91f76e","returnUrls":{"success":"https://merchant.example.com/success","failure":"https://merchant.example.com/failure"}},"key":"directLink","summary":"Direct Link","id":"paths/~1public~1payin/post/requestBody/content/application~1json/examples/directLink"},"paths/~1public~1payout/post/requestBody/content/application~1json/examples/standard":{"value":{"orderId":"order-2026-000123","value":100,"currency":"EUR","kycVerified":true,"customer":{"externalUserId":"3183818381183","firstName":"John","lastName":"Doe","email":"john.doe@example.com","phoneNumber":"1 1234567890","dateOfBirth":"1990-12-01","billing":{"address":"123 Main St","city":"Atlanta","state":"GA","countryCode":"US","postalCode":"30308"}},"routerId":"944732c4608c441aa91379478b91f76e"},"key":"standard","summary":"Cashier / standard","id":"paths/~1public~1payout/post/requestBody/content/application~1json/examples/standard"},"paths/~1public~1payout/post/requestBody/content/application~1json/examples/directLink":{"value":{"orderId":"order-2026-000124","value":100,"currency":"EUR","kycVerified":true,"customer":{"externalUserId":"3183818381183","firstName":"John","lastName":"Doe","email":"john.doe@example.com","phoneNumber":"1 1234567890","dateOfBirth":"1990-12-01","billing":{"address":"123 Main St","city":"Atlanta","state":"GA","countryCode":"US","postalCode":"30308"}},"directRouteId":"944732c4608c441aa91379478b91f76e"},"key":"directLink","summary":"Direct Link","id":"paths/~1public~1payout/post/requestBody/content/application~1json/examples/directLink"},"paths/~1public~1payout/post/requestBody/content/application~1json/examples/paymentPage":{"value":{"orderId":"order-2026-000125","value":100,"currency":"EUR","kycVerified":true,"customer":{"externalUserId":"3183818381183","firstName":"John","lastName":"Doe","email":"john.doe@example.com","phoneNumber":"1 1234567890","dateOfBirth":"1990-12-01","billing":{"address":"123 Main St","city":"Atlanta","state":"GA","countryCode":"US","postalCode":"30308"}}},"key":"paymentPage","summary":"Payment Page (Legacy)","id":"paths/~1public~1payout/post/requestBody/content/application~1json/examples/paymentPage"},"paths/~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/~1public~1payout~1{payoutId}/get/responses/200/content/application~1json/examples/processed"},"paths/~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/~1public~1payin~1{payinId}/get/responses/200/content/application~1json/examples/success"},"paths/~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/~1public~1payin~1{payinId}/get/responses/200/content/application~1json/examples/declined"}},"securitySchemeStore":{"bearerAuth":{"id":"bearerAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://sso.omno.com/realms/omno/protocol/openid-connect/token","scopes":{}}}}},"servers":[{"url":"https://api.omno.com","description":"Production"}],"specType":"openapi"},"options":{"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/payments/openapi.json?download"},{"url":"/_bundle/apis/payments/openapi.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"OMNO API Documentation","description":"OMNO is a payment orchestration platform that processes Pay-In and Pay-Out transactions across multiple PSPs through a single API.\n\nOMNO provides a single production environment. Testing is done in production using fake PSPs configured by OMNO; see the [Testing in Production](https://docs.omno.com/guides/getting-started/testing-in-production) guide.\n\nThe final result of any transaction comes from webhooks or the GET transaction endpoints, never from redirects or client-side events."}},"baseSlug":"/apis/payments/openapi","routesMapping":{}}