{"openapi":"3.1.0","info":{"title":"Stripe Payments (BYOK) API","version":"0.1.0","description":"Stripe Payments (BYOK) lets an AI assistant read your own Stripe Payments data through the Stripe Payments API with a key you supply (restricted API key with read permissions only (starts with rk_live_ or rk_test_)). Read-only: 11 tools (list_payment_intents, get_payment_intent, list_refunds, get_refund, list_disputes, get_dispute, list_checkout_sessions, get_checkout_session,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-stripe-payments.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-stripe-payments/docs"},"termsOfService":"https://connectorbay.com/byok-stripe-payments/terms"},"servers":[{"url":"https://byok-stripe-payments.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-stripe-payments/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_payment_intents":{"post":{"operationId":"list_payment_intents","summary":"List PaymentIntents (one per attempt to collect a payment), newest first, with status, amount, currency and latest charg","description":"List PaymentIntents (one per attempt to collect a payment), newest first, with status, amount, currency and latest charge. Amounts are in the smallest currency unit. Works with a restricted key that has read access to this resource only. Use for \"Which payments are stuck in requires_payment_method\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"customer":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only objects of this customer id, for example cus_NffrFeUfNV2Hib.","title":"Customer"},"created_after":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only objects created at or after this time, as a Unix timestamp in seconds.","title":"Created After"},"created_before":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only objects created at or before this time, as a Unix timestamp in seconds.","title":"Created Before"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many objects to return (1 to 100).","title":"Limit"},"starting_after":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor for the next page: the id of the last object on the previous page. Use it while has_more is true.","title":"Starting After"}},"title":"list_payment_intentsArguments","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_payment_intent":{"post":{"operationId":"get_payment_intent","summary":"Get one PaymentIntent by id: status, amount, amount received, currency, capture method and latest charge. Works with a r","description":"Get one PaymentIntent by id: status, amount, amount received, currency, capture method and latest charge. Works with a restricted key that has read access to this resource only. Use for \"What is the status of payment intent pi_3MtwBwLkdIwHu7ix28a3tqPa\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"intent":{"description":"PaymentIntent id, for example pi_3MtwBwLkdIwHu7ix28a3tqPa.","maxLength":200,"title":"Intent","type":"string"}},"required":["intent"],"title":"get_payment_intentArguments","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, reason and the charge or PaymentIntent refunded. Amounts are in the smallest","description":"List refunds with amount, currency, status, reason and the charge or PaymentIntent refunded. Amounts are in the smallest currency unit. Works with a restricted key that has read access to this resource only. Use for \"What refunds did I issue for charge ch_3MmlLrLkdIwHu7ix0snN0B15\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"charge":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only refunds of this charge id.","title":"Charge"},"payment_intent":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only refunds of this PaymentIntent id.","title":"Payment Intent"},"created_after":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only objects created at or after this time, as a Unix timestamp in seconds.","title":"Created After"},"created_before":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only objects created at or before this time, as a Unix timestamp in seconds.","title":"Created Before"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many objects to return (1 to 100).","title":"Limit"},"starting_after":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor for the next page: the id of the last object on the previous page. Use it while has_more is true.","title":"Starting After"}},"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/get_refund":{"post":{"operationId":"get_refund","summary":"Get one refund by id: amount, status, reason, failure reason and receipt number. Works with a restricted key that has re","description":"Get one refund by id: amount, status, reason, failure reason and receipt number. Works with a restricted key that has read access to this resource only. Use for \"Did refund re_3MtwBwLkdIwHu7ix2DWUaZs8 succeed\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"refund":{"description":"Refund id, for example re_3MtwBwLkdIwHu7ix2DWUaZs8.","maxLength":200,"title":"Refund","type":"string"}},"required":["refund"],"title":"get_refundArguments","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 amount, reason, status and the evidence deadline. Evidence text and customer details ar","description":"List disputes (chargebacks) with amount, reason, status and the evidence deadline. Evidence text and customer details are not returned. Works with a restricted key that has read access to this resource only. Use for \"Which disputes need a response and by when\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"charge":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only disputes on this charge id.","title":"Charge"},"payment_intent":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only disputes on this PaymentIntent id.","title":"Payment Intent"},"created_after":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only objects created at or after this time, as a Unix timestamp in seconds.","title":"Created After"},"created_before":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only objects created at or before this time, as a Unix timestamp in seconds.","title":"Created Before"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many objects to return (1 to 100).","title":"Limit"},"starting_after":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor for the next page: the id of the last object on the previous page. Use it while has_more is true.","title":"Starting After"}},"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/get_dispute":{"post":{"operationId":"get_dispute","summary":"Get one dispute by id: amount, reason, status and evidence deadline and submission state. Evidence text and customer det","description":"Get one dispute by id: amount, reason, status and evidence deadline and submission state. Evidence text and customer details are not returned. Works with a restricted key that has read access to this resource only. Use for \"When is the evidence for dispute dp_1MtwBwLkdIwHu7ix due\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"dispute":{"description":"Dispute id, for example dp_1MtwBwLkdIwHu7ixOSYFB3e0.","maxLength":200,"title":"Dispute","type":"string"}},"required":["dispute"],"title":"get_disputeArguments","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_checkout_sessions":{"post":{"operationId":"list_checkout_sessions","summary":"List Checkout Sessions with status, mode, payment status, totals and the PaymentIntent or subscription they created. Cus","description":"List Checkout Sessions with status, mode, payment status, totals and the PaymentIntent or subscription they created. Customer details and addresses are not returned. Works with a restricted key that has read access to this resource only. Use for \"Which checkout sessions expired without payment\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"status":{"anyOf":[{"enum":["complete","expired","open"],"type":"string"},{"type":"null"}],"default":null,"description":"Only sessions in this status.","title":"Status"},"payment_link":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only sessions created from this payment link id.","title":"Payment Link"},"payment_intent":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only the session for this PaymentIntent id.","title":"Payment Intent"},"subscription":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only the session for this subscription id.","title":"Subscription"},"customer":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only objects of this customer id, for example cus_NffrFeUfNV2Hib.","title":"Customer"},"created_after":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only objects created at or after this time, as a Unix timestamp in seconds.","title":"Created After"},"created_before":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only objects created at or before this time, as a Unix timestamp in seconds.","title":"Created Before"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many objects to return (1 to 100).","title":"Limit"},"starting_after":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor for the next page: the id of the last object on the previous page. Use it while has_more is true.","title":"Starting After"}},"title":"list_checkout_sessionsArguments","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_checkout_session":{"post":{"operationId":"get_checkout_session","summary":"Get one Checkout Session by id: status, mode, payment status, totals and the linked PaymentIntent or subscription. Custo","description":"Get one Checkout Session by id: status, mode, payment status, totals and the linked PaymentIntent or subscription. Customer details are not returned. Works with a restricted key that has read access to this resource only. Use for \"Was checkout session cs_test_a1b2 paid\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"session":{"description":"Checkout Session id, for example cs_test_a11YYufWQzNY63zpQ6QSNRQhkUpVph4WRmzW0zWJO2znZKdVujZ0N0S22u.","maxLength":200,"title":"Session","type":"string"}},"required":["session"],"title":"get_checkout_sessionArguments","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_checkout_session_line_items":{"post":{"operationId":"list_checkout_session_line_items","summary":"List the line items of one Checkout Session with description, quantity, amounts and currency. Works with a restricted ke","description":"List the line items of one Checkout Session with description, quantity, amounts and currency. Works with a restricted key that has read access to this resource only. Use for \"What was bought in checkout session cs_test_a1b2\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"session":{"description":"Checkout Session id.","maxLength":200,"title":"Session","type":"string"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many objects to return (1 to 100).","title":"Limit"},"starting_after":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor for the next page: the id of the last object on the previous page. Use it while has_more is true.","title":"Starting After"}},"required":["session"],"title":"list_checkout_session_line_itemsArguments","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_method_configurations":{"post":{"operationId":"list_payment_method_configurations","summary":"List payment method configurations (which payment methods are offered) with name, default flag and whether card and link","description":"List payment method configurations (which payment methods are offered) with name, default flag and whether card and link are available. Works with a restricted key that has read access to this resource only. Use for \"Which payment method configurations exist and which is the default\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True for active configurations only, false for inactive ones.","title":"Active"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many objects to return (1 to 100).","title":"Limit"},"starting_after":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor for the next page: the id of the last object on the previous page. Use it while has_more is true.","title":"Starting After"}},"title":"list_payment_method_configurationsArguments","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_method_domains":{"post":{"operationId":"list_payment_method_domains","summary":"List domains registered for wallet payments with enabled flag and the status of Apple Pay, Google Pay and Link on each. ","description":"List domains registered for wallet payments with enabled flag and the status of Apple Pay, Google Pay and Link on each. Works with a restricted key that has read access to this resource only. Use for \"Is Apple Pay active on my shop domain\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"domain_name":{"anyOf":[{"maxLength":253,"type":"string"},{"type":"null"}],"default":null,"description":"Only the entry for this domain name.","title":"Domain Name"},"enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True for enabled domains only, false for disabled ones.","title":"Enabled"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many objects to return (1 to 100).","title":"Limit"},"starting_after":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor for the next page: the id of the last object on the previous page. Use it while has_more is true.","title":"Starting After"}},"title":"list_payment_method_domainsArguments","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}}}}