{"openapi":"3.1.0","info":{"title":"Omise (BYOK) API","version":"0.1.0","description":"Omise (BYOK) lets an AI assistant read your own Omise data through the Omise API with a key you supply (secret key (skey_...)). Read-only: 10 tools (get_balance, list_charges, get_charge, list_refunds, list_transfers, list_disputes, list_customers, list_transactions, list_events, list_schedules). The BYOK key travels with each request, is used for that one call only and is never stored, logged or...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-omise.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-omise/docs"},"termsOfService":"https://connectorbay.com/byok-omise/terms"},"servers":[{"url":"https://byok-omise.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-omise/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/get_balance":{"post":{"operationId":"get_balance","summary":"Show the account balance in the smallest currency unit: total, transferable, on hold and reserve. Use for \"What is my Om","description":"Show the account balance in the smallest currency unit: total, transferable, on hold and reserve. Use for \"What is my Omise balance and how much can I transfer\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_balanceArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_charges":{"post":{"operationId":"list_charges","summary":"List charges with status, amount, fee, net, refunded amount, failure reason, customer id and card brand and last four di","description":"List charges with status, amount, fee, net, refunded amount, failure reason, customer id and card brand and last four digits. Use for \"Which Omise charges failed this week\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many records to return (1 to 100, default 20).","title":"Limit"},"offset":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many records to skip from the beginning (default 0).","title":"Offset"},"order":{"anyOf":[{"enum":["chronological","reverse_chronological"],"type":"string"},{"type":"null"}],"default":null,"description":"Order of the records: chronological (oldest first) or reverse_chronological (newest first).","title":"Order"},"date_from":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only records from this UTC time, ISO 8601 like 2026-01-01T00:00:00Z.","title":"Date From"},"date_to":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only records up to this UTC time, ISO 8601 like 2026-01-31T23:59:59Z.","title":"Date To"}},"title":"list_chargesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_charge":{"post":{"operationId":"get_charge","summary":"Get one charge by id: status, amount, fee, net, refunded amount, failure reason, card brand and last digits. Use for \"Sh","description":"Get one charge by id: status, amount, fee, net, refunded amount, failure reason, card brand and last digits. Use for \"Show Omise charge chrg_test_60kwldy12skb3h42dwr\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"id":{"description":"Omise charge id, for example 'chrg_test_60kwldy12skb3h42dwr'.","maxLength":200,"title":"Id","type":"string"}},"required":["id"],"title":"get_chargeArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_refunds":{"post":{"operationId":"list_refunds","summary":"List refunds with amount, currency, status, the refunded charge and the time. Use for \"Which Omise refunds were made thi","description":"List refunds with amount, currency, status, the refunded charge and the time. Use for \"Which Omise refunds were made this month\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many records to return (1 to 100, default 20).","title":"Limit"},"offset":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many records to skip from the beginning (default 0).","title":"Offset"},"order":{"anyOf":[{"enum":["chronological","reverse_chronological"],"type":"string"},{"type":"null"}],"default":null,"description":"Order of the records: chronological (oldest first) or reverse_chronological (newest first).","title":"Order"},"date_from":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only records from this UTC time, ISO 8601 like 2026-01-01T00:00:00Z.","title":"Date From"},"date_to":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only records up to this UTC time, ISO 8601 like 2026-01-31T23:59:59Z.","title":"Date To"}},"title":"list_refundsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_transfers":{"post":{"operationId":"list_transfers","summary":"List transfers (payouts) with amount, fee, net, currency, paid and sent flags, failure reason and times. Use for \"Which ","description":"List transfers (payouts) with amount, fee, net, currency, paid and sent flags, failure reason and times. Use for \"Which Omise transfers were sent and which are pending\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many records to return (1 to 100, default 20).","title":"Limit"},"offset":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many records to skip from the beginning (default 0).","title":"Offset"},"order":{"anyOf":[{"enum":["chronological","reverse_chronological"],"type":"string"},{"type":"null"}],"default":null,"description":"Order of the records: chronological (oldest first) or reverse_chronological (newest first).","title":"Order"},"date_from":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only records from this UTC time, ISO 8601 like 2026-01-01T00:00:00Z.","title":"Date From"},"date_to":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only records up to this UTC time, ISO 8601 like 2026-01-31T23:59:59Z.","title":"Date To"}},"title":"list_transfersArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_disputes":{"post":{"operationId":"list_disputes","summary":"List disputes (chargebacks) with status, reason, amount, currency, the disputed charge and close time. Use for \"Are ther","description":"List disputes (chargebacks) with status, reason, amount, currency, the disputed charge and close time. Use for \"Are there any open Omise disputes\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many records to return (1 to 100, default 20).","title":"Limit"},"offset":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many records to skip from the beginning (default 0).","title":"Offset"},"order":{"anyOf":[{"enum":["chronological","reverse_chronological"],"type":"string"},{"type":"null"}],"default":null,"description":"Order of the records: chronological (oldest first) or reverse_chronological (newest first).","title":"Order"},"date_from":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only records from this UTC time, ISO 8601 like 2026-01-01T00:00:00Z.","title":"Date From"},"date_to":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only records up to this UTC time, ISO 8601 like 2026-01-31T23:59:59Z.","title":"Date To"}},"title":"list_disputesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_customers":{"post":{"operationId":"list_customers","summary":"List customers with e-mail, description, default card id and creation time. Use for \"List my Omise customers\".","description":"List customers with e-mail, description, default card id and creation time. Use for \"List my Omise customers\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many records to return (1 to 100, default 20).","title":"Limit"},"offset":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many records to skip from the beginning (default 0).","title":"Offset"},"order":{"anyOf":[{"enum":["chronological","reverse_chronological"],"type":"string"},{"type":"null"}],"default":null,"description":"Order of the records: chronological (oldest first) or reverse_chronological (newest first).","title":"Order"},"date_from":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only records from this UTC time, ISO 8601 like 2026-01-01T00:00:00Z.","title":"Date From"},"date_to":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only records up to this UTC time, ISO 8601 like 2026-01-31T23:59:59Z.","title":"Date To"}},"title":"list_customersArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_transactions":{"post":{"operationId":"list_transactions","summary":"List balance transactions (credits and debits) with amount, currency, direction, type and the time they become transfera","description":"List balance transactions (credits and debits) with amount, currency, direction, type and the time they become transferable. Use for \"What Omise balance transactions happened today\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many records to return (1 to 100, default 20).","title":"Limit"},"offset":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many records to skip from the beginning (default 0).","title":"Offset"},"order":{"anyOf":[{"enum":["chronological","reverse_chronological"],"type":"string"},{"type":"null"}],"default":null,"description":"Order of the records: chronological (oldest first) or reverse_chronological (newest first).","title":"Order"},"date_from":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only records from this UTC time, ISO 8601 like 2026-01-01T00:00:00Z.","title":"Date From"},"date_to":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only records up to this UTC time, ISO 8601 like 2026-01-31T23:59:59Z.","title":"Date To"}},"title":"list_transactionsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_events":{"post":{"operationId":"list_events","summary":"List account events (such as charge.complete or refund.create) with event key and time. Use for \"What Omise events were ","description":"List account events (such as charge.complete or refund.create) with event key and time. Use for \"What Omise events were recorded today\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many records to return (1 to 100, default 20).","title":"Limit"},"offset":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many records to skip from the beginning (default 0).","title":"Offset"},"order":{"anyOf":[{"enum":["chronological","reverse_chronological"],"type":"string"},{"type":"null"}],"default":null,"description":"Order of the records: chronological (oldest first) or reverse_chronological (newest first).","title":"Order"},"date_from":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only records from this UTC time, ISO 8601 like 2026-01-01T00:00:00Z.","title":"Date From"},"date_to":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only records up to this UTC time, ISO 8601 like 2026-01-31T23:59:59Z.","title":"Date To"}},"title":"list_eventsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_schedules":{"post":{"operationId":"list_schedules","summary":"List charge and transfer schedules with status, period, interval and next run dates. Use for \"Which Omise schedules are ","description":"List charge and transfer schedules with status, period, interval and next run dates. Use for \"Which Omise schedules are active\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many records to return (1 to 100, default 20).","title":"Limit"},"offset":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many records to skip from the beginning (default 0).","title":"Offset"},"order":{"anyOf":[{"enum":["chronological","reverse_chronological"],"type":"string"},{"type":"null"}],"default":null,"description":"Order of the records: chronological (oldest first) or reverse_chronological (newest first).","title":"Order"},"date_from":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only records from this UTC time, ISO 8601 like 2026-01-01T00:00:00Z.","title":"Date From"},"date_to":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only records up to this UTC time, ISO 8601 like 2026-01-31T23:59:59Z.","title":"Date To"}},"title":"list_schedulesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}