{"openapi":"3.1.0","info":{"title":"CHIP Collect (BYOK) API","version":"0.1.0","description":"CHIP Collect (BYOK) lets an AI assistant read your own CHIP Collect data through the CHIP Collect API with a key you supply (CHIP Collect secret key (the key can also create purchases and refunds; this connector only reads)). Read-only: 7 tools (get_purchase, get_company_balance, get_company_turnover, list_payment_methods, list_statements, get_statement, list_webhooks). 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-chip-collect.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-chip-collect/docs"},"termsOfService":"https://connectorbay.com/byok-chip-collect/terms"},"servers":[{"url":"https://byok-chip-collect.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-chip-collect/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_purchase":{"post":{"operationId":"get_purchase","summary":"Get one purchase by id: status, amount paid, fee, net amount, currency, payment method, reference, refund availability a","description":"Get one purchase by id: status, amount paid, fee, net amount, currency, payment method, reference, refund availability and key timestamps. Customer details are not returned. Use for \"Was CHIP purchase 8f6c2c1e-7b1a-4c1e-9d0e-2f5f6a1b2c3d paid\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"purchase_id":{"description":"Purchase id (UUID).","maxLength":200,"title":"Purchase Id","type":"string"}},"required":["purchase_id"],"title":"get_purchaseArguments","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_company_balance":{"post":{"operationId":"get_company_balance","summary":"Get the company balance per currency: balance, fees, reserved, pending outgoing and available amounts in the smallest cu","description":"Get the company balance per currency: balance, fees, reserved, pending outgoing and available amounts in the smallest currency unit. Currency is required. Use for \"What is my CHIP available balance in MYR\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"currency":{"description":"Uppercase ISO 4217 currency code, for example 'MYR'.","maxLength":3,"title":"Currency","type":"string"},"from_timestamp":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Unix timestamp to read a past balance as of that moment.","title":"From Timestamp"},"brand":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only include this brand UUID.","title":"Brand"},"payment_method":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only include this payment method, for example 'fpx' or 'visa'.","title":"Payment Method"},"product":{"anyOf":[{"enum":["bank_payment","custom_payment","invoice","purchase","refund","subscription"],"type":"string"},{"type":"null"}],"default":null,"description":"Only include this product type.","title":"Product"},"country":{"anyOf":[{"maxLength":2,"type":"string"},{"type":"null"}],"default":null,"description":"Only include clients from this ISO 3166-1 alpha-2 country, for example 'MY'.","title":"Country"}},"required":["currency"],"title":"get_company_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/get_company_turnover":{"post":{"operationId":"get_company_turnover","summary":"Get incoming and outgoing turnover, fees and transaction counts for exactly one currency in a time window. Use for \"What","description":"Get incoming and outgoing turnover, fees and transaction counts for exactly one currency in a time window. Use for \"What was my CHIP turnover in MYR between 1 and 31 October 2026\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"currency":{"description":"Uppercase ISO 4217 currency code; exactly one is required.","maxLength":3,"title":"Currency","type":"string"},"from_timestamp":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only transactions at or after this Unix timestamp.","title":"From Timestamp"},"to_timestamp":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only transactions before this Unix timestamp.","title":"To Timestamp"},"brand":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only include this brand UUID.","title":"Brand"},"payment_method":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only include this payment method, for example 'fpx' or 'visa'.","title":"Payment Method"},"product":{"anyOf":[{"enum":["bank_payment","custom_payment","invoice","purchase","refund","subscription"],"type":"string"},{"type":"null"}],"default":null,"description":"Only include this product type.","title":"Product"},"country":{"anyOf":[{"maxLength":2,"type":"string"},{"type":"null"}],"default":null,"description":"Only include clients from this ISO 3166-1 alpha-2 country, for example 'MY'.","title":"Country"}},"required":["currency"],"title":"get_company_turnoverArguments","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 CHIP can offer for a brand, currency and amount (FPX, cards, e-wallets, DuitNow QR), with names","description":"List the payment methods CHIP can offer for a brand, currency and amount (FPX, cards, e-wallets, DuitNow QR), with names and logos. Use for \"Which payment methods can I offer for RM 10 on my CHIP brand\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"brand_id":{"description":"Brand UUID to look up methods for.","maxLength":200,"title":"Brand Id","type":"string"},"currency":{"const":"MYR","description":"Purchase currency.","title":"Currency","type":"string"},"amount":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Amount in the smallest unit (1000 is RM 10); send it, otherwise only some methods are returned.","title":"Amount"},"country":{"anyOf":[{"maxLength":2,"type":"string"},{"type":"null"}],"default":null,"description":"Optional ISO 3166-1 alpha-2 country code.","title":"Country"},"recurring":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True to keep only methods that support recurring payments.","title":"Recurring"},"language":{"anyOf":[{"maxLength":2,"type":"string"},{"type":"null"}],"default":null,"description":"Optional ISO 639-1 language code for names.","title":"Language"}},"required":["brand_id","currency"],"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_statements":{"post":{"operationId":"list_statements","summary":"List scheduled or finished company statements with status, format, period, creation time and download link. Use for \"Whi","description":"List scheduled or finished company statements with status, format, period, creation time and download link. Use for \"Which CHIP statements are ready to download\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_statementsArguments","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_statement":{"post":{"operationId":"get_statement","summary":"Get one company statement by id: status, format and download link once finished. Use for \"Is CHIP statement 5a0b2e9c-111","description":"Get one company statement by id: status, format and download link once finished. Use for \"Is CHIP statement 5a0b2e9c-1111-2222-3333-444455556666 finished\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"statement_id":{"description":"Statement id (UUID).","maxLength":200,"title":"Statement Id","type":"string"}},"required":["statement_id"],"title":"get_statementArguments","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_webhooks":{"post":{"operationId":"list_webhooks","summary":"List the webhook endpoints registered on the account with title, subscribed events and callback URL. Use for \"Which CHIP","description":"List the webhook endpoints registered on the account with title, subscribed events and callback URL. Use for \"Which CHIP webhooks are registered\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_webhooksArguments","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}}}}