{"openapi":"3.1.0","info":{"title":"MyFatoorah (BYOK) API","version":"0.1.0","description":"MyFatoorah (BYOK) lets an AI assistant read your own MyFatoorah data through the MyFatoorah API with a key you supply (MyFatoorah API token key (live key of the Kuwait/Bahrain/Jordan/Oman portal)). Read-only: 7 tools (get_payment_details, get_refund_details, list_payment_methods, list_recurring_payments, get_supplier_dashboard, list_supplier_deposits, list_countries). The BYOK key travels with...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-myfatoorah.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-myfatoorah/docs"},"termsOfService":"https://connectorbay.com/byok-myfatoorah/terms"},"servers":[{"url":"https://byok-myfatoorah.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-myfatoorah/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_payment_details":{"post":{"operationId":"get_payment_details","summary":"Get one payment by its payment id: invoice status and reference, transaction status, method and date, and the amounts in","description":"Get one payment by its payment id: invoice status and reference, transaction status, method and date, and the amounts including service charge and receivable amount. Customer and card details are not returned. Use for \"What is the status of MyFatoorah payment 07071234567890123456\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"payment_id":{"description":"MyFatoorah payment id.","maxLength":200,"title":"Payment Id","type":"string"}},"required":["payment_id"],"title":"get_payment_detailsArguments","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_refund_details":{"post":{"operationId":"get_refund_details","summary":"Get one refund by id: status, reference, dates, comments, refunded amount and the invoice it refers to. Use for \"Has MyF","description":"Get one refund by id: status, reference, dates, comments, refunded amount and the invoice it refers to. Use for \"Has MyFatoorah refund 12345 been completed\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"refund_id":{"description":"MyFatoorah refund id.","maxLength":200,"title":"Refund Id","type":"string"}},"required":["refund_id"],"title":"get_refund_detailsArguments","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_payment_methods":{"post":{"operationId":"list_payment_methods","summary":"List the payment methods enabled on your MyFatoorah portal with their commission, direct-payment and embedded-payment su","description":"List the payment methods enabled on your MyFatoorah portal with their commission, direct-payment and embedded-payment support and currency. Use for \"Which payment methods are enabled on my MyFatoorah account and what commission do they carry\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_payment_methodsArguments","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_recurring_payments":{"post":{"operationId":"list_recurring_payments","summary":"List all recurring payments with status, creation date, value, type, interval, times executed and next payment date. Use","description":"List all recurring payments with status, creation date, value, type, interval, times executed and next payment date. Use for \"Which MyFatoorah recurring payments are active and when is the next charge\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_recurring_paymentsArguments","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_supplier_dashboard":{"post":{"operationId":"get_supplier_dashboard","summary":"Get a vendor (supplier) dashboard for multi-vendor accounts: transaction count and value, balance, amount awaiting trans","description":"Get a vendor (supplier) dashboard for multi-vendor accounts: transaction count and value, balance, amount awaiting transfer, deposited amount and approval state. Use for \"What is the balance of MyFatoorah supplier 1\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"supplier_code":{"description":"Supplier code as a number.","minimum":1,"title":"Supplier Code","type":"integer"}},"required":["supplier_code"],"title":"get_supplier_dashboardArguments","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_supplier_deposits":{"post":{"operationId":"list_supplier_deposits","summary":"List deposit records of one supplier, paged with start and length. Use for \"What deposits has MyFatoorah supplier 1 rece","description":"List deposit records of one supplier, paged with start and length. Use for \"What deposits has MyFatoorah supplier 1 received\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"supplier_code":{"description":"Supplier code as a number.","minimum":1,"title":"Supplier Code","type":"integer"},"search":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Optional search text.","title":"Search"},"start":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Index of the first record, for paging.","title":"Start"},"length":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Number of records to return.","title":"Length"},"sort_column":{"anyOf":[{"maxLength":50,"type":"string"},{"type":"null"}],"default":null,"description":"Optional column to sort by.","title":"Sort Column"},"sort_direction":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort direction: asc or desc.","title":"Sort Direction"}},"required":["supplier_code"],"title":"list_supplier_depositsArguments","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_countries":{"post":{"operationId":"list_countries","summary":"List the countries MyFatoorah supports for shipping with their codes. Use for \"Which country codes does MyFatoorah suppo","description":"List the countries MyFatoorah supports for shipping with their codes. Use for \"Which country codes does MyFatoorah support\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_countriesArguments","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}}}}