{"openapi":"3.1.0","info":{"title":"Adyen Platforms (BYOK) API","version":"0.1.0","description":"Adyen Platforms (BYOK) lets an AI assistant read your own Adyen Platforms data through the Adyen Platforms API with a key you supply (Adyen API key with read-only roles for transfers and capital). Read-only: 12 tools (list_transfers, get_transfer, list_transactions, get_transaction, list_capital_grants, get_capital_grant, list_grant_disbursements, get_grant_disbursement, get_grant_account,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-adyen-transfers-capital.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-adyen-transfers-capital/docs"},"termsOfService":"https://connectorbay.com/byok-adyen-transfers-capital/terms"},"servers":[{"url":"https://byok-adyen-transfers-capital.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-adyen-transfers-capital/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_transfers":{"post":{"operationId":"list_transfers","summary":"List money movements on your Adyen balance platform (bank, card, internal, top-up) between two dates, with category, sta","description":"List money movements on your Adyen balance platform (bank, card, internal, top-up) between two dates, with category, status, direction, amount and balance account. Counterparty and person details are not returned. Needs the Transfers API read role on the key. Use for \"What transfers did my balance account make in January 2026\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"env":{"description":"Adyen environment: test for test keys, live for live keys.","enum":["test","live"],"title":"Env","type":"string"},"created_since":{"description":"Only items created on or after this ISO 8601 time, for example 2026-01-01T00:00:00Z.","maxLength":40,"title":"Created Since","type":"string"},"created_until":{"description":"Only items created on or before this ISO 8601 time, for example 2026-02-01T00:00:00Z.","maxLength":40,"title":"Created Until","type":"string"},"balance_platform":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only items of this balance platform id.","title":"Balance Platform"},"account_holder_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only items of this account holder id, for example AH00000000000000000000001.","title":"Account Holder Id"},"balance_account_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only items of this balance account id, for example BA00000000000000000000001.","title":"Balance Account Id"},"payment_instrument_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only items of this payment instrument id.","title":"Payment Instrument Id"},"reference":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only transfers with this reference you supplied.","title":"Reference"},"category":{"anyOf":[{"enum":["bank","card","internal","issuedCard","platformPayment","topUp"],"type":"string"},{"type":"null"}],"default":null,"description":"Only transfers of this category.","title":"Category"},"sort_order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Order by creation time: asc or desc.","title":"Sort Order"},"cursor":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor for the next page, taken from the next link (_links.next.href) of the previous answer.","title":"Cursor"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many items to return per page (1 to 100).","title":"Limit"}},"required":["env","created_since","created_until"],"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/get_transfer":{"post":{"operationId":"get_transfer","summary":"Get one transfer by id: status, category, type, direction, amount, reason, reference and balance account. Counterparty a","description":"Get one transfer by id: status, category, type, direction, amount, reason, reference and balance account. Counterparty and person details are not returned. Use for \"What is the status of transfer 1VVF0D5U66PIUIVP\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"env":{"description":"Adyen environment: test for test keys, live for live keys.","enum":["test","live"],"title":"Env","type":"string"},"id":{"description":"Transfer id, for example 1VVF0D5U66PIUIVP.","maxLength":200,"title":"Id","type":"string"}},"required":["env","id"],"title":"get_transferArguments","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 booked and pending transactions of your balance platform between two dates, with amount, booking and value date, ba","description":"List booked and pending transactions of your balance platform between two dates, with amount, booking and value date, balance account and the transfer behind each. Use for \"Which transactions were booked on balance account BA00000000000000000000001 last month\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"env":{"description":"Adyen environment: test for test keys, live for live keys.","enum":["test","live"],"title":"Env","type":"string"},"created_since":{"description":"Only items created on or after this ISO 8601 time, for example 2026-01-01T00:00:00Z.","maxLength":40,"title":"Created Since","type":"string"},"created_until":{"description":"Only items created on or before this ISO 8601 time, for example 2026-02-01T00:00:00Z.","maxLength":40,"title":"Created Until","type":"string"},"balance_platform":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only items of this balance platform id.","title":"Balance Platform"},"account_holder_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only items of this account holder id, for example AH00000000000000000000001.","title":"Account Holder Id"},"balance_account_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only items of this balance account id, for example BA00000000000000000000001.","title":"Balance Account Id"},"payment_instrument_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only items of this payment instrument id.","title":"Payment Instrument Id"},"sort_order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Order by creation time: asc or desc.","title":"Sort Order"},"cursor":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor for the next page, taken from the next link (_links.next.href) of the previous answer.","title":"Cursor"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many items to return per page (1 to 100).","title":"Limit"}},"required":["env","created_since","created_until"],"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/get_transaction":{"post":{"operationId":"get_transaction","summary":"Get one transaction by id with status, amount, booking and value date, balance account and the transfer behind it. Use f","description":"Get one transaction by id with status, amount, booking and value date, balance account and the transfer behind it. Use for \"Show transaction EVJN42CKX2223S5N\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"env":{"description":"Adyen environment: test for test keys, live for live keys.","enum":["test","live"],"title":"Env","type":"string"},"id":{"description":"Transaction id, for example EVJN42CKX2223S5N.","maxLength":200,"title":"Id","type":"string"}},"required":["env","id"],"title":"get_transactionArguments","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_capital_grants":{"post":{"operationId":"list_capital_grants","summary":"List the Adyen Capital grants (loans or cash advances) received by one account holder, with status and outstanding balan","description":"List the Adyen Capital grants (loans or cash advances) received by one account holder, with status and outstanding balances. Amounts are in the smallest currency unit. Use for \"Which capital grants does account holder AH00000000000000000000001 have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"env":{"description":"Adyen environment: test for test keys, live for live keys.","enum":["test","live"],"title":"Env","type":"string"},"counterparty_account_holder_id":{"description":"Account holder id that received the grants.","maxLength":100,"title":"Counterparty Account Holder Id","type":"string"}},"required":["env","counterparty_account_holder_id"],"title":"list_capital_grantsArguments","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_capital_grant":{"post":{"operationId":"get_capital_grant","summary":"Get one Adyen Capital grant by id: status, principal, fee and total balance, offer and grant account. Use for \"How much ","description":"Get one Adyen Capital grant by id: status, principal, fee and total balance, offer and grant account. Use for \"How much is still owed on grant GR00000000000000000000001\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"env":{"description":"Adyen environment: test for test keys, live for live keys.","enum":["test","live"],"title":"Env","type":"string"},"grant_id":{"description":"Grant id.","maxLength":200,"title":"Grant Id","type":"string"}},"required":["env","grant_id"],"title":"get_capital_grantArguments","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_grant_disbursements":{"post":{"operationId":"list_grant_disbursements","summary":"List the disbursements (payouts of the money lent) of one Adyen Capital grant with amount, fee and outstanding balance. ","description":"List the disbursements (payouts of the money lent) of one Adyen Capital grant with amount, fee and outstanding balance. Use for \"What disbursements were made under grant GR00000000000000000000001\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"env":{"description":"Adyen environment: test for test keys, live for live keys.","enum":["test","live"],"title":"Env","type":"string"},"grant_id":{"description":"Grant id.","maxLength":200,"title":"Grant Id","type":"string"}},"required":["env","grant_id"],"title":"list_grant_disbursementsArguments","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_grant_disbursement":{"post":{"operationId":"get_grant_disbursement","summary":"Get one disbursement of an Adyen Capital grant: amount, fee, balances and repayment rate. Use for \"Show disbursement DI0","description":"Get one disbursement of an Adyen Capital grant: amount, fee, balances and repayment rate. Use for \"Show disbursement DI00000000000000000000001 of grant GR00000000000000000000001\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"env":{"description":"Adyen environment: test for test keys, live for live keys.","enum":["test","live"],"title":"Env","type":"string"},"grant_id":{"description":"Grant id.","maxLength":200,"title":"Grant Id","type":"string"},"disbursement_id":{"description":"Disbursement id.","maxLength":200,"title":"Disbursement Id","type":"string"}},"required":["env","grant_id","disbursement_id"],"title":"get_grant_disbursementArguments","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_grant_account":{"post":{"operationId":"get_grant_account","summary":"Get an Adyen Capital grant account: funding balance account, balances and limits. Use for \"What is the limit of grant ac","description":"Get an Adyen Capital grant account: funding balance account, balances and limits. Use for \"What is the limit of grant account CG00000000000000000000001\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"env":{"description":"Adyen environment: test for test keys, live for live keys.","enum":["test","live"],"title":"Env","type":"string"},"id":{"description":"Grant account id.","maxLength":200,"title":"Id","type":"string"}},"required":["env","id"],"title":"get_grant_accountArguments","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_grant_offers":{"post":{"operationId":"list_grant_offers","summary":"List the static Adyen Capital offers available to one account holder with amount, contract type, fee and repayment rate.","description":"List the static Adyen Capital offers available to one account holder with amount, contract type, fee and repayment rate. Use for \"What capital offers does account holder AH00000000000000000000001 have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"env":{"description":"Adyen environment: test for test keys, live for live keys.","enum":["test","live"],"title":"Env","type":"string"},"account_holder_id":{"description":"Account holder id to list offers for.","maxLength":100,"title":"Account Holder Id","type":"string"}},"required":["env","account_holder_id"],"title":"list_grant_offersArguments","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_grant_offer":{"post":{"operationId":"get_grant_offer","summary":"Get one static Adyen Capital offer by id with amount, contract type, fee, repayment terms and validity. Use for \"Show ca","description":"Get one static Adyen Capital offer by id with amount, contract type, fee, repayment terms and validity. Use for \"Show capital offer GO00000000000000000000001\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"env":{"description":"Adyen environment: test for test keys, live for live keys.","enum":["test","live"],"title":"Env","type":"string"},"id":{"description":"Offer id.","maxLength":200,"title":"Id","type":"string"}},"required":["env","id"],"title":"get_grant_offerArguments","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_dynamic_offers":{"post":{"operationId":"list_dynamic_offers","summary":"List the dynamic Adyen Capital offers (a minimum to maximum amount range to choose from) available to one account holder","description":"List the dynamic Adyen Capital offers (a minimum to maximum amount range to choose from) available to one account holder. Use for \"Are there dynamic capital offers for account holder AH00000000000000000000001\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"env":{"description":"Adyen environment: test for test keys, live for live keys.","enum":["test","live"],"title":"Env","type":"string"},"account_holder_id":{"description":"Account holder id the offers are for.","maxLength":100,"title":"Account Holder Id","type":"string"},"financing_type":{"anyOf":[{"enum":["hardwareFinancing","businessFinancing"],"type":"string"},{"type":"null"}],"default":null,"description":"Type of financing: hardwareFinancing or businessFinancing.","title":"Financing Type"}},"required":["env","account_holder_id"],"title":"list_dynamic_offersArguments","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}}}}