{"openapi":"3.1.0","info":{"title":"Telr (BYOK) API","version":"0.1.0","description":"Telr (BYOK) lets an AI assistant read your own Telr data through the Telr API with a key you supply (store id (the user name of the API login)). Read-only: 6 tools (list_accounts, list_payouts, list_payout_transactions, get_pending_payout, list_pending_transactions, get_order). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-telr.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-telr/docs"},"termsOfService":"https://connectorbay.com/byok-telr/terms"},"servers":[{"url":"https://byok-telr.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-telr/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/list_accounts":{"post":{"operationId":"list_accounts","summary":"List the merchant's Telr accounts with store id, currency, balance, payout interval, next payment date, minimum payout a","description":"List the merchant's Telr accounts with store id, currency, balance, payout interval, next payment date, minimum payout and payout fee. Bank details are not returned. Use for \"What is the balance of my Telr accounts and when is the next payout\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_accountsArguments","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_payouts":{"post":{"operationId":"list_payouts","summary":"List payouts of one account, optionally between two dates, with total amount and the credit and debit breakdown (sales, ","description":"List payouts of one account, optionally between two dates, with total amount and the credit and debit breakdown (sales, refunds, fees, tax). Use for \"What payouts did Telr make to account 12345 in September 2026\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"account_id":{"description":"Telr account id (accountId from list_accounts).","title":"Account Id","type":"integer"},"from_date":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"First payout date, YYYY-MM-DD.","title":"From Date"},"to_date":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Last payout date, YYYY-MM-DD.","title":"To Date"}},"required":["account_id"],"title":"list_payoutsArguments","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_payout_transactions":{"post":{"operationId":"list_payout_transactions","summary":"List the transactions that make up one payout: reference, date, type, authorised and settled amounts, fees, tax and net.","description":"List the transactions that make up one payout: reference, date, type, authorised and settled amounts, fees, tax and net. Use for \"Which transactions were included in Telr payout 987\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"account_id":{"description":"Telr account id (accountId from list_accounts).","title":"Account Id","type":"integer"},"payout_id":{"description":"Payout id from list_payouts.","title":"Payout Id","type":"integer"},"offset":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Number of transactions to skip (default 0).","title":"Offset"},"limit":{"anyOf":[{"maximum":5000,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many transactions to return (1 to 5000, default 100).","title":"Limit"}},"required":["account_id","payout_id"],"title":"list_payout_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/get_pending_payout":{"post":{"operationId":"get_pending_payout","summary":"Show the amount waiting for the next payout of one account with the credit and debit breakdown. Use for \"How much is Tel","description":"Show the amount waiting for the next payout of one account with the credit and debit breakdown. Use for \"How much is Telr holding for my next payout on account 12345\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"account_id":{"description":"Telr account id (accountId from list_accounts).","title":"Account Id","type":"integer"}},"required":["account_id"],"title":"get_pending_payoutArguments","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_pending_transactions":{"post":{"operationId":"list_pending_transactions","summary":"List transactions not yet paid out for one account with settlement amounts, fees, tax, net and due date. Use for \"Which ","description":"List transactions not yet paid out for one account with settlement amounts, fees, tax, net and due date. Use for \"Which Telr transactions are still pending payout on account 12345\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"account_id":{"description":"Telr account id (accountId from list_accounts).","title":"Account Id","type":"integer"},"offset":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Number of transactions to skip (default 0).","title":"Offset"},"limit":{"anyOf":[{"maximum":5000,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many transactions to return (1 to 5000, default 100).","title":"Limit"}},"required":["account_id"],"title":"list_pending_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/get_order":{"post":{"operationId":"get_order","summary":"Get one order by its Telr order reference: status, cart id, amount and currency, and the payment type, card scheme, stat","description":"Get one order by its Telr order reference: status, cart id, amount and currency, and the payment type, card scheme, status and message. Customer details are not returned. Use for \"What is the status of Telr order 4A5B6C7D8E\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"ref":{"description":"Telr order reference.","maxLength":200,"title":"Ref","type":"string"}},"required":["ref"],"title":"get_orderArguments","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}}}}