# generated by fastapi-codegen:
# filename: openapi.yaml
# timestamp: 2025-06-29T11:30:52+00:00
import argparse
import json
import os
from datetime import date, datetime
from typing import *
from typing import Optional, Union
from uuid import UUID
from autogen.mcp.mcp_proxy import MCPProxy
from autogen.mcp.mcp_proxy.security import (
BaseSecurity,
HTTPBasic,
UnsuportedSecurityStub,
)
from fastapi import Header, Path, Query, UploadFile
from pydantic import EmailStr, conint, constr
from models import (
AccessTokenResponse,
AccessTokenValidationRequest,
AuthResponse,
CreateFundingAccountRequestV2,
CreatePayeesCSVResponseV3,
CreatePayeesCSVResponseV4,
CreatePayeesRequestV3,
CreatePayeesRequestV4,
CreatePayorLinkRequest,
CreatePayoutRequestV3,
CreateWebhookRequest,
ErrorResponse,
FundingAccountResponseV2,
FundingAccountTypeV2,
FundingRequestV2,
FundingRequestV3,
FundingResponse,
GetFundingsResponse,
GetPaymentsForPayoutResponseV3,
GetPaymentsForPayoutResponseV4,
GetPayoutsResponse,
GetPayoutsResponseV3,
GetPayoutStatistics,
Include,
InlineResponse400,
InlineResponse401,
InlineResponse403,
InlineResponse404,
InlineResponse409,
InlineResponse412,
InstructPayoutRequestV3,
InvitationStatusV4,
InvitePayeeRequestV3,
InvitePayeeRequestV4,
InviteUserRequest,
ListFundingAccountsResponseV2,
ListPaymentsResponseV3,
ListPaymentsResponseV4,
ListSourceAccountResponseV2,
ListSourceAccountResponseV3,
OfacStatusV4,
OnboardedStatusV4,
PagedPayeeInvitationStatusResponseV3,
PagedPayeeInvitationStatusResponseV4,
PagedPayeeResponseV3,
PagedPayeeResponseV4,
PagedPaymentsResponseV3,
PagedUserResponse,
PageResourceFundingPayorStatusAuditResponseFundingPayorStatusAuditResponse,
PasswordRequest,
PayeeDeltaResponseV3,
PayeeDeltaResponseV4,
PayeeDetailResponseV3,
PayeeDetailResponseV4,
PayeeType,
PayeeType2,
PayeeUserSelfUpdateRequest,
PaymentChannelRulesResponse,
PaymentDeltaResponse,
PaymentDeltaResponseV1,
PaymentResponseV3,
PaymentResponseV4,
PayorAmlTransaction,
PayorAmlTransactionV3,
PayorBrandingResponse,
PayorCreateApiKeyRequest,
PayorCreateApiKeyResponse,
PayorCreateApplicationRequest,
PayorEmailOptOutRequest,
PayorLinksResponse,
PayorV1,
PayorV2,
PayoutSummaryResponseV3,
PingResponse,
PostInstructFxStatus1,
QueryBatchResponseV3,
QueryBatchResponseV4,
QuoteResponseV3,
RegisterSmsRequest,
ResendTokenRequest,
ResetPasswordRequest,
RoleUpdateRequest,
SchedulePayoutRequestV3,
ScheduleStatus1,
SelfMFATypeUnregisterRequest,
SelfUpdatePasswordRequest,
SetNotificationsRequest,
SetNotificationsRequest2,
SourceAccountResponseV2,
SourceAccountResponseV3,
SourceAccountTypeV3,
Status1,
Status3,
Status5,
Status7,
Status9,
Status11,
Status13,
SupportedCountriesResponse,
SupportedCountriesResponseV2,
SupportedCurrencyResponseV2,
TransferRequestV2,
TransferRequestV3,
TransmissionType1,
TransmissionType3,
UnregisterMFARequest,
UpdatePayeeDetailsRequestV3,
UpdatePayeeDetailsRequestV4,
UpdateRemoteIdRequestV3,
UpdateRemoteIdRequestV4,
UpdateWebhookRequest,
UserDetailsUpdateRequest,
UserResponse,
UserStatus,
UserType,
ValidatePasswordResponse,
WatchlistStatusV3,
WebhookResponse,
WebhooksResponse,
WithdrawPaymentRequest,
)
app = MCPProxy(
description='## Terms and Definitions\n\nThroughout this document and the Velo platform the following terms are used:\n\n* **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout.\n* **Payee.** The recipient of funds paid out by a payor.\n* **Payment.** A single transfer of funds from a payor to a payee.\n* **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee.\n* **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking.\n\n## Overview\n\nThe Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution:\n\n* Authenticate with the Velo platform\n* Maintain a collection of payees\n* Query the payor’s current balance of funds within the platform and perform additional funding\n* Issue payments to payees\n* Query the platform for a history of those payments\n\nThis document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference.\n\n## API Considerations\n\nThe Velo Payments API is REST based and uses the JSON format for requests and responses.\n\nMost calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details.\n\nWhere a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters).\n\nWhere curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print.\n\n## Authenticating with the Velo Platform\n\nOnce Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner.\n\nYou will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following:\n\ncreate a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529\n\nbase64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\n\ncreate an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\n\nperform the Velo authentication REST call using the HTTP header created above e.g. via curl:\n\n```\n curl -X POST \\\n -H "Content-Type: application/json" \\\n -H "Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==" \\\n \'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials\'\n```\n\nIf successful, this call will result in a **200** HTTP status code and a response body such as:\n\n```\n {\n "access_token":"19f6bafd-93fd-4747-b229-00507bbc991f",\n "token_type":"bearer",\n "expires_in":1799,\n "scope":"..."\n }\n```\n## API access following authentication\nFollowing successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated.\n\nThis is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below:\n\n```\n -H "Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f "\n```\n\nIf you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.\n',
license={
'name': 'Apache License 2.0',
'url': 'https://www.apache.org/licenses/LICENSE-2.0.html',
},
title='Velo Payments APIs',
version='2.34.63',
servers=[
{
'description': 'Velo Payments Sandbox for testing',
'url': 'https://api.sandbox.velopayments.com/',
},
{
'description': 'Velo Payments Production URL',
'url': 'https://api.payouts.velopayments.com',
},
],
)
@app.post(
'/v1/authenticate',
description=""" <p>Use this endpoint to obtain an access token for calling Velo Payments APIs. </p>
<p>You need your API key and API secret issued by Velo</p>
<p>To login and get an access token the API key and API secret must be Base64 encoded by concatenating them with a colon between them</p>
<p>e.g. Given an ApiKey: 44a9537d-d55d-4b47-8082-14061c2bcdd8 and ApiSecret: c396b26b-137a-44fd-87f5-34631f8fd529</p>
<p>Using a Base64 encode function Base64Encoder().encode("44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529")</p>
<p>Included as a Basic Authorization header: -H "Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==" </p>
""",
tags=['user_authentication', 'multi_factor_authentication'],
security=[
HTTPBasic(name="None"),
],
)
def velo_auth(grant_type: Optional[str] = 'client_credentials'):
"""
Authentication endpoint
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.get(
'/v1/deltas/fundings',
description=""" Get funding audit deltas for a payor """,
tags=['funding_operations', 'payment_audit_management', 'payment_management'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def list_funding_audit_deltas(
payor_id: UUID = Query(..., alias='payorId'),
updated_since: datetime = Query(..., alias='updatedSince'),
page: Optional[int] = 1,
page_size: Optional[conint(ge=1, le=100)] = Query(25, alias='pageSize'),
):
"""
Get Funding Audit Delta
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.get(
'/v1/deltas/payments',
description=""" Deprecated (use /v4/payments/deltas instead) """,
tags=['payment_tracking', 'payment_management', 'payor_operations'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def list_payment_changes(
payor_id: UUID = Query(..., alias='payorId'),
updated_since: datetime = Query(..., alias='updatedSince'),
page: Optional[int] = 1,
page_size: Optional[conint(ge=1, le=1000)] = Query(100, alias='pageSize'),
):
"""
V1 List Payment Changes
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.get(
'/v1/fundings/{fundingId}',
description=""" Get Funding by Id """,
tags=['funding_operations'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def get_funding_by_id_v1(funding_id: UUID = Path(..., alias='fundingId')):
"""
Get Funding
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.post(
'/v1/logout',
description=""" <p>Given a valid access token in the header then log out the authenticated user or client </p>
<p>Will revoke the token</p>
""",
tags=['user_authentication', 'self_service_user_management'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def logout():
"""
Logout
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.post(
'/v1/password/reset',
description=""" <p>Reset password </p>
<p>An email with an embedded link will be sent to the receipient of the email address </p>
<p>The link will contain a token to be used for resetting the password </p>
""",
tags=['user_authentication', 'self_service_user_management'],
)
def reset_password(body: ResetPasswordRequest):
"""
Reset password
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.get(
'/v1/paymentChannelRules',
description=""" List the country specific payment channel rules. """,
tags=['country_management', 'country_currency_retrieval'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def list_payment_channel_rules_v1():
"""
List Payment Channel Country Rules
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.get(
'/v1/paymentaudit/fundings',
description=""" Deprecated (use /v4/paymentaudit/fundings) """,
tags=['funding_operations', 'payor_operations'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def get_fundings_v1(
payor_id: UUID = Query(..., alias='payorId'),
page: Optional[int] = 1,
page_size: Optional[conint(ge=1, le=100)] = Query(25, alias='pageSize'),
sort: Optional[str] = None,
):
"""
V1 Get Fundings for Payor
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.get(
'/v1/paymentaudit/payoutStatistics',
description=""" Deprecated (Use /v4/paymentaudit/payoutStatistics) """,
tags=['payout_management', 'payout_operations'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def get_payout_stats_v1(payor_id: Optional[UUID] = Query(None, alias='payorId')):
"""
V1 Get Payout Statistics
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.post(
'/v1/payments/{paymentId}/withdraw',
description=""" <p>withdraw a payment </p>
<p>There are a variety of reasons why this can fail</p>
<ul>
<li>the payment must be in a state of 'accepted' or 'unfunded'</li>
<li>the payout must not be in a state of 'instructed'</li>
</ul>
""",
tags=['payout_operations', 'payment_management', 'payment_audit_management'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def withdraw_payment(
payment_id: UUID = Path(..., alias='paymentId'), body: WithdrawPaymentRequest = ...
):
"""
Withdraw a Payment
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.get(
'/v1/payorLinks',
description=""" <p>If the payor is set up as part of a hierarchy you can use this API to traverse the hierarchy</p>
""",
tags=['payor_operations'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def payor_links_v1(
descendants_of_payor: Optional[UUID] = Query(None, alias='descendantsOfPayor'),
parent_of_payor: Optional[UUID] = Query(None, alias='parentOfPayor'),
fields: Optional[str] = None,
):
"""
List Payor Links
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.post(
'/v1/payorLinks',
description=""" This endpoint allows you to create a payor link. """,
tags=['payor_operations'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def create_payor_links(body: CreatePayorLinkRequest):
"""
Create a Payor Link
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.get(
'/v1/payors/{payorId}',
description=""" <p>Get a Single Payor by Id.</p>
<p>deprecated since v2.10 - Use /v2/payors
""",
tags=['payor_operations'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def get_payor_by_id_v1(payor_id: UUID = Path(..., alias='payorId')):
"""
Get Payor
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.post(
'/v1/payors/{payorId}/applications',
description=""" <p>Create an application for the given Payor ID.</p>
<p>Applications provide a means to group your API Keys</p>
<p>For example you might have an SAP application that you wish to integrate with Velo</p>
<p>You can create an application and then create one or more API keys for the application</p>
""",
tags=['payor_operations'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def payor_create_application_v1(
payor_id: UUID = Path(..., alias='payorId'),
body: PayorCreateApplicationRequest = ...,
):
"""
Create Application
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.post(
'/v1/payors/{payorId}/applications/{applicationId}/keys',
description=""" <p>Create an an API key for the given payor Id and application Id</p>
<p>You can create multiple API Keys for a given application</p>
<p>API Keys are programmatic users for integrating your application with the Velo platform</p>
""",
tags=['payor_operations'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def payor_create_api_key_v1(
payor_id: UUID = Path(..., alias='payorId'),
application_id: UUID = Path(..., alias='applicationId'),
body: PayorCreateApiKeyRequest = ...,
):
"""
Create API Key
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.get(
'/v1/payors/{payorId}/branding',
description=""" Get the payor branding details. """,
tags=['payor_operations'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def payor_get_branding(payor_id: UUID = Path(..., alias='payorId')):
"""
Get Branding
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.post(
'/v1/payors/{payorId}/branding/logos',
description=""" <p>Add Payor Logo</p>
<p>Logo file is used in your branding and emails sent to payees</p>
""",
tags=['payor_operations'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def payor_add_payor_logo_v1(
payor_id: UUID = Path(..., alias='payorId'), file: UploadFile = ...
):
"""
Add Logo
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.post(
'/v1/payors/{payorId}/reminderEmailsUpdate',
description=""" Update the emailRemindersOptOut field for a Payor. This API can be used to opt out
or opt into Payor Reminder emails. These emails are typically around payee events
such as payees registering and onboarding.
""",
tags=['notification_settings', 'payor_operations'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def payor_email_opt_out(
payor_id: UUID = Path(..., alias='payorId'), body: PayorEmailOptOutRequest = ...
):
"""
Reminder Email Opt-Out
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.post(
'/v1/sourceAccounts/{sourceAccountId}/notifications',
description=""" <p>Set notifications for a given source account</p>
<p>deprecated since 2.34 (use v3 version)</p>
""",
tags=['notification_settings'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def set_notifications_request(
source_account_id: UUID = Path(..., alias='sourceAccountId'),
body: SetNotificationsRequest = ...,
):
"""
Set notifications
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.get(
'/v1/supportedCountries',
description=""" <p>List the supported countries.</p>
<p>This version will be retired in March 2020. Use /v2/supportedCountries</p>
""",
tags=['country_currency_retrieval', 'country_management'],
)
def list_supported_countries_v1():
"""
List Supported Countries
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.post(
'/v1/validate',
description=""" <p>The second part of login involves validating using an MFA device</p>
<p>An access token with PRE_AUTH authorities is required</p>
""",
tags=['user_authentication', 'multi_factor_authentication'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def validate_access_token(
authorization: Optional[str] = Header(None, alias='Authorization'),
body: AccessTokenValidationRequest = ...,
):
"""
validate
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.get(
'/v1/webhooks',
description=""" List the details about the webhooks for the given payor. """,
tags=['payor_operations', 'webhook_management'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def list_webhooks_v1(
page: Optional[int] = 1,
page_size: Optional[conint(ge=1, le=100)] = Query(25, alias='pageSize'),
payor_id: UUID = Query(..., alias='payorId'),
):
"""
List the details about the webhooks for the given payor.
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.post(
'/v1/webhooks',
description=""" Create Webhook """,
tags=['webhook_management'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def create_webhook_v1(body: CreateWebhookRequest = None):
"""
Create Webhook
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.get(
'/v1/webhooks/{webhookId}',
description=""" Get details about the given webhook. """,
tags=['webhook_management'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def get_webhook_v1(webhook_id: UUID = Path(..., alias='webhookId')):
"""
Get details about the given webhook.
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.post(
'/v1/webhooks/{webhookId}',
description=""" Update Webhook """,
tags=['webhook_management'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def update_webhook_v1(
webhook_id: UUID = Path(..., alias='webhookId'), body: UpdateWebhookRequest = None
):
"""
Update Webhook
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.post(
'/v1/webhooks/{webhookId}/ping',
tags=['webhook_management'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def ping_webhook_v1(webhook_id: UUID = Path(..., alias='webhookId')):
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.get(
'/v2/currencies',
description=""" List the supported currencies. """,
tags=['country_currency_retrieval'],
)
def list_supported_currencies_v2():
"""
List Supported Currencies
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.get(
'/v2/fundingAccounts',
description=""" Get the funding accounts. """,
tags=['funding_operations', 'payor_operations'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def get_funding_accounts_v2(
payor_id: Optional[UUID] = Query(None, alias='payorId'),
name: Optional[str] = None,
country: Optional[str] = None,
currency: Optional[str] = None,
type: Optional[FundingAccountTypeV2] = None,
page: Optional[int] = 1,
page_size: Optional[conint(ge=1, le=100)] = Query(25, alias='pageSize'),
sort: Optional[constr(pattern=r'[a-zA-Z]+[:desc|:asc]')] = 'accountName:asc',
sensitive: Optional[bool] = False,
):
"""
Get Funding Accounts
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.post(
'/v2/fundingAccounts',
description=""" Create Funding Account """,
tags=['funding_operations', 'source_account_management'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def create_funding_account_v2(body: CreateFundingAccountRequestV2 = None):
"""
Create Funding Account
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.get(
'/v2/fundingAccounts/{fundingAccountId}',
description=""" Get Funding Account by ID """,
tags=['funding_operations', 'payment_management'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def get_funding_account_v2(
funding_account_id: UUID = Path(..., alias='fundingAccountId'),
sensitive: Optional[bool] = False,
):
"""
Get Funding Account
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.get(
'/v2/payors/{payorId}',
description=""" Get a Single Payor by Id.
""",
tags=['payor_operations'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def get_payor_by_id_v2(payor_id: UUID = Path(..., alias='payorId')):
"""
Get Payor
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.get(
'/v2/sourceAccounts',
description=""" List source accounts. """,
tags=[
'source_account_management',
'source_account_operations',
'funding_operations',
'payor_operations',
],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def get_source_accounts_v2(
physical_account_name: Optional[str] = Query(None, alias='physicalAccountName'),
physical_account_id: Optional[UUID] = Query(None, alias='physicalAccountId'),
payor_id: Optional[UUID] = Query(None, alias='payorId'),
funding_account_id: Optional[UUID] = Query(None, alias='fundingAccountId'),
page: Optional[int] = 1,
page_size: Optional[conint(ge=1, le=100)] = Query(25, alias='pageSize'),
sort: Optional[
constr(pattern=r'[fundingRef|name|balance]+[:desc|:asc]')
] = 'fundingRef:asc',
):
"""
Get list of source accounts
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.get(
'/v2/sourceAccounts/{sourceAccountId}',
description=""" Get details about given source account. """,
tags=['source_account_management', 'source_account_operations'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def get_source_account_v2(source_account_id: UUID = Path(..., alias='sourceAccountId')):
"""
Get Source Account
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.post(
'/v2/sourceAccounts/{sourceAccountId}/fundingRequest',
description=""" Instruct a funding request to transfer funds from the payor’s funding bank to the payor’s balance held within Velo (202 - accepted, 400 - invalid request body, 404 - source account not found). """,
tags=[
'funding_operations',
'source_account_management',
'source_account_operations',
],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def create_funding_request_v2(
source_account_id: UUID = Path(..., alias='sourceAccountId'),
body: FundingRequestV2 = ...,
):
"""
Create Funding Request
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.post(
'/v2/sourceAccounts/{sourceAccountId}/transfers',
description=""" Transfer funds between source accounts for a Payor. The 'from' source account is identified in the URL, and is the account which will be debited. The 'to' (destination) source account is in the body, and is the account which will be credited. Both source accounts must belong to the same Payor. There must be sufficient balance in the 'from' source account, otherwise the transfer attempt will fail. """,
tags=['source_account_management', 'source_account_operations'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def transfer_funds_v2(
source_account_id: UUID = Path(..., alias='sourceAccountId'),
body: TransferRequestV2 = ...,
):
"""
Transfer Funds between source accounts
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.get(
'/v2/supportedCountries',
description=""" List the supported countries. """,
tags=['country_currency_retrieval', 'country_management'],
)
def list_supported_countries_v2():
"""
List Supported Countries
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.get(
'/v2/users',
description=""" Get a paginated response listing the Users """,
tags=['user_profile_management'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def list_users(
type: Optional[UserType] = None,
status: Optional[UserStatus] = None,
entity_id: Optional[UUID] = Query(None, alias='entityId'),
payee_type: Optional[PayeeType] = Query(None, alias='payeeType'),
page: Optional[int] = 1,
page_size: Optional[conint(ge=1, le=100)] = Query(25, alias='pageSize'),
sort: Optional[constr(pattern=r'[a-zA-Z]+[:desc|:asc]')] = 'email:asc',
):
"""
List Users
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.post(
'/v2/users/invite',
description=""" Create a User and invite them to the system
""",
tags=['user_profile_management', 'user_authentication'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def invite_user(body: InviteUserRequest):
"""
Invite a User
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.post(
'/v2/users/registration/sms',
description=""" <p>Register an Sms number and send an OTP to it </p>
<p>Used for manual verification of a user </p>
<p>The backoffice user initiates the request to send the OTP to the user's sms </p>
<p>The user then reads back the OTP which the backoffice user enters in the verifactionCode property for requests that require it</p>
""",
tags=['self_service_user_management', 'user_authentication'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def register_sms(body: RegisterSmsRequest):
"""
Register SMS Number
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.get(
'/v2/users/self',
description=""" Get the user's details
""",
tags=['self_service_user_management', 'user_profile_management'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def get_self():
"""
Get Self
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.post(
'/v2/users/self/mfa/unregister',
description=""" <p>Unregister the MFA device for the user </p>
<p>If the user does not require further verification then a register new MFA device token will be sent to them via their email address</p>
""",
tags=['multi_factor_authentication', 'self_service_user_management'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def unregister_m_f_a_for_self(
authorization: Optional[str] = Header(None, alias='Authorization'),
body: SelfMFATypeUnregisterRequest = ...,
):
"""
Unregister MFA for Self
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.post(
'/v2/users/self/password',
description=""" Update password for self
""",
tags=['user_authentication', 'self_service_user_management'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def update_password_self(body: SelfUpdatePasswordRequest):
"""
Update Password for self
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.post(
'/v2/users/self/password/validate',
description=""" validate the password and return a score
""",
tags=['user_authentication', 'self_service_user_management'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def validate_password_self(body: PasswordRequest):
"""
Validate the proposed password
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.post(
'/v2/users/self/userDetailsUpdate',
description=""" <p>Update the profile details for the given user</p>
<p>Only Payee user types are supported</p>
""",
tags=['user_profile_management', 'self_service_user_management'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def user_details_update_for_self(body: PayeeUserSelfUpdateRequest):
"""
Update User Details for self
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.delete(
'/v2/users/{userId}',
description=""" Delete User by Id.
""",
tags=['user_profile_management'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def delete_user_by_id_v2(user_id: UUID = Path(..., alias='userId')):
"""
Delete a User
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.get(
'/v2/users/{userId}',
description=""" Get a Single User by Id.
""",
tags=['user_profile_management', 'self_service_user_management'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def get_user_by_id_v2(user_id: UUID = Path(..., alias='userId')):
"""
Get User
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.post(
'/v2/users/{userId}/disable',
description=""" <p>If a user is enabled this endpoint will disable them </p>
<p>The invoker must have the appropriate permission </p>
<p>A user cannot disable themself </p>
<p>When a user is disabled any active access tokens will be revoked and the user will not be able to log in</p>
""",
tags=['user_profile_management'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def disable_user_v2(user_id: UUID = Path(..., alias='userId')):
"""
Disable a User
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.post(
'/v2/users/{userId}/enable',
description=""" <p>If a user has been disabled this endpoints will enable them </p>
<p>The invoker must have the appropriate permission </p>
<p>A user cannot enable themself </p>
<p>If the user is a payor user and the payor is disabled this operation is not allowed</p>
<p>If enabling a payor user would breach the limit for master admin payor users the request will be rejected </p>
""",
tags=['user_profile_management', 'user_authentication'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def enable_user_v2(user_id: UUID = Path(..., alias='userId')):
"""
Enable a User
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.post(
'/v2/users/{userId}/mfa/unregister',
description=""" <p>Unregister the MFA device for the user </p>
<p>If the user does not require further verification then a register new MFA device token will be sent to them via their email address</p>
""",
tags=[
'user_authentication',
'multi_factor_authentication',
'self_service_user_management',
],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def unregister_m_f_a(
user_id: UUID = Path(..., alias='userId'), body: UnregisterMFARequest = ...
):
"""
Unregister MFA for the user
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.post(
'/v2/users/{userId}/roleUpdate',
description=""" <p>Update the user's Role</p>
""",
tags=['user_profile_management'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def role_update(
user_id: UUID = Path(..., alias='userId'), body: RoleUpdateRequest = ...
):
"""
Update User Role
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.post(
'/v2/users/{userId}/tokens',
description=""" <p>Resend the specified token </p>
<p>The token to resend must already exist for the user </p>
<p>It will be revoked and a new one issued</p>
""",
tags=[
'user_authentication',
'multi_factor_authentication',
'self_service_user_management',
],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def resend_token(
user_id: UUID = Path(..., alias='userId'), body: ResendTokenRequest = ...
):
"""
Resend a token
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.post(
'/v2/users/{userId}/unlock',
description=""" If a user is locked this endpoint will unlock them
""",
tags=[
'user_authentication',
'user_profile_management',
'self_service_user_management',
],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def unlock_user_v2(user_id: UUID = Path(..., alias='userId')):
"""
Unlock a User
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.post(
'/v2/users/{userId}/userDetailsUpdate',
description=""" <p>Update the profile details for the given user</p>
<p>When updating Payor users with the role of payor.master_admin a verificationCode is required</p>
""",
tags=['user_profile_management', 'self_service_user_management'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def user_details_update(
user_id: UUID = Path(..., alias='userId'), body: UserDetailsUpdateRequest = ...
):
"""
Update User Details
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.get(
'/v3/payees',
description=""" <p>Use v4 instead</p>
Get a paginated response listing the payees for a payor.
""",
tags=['payee_operations', 'payor_operations'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def list_payees_v3(
payor_id: UUID = Query(..., alias='payorId'),
watchlist_status: Optional[WatchlistStatusV3] = Query(
None, alias='watchlistStatus'
),
disabled: Optional[bool] = None,
onboarded_status: Optional[OnboardedStatusV4] = Query(
None, alias='onboardedStatus'
),
email: Optional[EmailStr] = None,
display_name: Optional[str] = Query(None, alias='displayName'),
remote_id: Optional[str] = Query(None, alias='remoteId'),
payee_type: Optional[PayeeType2] = Query(None, alias='payeeType'),
payee_country: Optional[str] = Query(None, alias='payeeCountry'),
page: Optional[int] = 1,
page_size: Optional[int] = Query(25, alias='pageSize'),
sort: Optional[constr(pattern=r'[a-zA-Z]+[:desc|:asc]')] = 'displayName:asc',
):
"""
List Payees
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.post(
'/v3/payees',
description=""" <p>Use v4 instead</p>
Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query
for status (201 - Created, 400 - invalid request body. In addition to standard semantic validations, a
400 will also result if there is a duplicate remote id within the batch / if there is a duplicate email
within the batch, i.e. if there is a conflict between the data provided for one payee within the batch and
that provided for another payee within the same batch). The validation at this stage is intra-batch only.
Validation against payees who have already been invited occurs subsequently during processing of the batch.
""",
tags=['payee_operations'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def create_payee_v3(body: CreatePayeesRequestV3 = None):
"""
Initiate Payee Creation
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.get(
'/v3/payees/batch/{batchId}',
description=""" <p>Use v4 instead</p>
Fetch the status of a specific batch of payees. The batch is fully processed when status is ACCEPTED and pendingCount is 0 ( 200 - OK, 404 - batch not found ).
""",
tags=['batch_query_operations', 'batch_processing_operations'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def query_batch_status_v3(batch_id: UUID = Path(..., alias='batchId')):
"""
Query Batch Status
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.get(
'/v3/payees/deltas',
description=""" <p>Use v4 instead</p>
<p>Get a paginated response listing payee changes.</p>
""",
tags=['payor_operations', 'payee_operations', 'payment_management'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def list_payee_changes_v3(
payor_id: UUID = Query(..., alias='payorId'),
updated_since: datetime = Query(..., alias='updatedSince'),
page: Optional[int] = 1,
page_size: Optional[int] = Query(100, alias='pageSize'),
):
"""
List Payee Changes
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.get(
'/v3/payees/payors/{payorId}/invitationStatus',
description=""" <p>Use v4 instead</p>
<p>Returns a filtered, paginated list of payees associated with a payor, along with invitation status and grace period end date.</p>
""",
tags=['payee_operations', 'payor_operations'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def get_payees_invitation_status_v3(
payor_id: UUID = Path(..., alias='payorId'),
payee_id: Optional[UUID] = Query(None, alias='payeeId'),
invitation_status: Optional[InvitationStatusV4] = Query(
None, alias='invitationStatus'
),
page: Optional[int] = 1,
page_size: Optional[int] = Query(25, alias='pageSize'),
):
"""
Get Payee Invitation Status
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.delete(
'/v3/payees/{payeeId}',
description=""" <p>Use v4 instead</p>
<p>This API will delete Payee by Id (UUID). Deletion by ID is not allowed if:</p>
<p>* Payee ID is not found</p>
<p>* If Payee has not been on-boarded</p>
<p>* If Payee is in grace period</p>
<p>* If Payee has existing payments</p>
""",
tags=['payee_operations'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def delete_payee_by_id_v3(payee_id: UUID = Path(..., alias='payeeId')):
"""
Delete Payee by Id
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.get(
'/v3/payees/{payeeId}',
description=""" <p>Use v4 instead</p>
<p>Get Payee by Id</p>
""",
tags=['payee_operations'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def get_payee_by_id_v3(
payee_id: UUID = Path(..., alias='payeeId'), sensitive: Optional[bool] = None
):
"""
Get Payee by Id
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.post(
'/v3/payees/{payeeId}/invite',
description=""" <p>Use v4 instead</p>
<p>Resend an invite to the Payee The payee must have already been invited by the payor and not yet accepted or declined</p>
<p>Any previous invites to the payee by this Payor will be invalidated</p>
""",
tags=['payee_operations'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def resend_payee_invite_v3(
payee_id: UUID = Path(..., alias='payeeId'), body: InvitePayeeRequestV3 = ...
):
"""
Resend Payee Invite
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.post(
'/v3/payees/{payeeId}/payeeDetailsUpdate',
description=""" <p>Use v4 instead</p>
<p>Update payee details for the given Payee Id.<p>
""",
tags=['payee_operations'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def payee_details_update_v3(
payee_id: UUID = Path(..., alias='payeeId'), body: UpdatePayeeDetailsRequestV3 = ...
):
"""
Update Payee Details
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.post(
'/v3/payees/{payeeId}/remoteIdUpdate',
description=""" <p>Use v4 instead</p>
<p>Update the remote Id for the given Payee Id.</p>
""",
tags=['payee_operations'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def post_v3_payees__payee_id_remote_id_update(
payee_id: UUID = Path(..., alias='payeeId'), body: UpdateRemoteIdRequestV3 = ...
):
"""
Update Payee Remote Id
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.get(
'/v3/paymentaudit/payments',
description=""" Deprecated (use /v4/paymentaudit/payments instead) """,
tags=['payment_management', 'payment_tracking'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def list_payments_audit_v3(
payee_id: Optional[UUID] = Query(None, alias='payeeId'),
payor_id: Optional[UUID] = Query(None, alias='payorId'),
payor_name: Optional[str] = Query(None, alias='payorName'),
remote_id: Optional[str] = Query(None, alias='remoteId'),
status: Optional[Status1] = None,
source_account_name: Optional[str] = Query(None, alias='sourceAccountName'),
source_amount_from: Optional[int] = Query(None, alias='sourceAmountFrom'),
source_amount_to: Optional[int] = Query(None, alias='sourceAmountTo'),
source_currency: Optional[str] = Query(None, alias='sourceCurrency'),
payment_amount_from: Optional[int] = Query(None, alias='paymentAmountFrom'),
payment_amount_to: Optional[int] = Query(None, alias='paymentAmountTo'),
payment_currency: Optional[str] = Query(None, alias='paymentCurrency'),
submitted_date_from: Optional[date] = Query(None, alias='submittedDateFrom'),
submitted_date_to: Optional[date] = Query(None, alias='submittedDateTo'),
payment_memo: Optional[str] = Query(None, alias='paymentMemo'),
page: Optional[int] = 1,
page_size: Optional[conint(ge=1, le=100)] = Query(25, alias='pageSize'),
sort: Optional[str] = None,
sensitive: Optional[bool] = None,
):
"""
V3 Get List of Payments
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.get(
'/v3/paymentaudit/payments/{paymentId}',
description=""" Deprecated (use /v4/paymentaudit/payments/<paymentId> instead) """,
tags=['payment_management', 'payment_tracking'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def get_payment_details_v3(
payment_id: UUID = Path(..., alias='paymentId'), sensitive: Optional[bool] = None
):
"""
V3 Get Payment
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.get(
'/v3/paymentaudit/payouts',
description=""" Deprecated (use /v4/paymentaudit/payouts instead) """,
tags=[
'funding_operations',
'payor_operations',
'payout_operations',
'payout_management',
],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def get_payouts_for_payor_v3(
payor_id: UUID = Query(..., alias='payorId'),
payout_memo: Optional[str] = Query(None, alias='payoutMemo'),
status: Optional[Status3] = None,
submitted_date_from: Optional[date] = Query(None, alias='submittedDateFrom'),
submitted_date_to: Optional[date] = Query(None, alias='submittedDateTo'),
page: Optional[int] = 1,
page_size: Optional[conint(ge=1, le=100)] = Query(25, alias='pageSize'),
sort: Optional[str] = None,
):
"""
V3 Get Payouts for Payor
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.get(
'/v3/paymentaudit/payouts/{payoutId}',
description=""" Deprecated (use /v4/paymentaudit/payouts/<payoutId> instead) """,
tags=[
'payment_management',
'payout_management',
'payment_tracking',
'payment_audit_management',
],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def get_payments_for_payout__p_a__v3(
payout_id: UUID = Path(..., alias='payoutId'),
remote_id: Optional[str] = Query(None, alias='remoteId'),
status: Optional[Status5] = None,
source_amount_from: Optional[int] = Query(None, alias='sourceAmountFrom'),
source_amount_to: Optional[int] = Query(None, alias='sourceAmountTo'),
payment_amount_from: Optional[int] = Query(None, alias='paymentAmountFrom'),
payment_amount_to: Optional[int] = Query(None, alias='paymentAmountTo'),
submitted_date_from: Optional[date] = Query(None, alias='submittedDateFrom'),
submitted_date_to: Optional[date] = Query(None, alias='submittedDateTo'),
page: Optional[int] = 1,
page_size: Optional[conint(ge=1, le=100)] = Query(25, alias='pageSize'),
sort: Optional[str] = None,
sensitive: Optional[bool] = None,
):
"""
V3 Get Payments for Payout
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.get(
'/v3/paymentaudit/transactions',
description=""" Deprecated (use /v4/paymentaudit/transactions instead) """,
tags=['funding_operations', 'transaction_data_export'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def export_transactions_c_s_v_v3(
payor_id: Optional[UUID] = Query(None, alias='payorId'),
start_date: Optional[date] = Query(None, alias='startDate'),
end_date: Optional[date] = Query(None, alias='endDate'),
):
"""
V3 Export Transactions
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.post(
'/v3/payouts',
description=""" <p>Create a new payout and return a location header with a link to the payout</p>
<p>Basic validation of the payout is performed before returning but more comprehensive validation is done asynchronously</p>
<p>The results can be obtained by issuing a HTTP GET to the URL returned in the location header</p>
<p>**NOTE:** amount values in payments must be in 'minor units' format. E.g. cents for USD, pence for GBP etc with no decimal places</p>
""",
tags=['payout_operations', 'payout_management'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def submit_payout_v3(body: CreatePayoutRequestV3):
"""
Submit Payout
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.delete(
'/v3/payouts/{payoutId}',
description=""" Withdraw Payout will remove the payout details from the rails but the payout will still be accessible in payout service in WITHDRAWN status. """,
tags=['payout_operations', 'payout_management'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def withdraw_payout_v3(payout_id: UUID = Path(..., alias='payoutId')):
"""
Withdraw Payout
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.get(
'/v3/payouts/{payoutId}',
description=""" Get payout summary - returns the current state of the payout. """,
tags=['payout_operations', 'payout_management'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def get_payout_summary_v3(payout_id: UUID = Path(..., alias='payoutId')):
"""
Get Payout Summary
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.post(
'/v3/payouts/{payoutId}',
description=""" Instruct a payout to be made for the specified payoutId. """,
tags=['payout_operations', 'payout_management'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def instruct_payout_v3(
payout_id: UUID = Path(..., alias='payoutId'), body: InstructPayoutRequestV3 = None
):
"""
Instruct Payout
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.get(
'/v3/payouts/{payoutId}/payments',
description=""" Retrieve payments for a payout """,
tags=[
'payment_management',
'payout_management',
'payout_operations',
'payment_audit_management',
],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def get_payments_for_payout_v3(
payout_id: UUID = Path(..., alias='payoutId'),
status: Optional[Status7] = None,
remote_id: Optional[str] = Query(None, alias='remoteId'),
payor_payment_id: Optional[str] = Query(None, alias='payorPaymentId'),
source_account_name: Optional[str] = Query(None, alias='sourceAccountName'),
transmission_type: Optional[TransmissionType1] = Query(
None, alias='transmissionType'
),
payment_memo: Optional[str] = Query(None, alias='paymentMemo'),
page_size: Optional[conint(ge=1, le=100)] = Query(25, alias='pageSize'),
page: Optional[int] = 1,
):
"""
Retrieve payments for a payout
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.post(
'/v3/payouts/{payoutId}/quote',
description=""" Create quote for a payout """,
tags=['payout_operations', 'payout_management'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def create_quote_for_payout_v3(payout_id: UUID = Path(..., alias='payoutId')):
"""
Create a quote for the payout
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.delete(
'/v3/payouts/{payoutId}/schedule',
description=""" Remove the schedule for a scheduled payout """,
tags=['payout_operations', 'payout_management'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def deschedule_payout(payout_id: UUID = Path(..., alias='payoutId')):
"""
Deschedule a payout
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.post(
'/v3/payouts/{payoutId}/schedule',
description=""" <p>Schedule a payout for auto-instruction in the future
or update existing payout schedule if the payout has been scheduled before.</p>
""",
tags=['payout_operations', 'payout_management'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def schedule_for_payout(
payout_id: UUID = Path(..., alias='payoutId'), body: SchedulePayoutRequestV3 = None
):
"""
Schedule a payout
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.get(
'/v3/sourceAccounts',
description=""" List source accounts. """,
tags=['source_account_management', 'source_account_operations'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def get_source_accounts_v3(
physical_account_name: Optional[str] = Query(None, alias='physicalAccountName'),
physical_account_id: Optional[UUID] = Query(None, alias='physicalAccountId'),
payor_id: Optional[UUID] = Query(None, alias='payorId'),
funding_account_id: Optional[UUID] = Query(None, alias='fundingAccountId'),
include_user_deleted: Optional[str] = Query(None, alias='includeUserDeleted'),
type: Optional[SourceAccountTypeV3] = None,
page: Optional[int] = 1,
page_size: Optional[conint(ge=1, le=100)] = Query(25, alias='pageSize'),
sort: Optional[
constr(pattern=r'[fundingRef|name|balance]+[:desc|:asc]')
] = 'fundingRef:asc',
):
"""
Get list of source accounts
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.delete(
'/v3/sourceAccounts/{sourceAccountId}',
description=""" Mark a source account as deleted by ID """,
tags=['source_account_management', 'source_account_operations'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def delete_source_account_v3(
source_account_id: UUID = Path(..., alias='sourceAccountId')
):
"""
Delete a source account by ID
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.get(
'/v3/sourceAccounts/{sourceAccountId}',
description=""" Get details about given source account. """,
tags=['source_account_management', 'source_account_operations'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def get_source_account_v3(source_account_id: UUID = Path(..., alias='sourceAccountId')):
"""
Get details about given source account.
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.post(
'/v3/sourceAccounts/{sourceAccountId}/fundingRequest',
description=""" <p>Instruct a funding request to transfer funds from the payor’s funding bank to the payor’s balance held within Velo</p>
""",
tags=[
'funding_operations',
'source_account_operations',
'source_account_management',
],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def create_funding_request_v3(
source_account_id: UUID = Path(..., alias='sourceAccountId'),
body: FundingRequestV3 = ...,
):
"""
Create Funding Request
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.post(
'/v3/sourceAccounts/{sourceAccountId}/notifications',
description=""" <p>Set notifications for a given source account</p>
<p>If the balance falls below the amount set in the request an email notification will be sent to the email address registered in the payor profile</p>
""",
tags=['notification_settings'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def set_notifications_request_v3(
source_account_id: UUID = Path(..., alias='sourceAccountId'),
body: SetNotificationsRequest2 = ...,
):
"""
Set notifications
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.post(
'/v3/sourceAccounts/{sourceAccountId}/transfers',
description=""" Transfer funds between source accounts for a Payor. The 'from' source account is identified in the URL, and is the account which will be debited. The 'to' (destination) source account is in the body, and is the account which will be credited. Both source accounts must belong to the same Payor. There must be sufficient balance in the 'from' source account, otherwise the transfer attempt will fail. """,
tags=[
'funding_operations',
'source_account_operations',
'source_account_management',
],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def transfer_funds_v3(
source_account_id: UUID = Path(..., alias='sourceAccountId'),
body: TransferRequestV3 = ...,
):
"""
Transfer Funds between source accounts
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.get(
'/v4/payees',
description=""" Get a paginated response listing the payees for a payor. """,
tags=['payee_operations', 'payor_operations'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def list_payees_v4(
payor_id: UUID = Query(..., alias='payorId'),
watchlist_status: Optional[WatchlistStatusV3] = Query(
None, alias='watchlistStatus'
),
disabled: Optional[bool] = None,
onboarded_status: Optional[OnboardedStatusV4] = Query(
None, alias='onboardedStatus'
),
email: Optional[EmailStr] = None,
display_name: Optional[str] = Query(None, alias='displayName'),
remote_id: Optional[str] = Query(None, alias='remoteId'),
payee_type: Optional[PayeeType2] = Query(None, alias='payeeType'),
payee_country: Optional[str] = Query(None, alias='payeeCountry'),
ofac_status: Optional[OfacStatusV4] = Query(None, alias='ofacStatus'),
page: Optional[int] = 1,
page_size: Optional[int] = Query(25, alias='pageSize'),
sort: Optional[constr(pattern=r'[a-zA-Z]+[:desc|:asc]')] = 'displayName:asc',
):
"""
List Payees
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.post(
'/v4/payees',
description=""" <p>Initiate the process of creating 1 to 2000 payees in a batch</p>
<p>Use the batchId in the response to query for status.</p>
<p>In addition to standard semantic validations, a 400 will also result if: </p>
<ul>
<li>there is a duplicate remote id within the batch</li>
<li>there is a duplicate email within the batch, i.e. if there is a conflict between the data provided for one payee within the batch and
that provided for another payee within the same batch).</li>
</ul>
<p>The validation at this stage is intra-batch only.</p>
<p>Validation against payees who have already been invited occurs subsequently during processing of the batch.</p>
""",
tags=['payee_operations'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def v4_create_payee(body: CreatePayeesRequestV4 = None):
"""
Initiate Payee Creation
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.get(
'/v4/payees/batch/{batchId}',
description=""" Fetch the status of a specific batch of payees. The batch is fully processed when status is ACCEPTED and pendingCount is 0 ( 200 - OK, 404 - batch not found ).
""",
tags=['batch_query_operations', 'batch_processing_operations'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def query_batch_status_v4(batch_id: UUID = Path(..., alias='batchId')):
"""
Query Batch Status
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.get(
'/v4/payees/deltas',
description=""" Get a paginated response listing payee changes (updated since a particular time) to a limited set of fields:
- dbaName
- displayName
- email
- onboardedStatus
- payeeCountry
- payeeId
- remoteId
""",
tags=['payor_operations', 'payee_operations', 'payment_management'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def list_payee_changes_v4(
payor_id: UUID = Query(..., alias='payorId'),
updated_since: datetime = Query(..., alias='updatedSince'),
page: Optional[int] = 1,
page_size: Optional[int] = Query(100, alias='pageSize'),
):
"""
List Payee Changes
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.get(
'/v4/payees/payors/{payorId}/invitationStatus',
description=""" Returns a filtered, paginated list of payees associated with a payor, along with invitation status and grace period end date.
""",
tags=['payee_operations', 'payor_operations'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def get_payees_invitation_status_v4(
payor_id: UUID = Path(..., alias='payorId'),
payee_id: Optional[UUID] = Query(None, alias='payeeId'),
invitation_status: Optional[InvitationStatusV4] = Query(
None, alias='invitationStatus'
),
page: Optional[int] = 1,
page_size: Optional[int] = Query(25, alias='pageSize'),
):
"""
Get Payee Invitation Status
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.delete(
'/v4/payees/{payeeId}',
description=""" <p>This API will delete Payee by Id (UUID). Deletion by ID is not allowed if:</p>
<p>* Payee ID is not found</p>
<p>* If Payee has not been on-boarded</p>
<p>* If Payee is in grace period</p>
<p>* If Payee has existing payments</p>
""",
tags=['payee_operations'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def delete_payee_by_id_v4(payee_id: UUID = Path(..., alias='payeeId')):
"""
Delete Payee by Id
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.get(
'/v4/payees/{payeeId}',
description=""" Get Payee by Id """,
tags=['payee_operations', 'payment_management'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def get_payee_by_id_v4(
payee_id: UUID = Path(..., alias='payeeId'), sensitive: Optional[bool] = None
):
"""
Get Payee by Id
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.post(
'/v4/payees/{payeeId}/invite',
description=""" <p>Resend an invite to the Payee The payee must have already been invited by the payor and not yet accepted or declined</p>
<p>Any previous invites to the payee by this Payor will be invalidated</p>
""",
tags=['payee_operations'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def resend_payee_invite_v4(
payee_id: UUID = Path(..., alias='payeeId'), body: InvitePayeeRequestV4 = ...
):
"""
Resend Payee Invite
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.post(
'/v4/payees/{payeeId}/payeeDetailsUpdate',
description=""" <p>Update payee details for the given Payee Id.</p>
<p>Payors may only update the payee details if the payee has not yet onboarded</p>
""",
tags=['payee_operations', 'user_profile_management'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def payee_details_update_v4(
payee_id: UUID = Path(..., alias='payeeId'), body: UpdatePayeeDetailsRequestV4 = ...
):
"""
Update Payee Details
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.post(
'/v4/payees/{payeeId}/remoteIdUpdate',
description=""" <p>Update the remote Id for the given Payee Id.</p>
""",
tags=['payee_operations'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def post_v4_payees__payee_id_remote_id_update(
payee_id: UUID = Path(..., alias='payeeId'), body: UpdateRemoteIdRequestV4 = ...
):
"""
Update Payee Remote Id
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.get(
'/v4/paymentaudit/fundings',
description=""" <p>Get a list of Fundings for a payor.</p>
""",
tags=['funding_operations', 'payor_operations', 'source_account_management'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def get_fundings_v4(
payor_id: UUID = Query(..., alias='payorId'),
source_account_name: Optional[str] = Query(None, alias='sourceAccountName'),
page: Optional[int] = 1,
page_size: Optional[conint(ge=1, le=100)] = Query(25, alias='pageSize'),
sort: Optional[str] = None,
):
"""
Get Fundings for Payor
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.get(
'/v4/paymentaudit/payments',
description=""" Get payments for the given payor Id """,
tags=['payment_management', 'payment_tracking', 'funding_operations'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def list_payments_audit_v4(
payee_id: Optional[UUID] = Query(None, alias='payeeId'),
payor_id: Optional[UUID] = Query(None, alias='payorId'),
payor_name: Optional[str] = Query(None, alias='payorName'),
remote_id: Optional[str] = Query(None, alias='remoteId'),
remote_system_id: Optional[str] = Query(None, alias='remoteSystemId'),
status: Optional[Status9] = None,
transmission_type: Optional[TransmissionType3] = Query(
None, alias='transmissionType'
),
source_account_name: Optional[str] = Query(None, alias='sourceAccountName'),
source_amount_from: Optional[int] = Query(None, alias='sourceAmountFrom'),
source_amount_to: Optional[int] = Query(None, alias='sourceAmountTo'),
source_currency: Optional[str] = Query(None, alias='sourceCurrency'),
payment_amount_from: Optional[int] = Query(None, alias='paymentAmountFrom'),
payment_amount_to: Optional[int] = Query(None, alias='paymentAmountTo'),
payment_currency: Optional[str] = Query(None, alias='paymentCurrency'),
submitted_date_from: Optional[date] = Query(None, alias='submittedDateFrom'),
submitted_date_to: Optional[date] = Query(None, alias='submittedDateTo'),
payment_memo: Optional[str] = Query(None, alias='paymentMemo'),
rails_id: Optional[str] = Query(None, alias='railsId'),
scheduled_for_date_from: Optional[date] = Query(None, alias='scheduledForDateFrom'),
scheduled_for_date_to: Optional[date] = Query(None, alias='scheduledForDateTo'),
schedule_status: Optional[ScheduleStatus1] = Query(None, alias='scheduleStatus'),
post_instruct_fx_status: Optional[PostInstructFxStatus1] = Query(
None, alias='postInstructFxStatus'
),
page: Optional[int] = 1,
page_size: Optional[conint(ge=1, le=100)] = Query(25, alias='pageSize'),
sort: Optional[str] = None,
sensitive: Optional[bool] = None,
):
"""
Get List of Payments
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.get(
'/v4/paymentaudit/payments/{paymentId}',
description=""" Get the payment with the given id. This contains the payment history.
""",
tags=['payment_management', 'payment_tracking', 'payment_audit_management'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def get_payment_details_v4(
payment_id: UUID = Path(..., alias='paymentId'), sensitive: Optional[bool] = None
):
"""
Get Payment
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.get(
'/v4/paymentaudit/payoutStatistics',
description=""" <p>Get payout statistics for a payor.</p>
""",
tags=['payout_management', 'payout_operations'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def get_payout_stats_v4(payor_id: Optional[UUID] = Query(None, alias='payorId')):
"""
Get Payout Statistics
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.get(
'/v4/paymentaudit/payouts',
description=""" Get List of payouts for payor
""",
tags=[
'funding_operations',
'payor_operations',
'payout_operations',
'payout_management',
],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def get_payouts_for_payor_v4(
payor_id: Optional[UUID] = Query(None, alias='payorId'),
payout_memo: Optional[str] = Query(None, alias='payoutMemo'),
status: Optional[Status11] = None,
submitted_date_from: Optional[date] = Query(None, alias='submittedDateFrom'),
submitted_date_to: Optional[date] = Query(None, alias='submittedDateTo'),
from_payor_name: Optional[str] = Query(None, alias='fromPayorName'),
scheduled_for_date_from: Optional[date] = Query(None, alias='scheduledForDateFrom'),
scheduled_for_date_to: Optional[date] = Query(None, alias='scheduledForDateTo'),
schedule_status: Optional[ScheduleStatus1] = Query(None, alias='scheduleStatus'),
page: Optional[int] = 1,
page_size: Optional[conint(ge=1, le=100)] = Query(25, alias='pageSize'),
sort: Optional[str] = None,
):
"""
Get Payouts for Payor
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.get(
'/v4/paymentaudit/payouts/{payoutId}',
description=""" Get List of payments for Payout, allowing for RETURNED status
""",
tags=['payment_management', 'payout_management', 'payment_audit_management'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def get_payments_for_payout_v4(
payout_id: UUID = Path(..., alias='payoutId'),
remote_id: Optional[str] = Query(None, alias='remoteId'),
remote_system_id: Optional[str] = Query(None, alias='remoteSystemId'),
status: Optional[Status13] = None,
source_amount_from: Optional[int] = Query(None, alias='sourceAmountFrom'),
source_amount_to: Optional[int] = Query(None, alias='sourceAmountTo'),
payment_amount_from: Optional[int] = Query(None, alias='paymentAmountFrom'),
payment_amount_to: Optional[int] = Query(None, alias='paymentAmountTo'),
submitted_date_from: Optional[date] = Query(None, alias='submittedDateFrom'),
submitted_date_to: Optional[date] = Query(None, alias='submittedDateTo'),
transmission_type: Optional[TransmissionType3] = Query(
None, alias='transmissionType'
),
page: Optional[int] = 1,
page_size: Optional[conint(ge=1, le=100)] = Query(25, alias='pageSize'),
sort: Optional[str] = None,
sensitive: Optional[bool] = None,
):
"""
Get Payments for Payout
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.get(
'/v4/paymentaudit/transactions',
description=""" Download a CSV file containing payments in a date range. Uses Transfer-Encoding - chunked to stream to the client. Date range is inclusive of both the start and end dates. """,
tags=['funding_operations', 'transaction_data_export'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def export_transactions_c_s_v_v4(
payor_id: Optional[UUID] = Query(None, alias='payorId'),
start_date: Optional[date] = Query(None, alias='startDate'),
end_date: Optional[date] = Query(None, alias='endDate'),
include: Optional[Include] = None,
):
"""
Export Transactions
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
@app.get(
'/v4/payments/deltas',
description=""" Get a paginated response listing payment changes. """,
tags=['payment_tracking', 'payment_management', 'payor_operations'],
security=[
UnsuportedSecurityStub(name="None"),
],
)
def list_payment_changes_v4(
payor_id: UUID = Query(..., alias='payorId'),
updated_since: datetime = Query(..., alias='updatedSince'),
page: Optional[int] = 1,
page_size: Optional[conint(ge=1, le=1000)] = Query(100, alias='pageSize'),
):
"""
List Payment Changes
"""
raise RuntimeError("Should be patched by MCPProxy and never executed")
if __name__ == "__main__":
parser = argparse.ArgumentParser(description="MCP Server")
parser.add_argument(
"transport",
choices=["stdio", "sse", "streamable-http"],
help="Transport mode (stdio, sse or streamable-http)",
)
args = parser.parse_args()
if "CONFIG_PATH" in os.environ:
config_path = os.environ["CONFIG_PATH"]
app.load_configuration(config_path)
if "CONFIG" in os.environ:
config = os.environ["CONFIG"]
app.load_configuration_from_string(config)
if "SECURITY" in os.environ:
security_params = BaseSecurity.parse_security_parameters_from_env(
os.environ,
)
app.set_security_params(security_params)
mcp_settings = json.loads(os.environ.get("MCP_SETTINGS", "{}"))
app.get_mcp(**mcp_settings).run(transport=args.transport)