{"files":{"SKILL.md":"---\nname: velo-payments-apis\ndescription: \"Velo Payments APIs API skill. Use when working with Velo Payments APIs for authenticate, logout, password. Covers 109 endpoints.\"\nversion: 1.0.0\ngenerator: lapsh\n---\n\n# Velo Payments APIs\nAPI version: 2.38.183\n\n## Auth\nOAuth2 | Bearer basic | OAuth2\n\n## Base URL\nhttps://api.sandbox.velopayments.com/\n\n## Setup\n1. Set Authorization header with Bearer token\n2. GET /v2/users -- list users\n3. POST /v1/authenticate -- create first authenticate\n\n## Endpoints\n109 endpoints across 20 groups. See references/api-spec.lap for full details.\n\n### Authenticate\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /v1/authenticate | Authentication endpoint |\n\n### Logout\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /v1/logout | Logout |\n\n### Password\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /v1/password/reset | Reset password |\n\n### Validate\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /v1/validate | validate |\n\n### Users\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /v2/users | List Users |\n| DELETE | /v2/users/{userId} | Delete a User |\n| GET | /v2/users/{userId} | Get User |\n| POST | /v2/users/{userId}/disable | Disable a User |\n| POST | /v2/users/{userId}/enable | Enable a User |\n| POST | /v2/users/invite | Invite a User |\n| POST | /v2/users/{userId}/roleUpdate | Update User Role |\n| POST | /v2/users/{userId}/mfa/unregister | Unregister MFA for the user |\n| POST | /v2/users/{userId}/tokens | Resend a token |\n| POST | /v2/users/{userId}/unlock | Unlock a User |\n| POST | /v2/users/{userId}/userDetailsUpdate | Update User Details |\n| POST | /v2/users/registration/sms | Register SMS Number |\n| GET | /v2/users/self | Get Self |\n| POST | /v2/users/self/userDetailsUpdate | Update User Details for self |\n| POST | /v2/users/self/mfa/unregister | Unregister MFA for Self |\n| POST | /v2/users/self/password | Update Password for self |\n| POST | /v2/users/self/password/validate | Validate the proposed password |\n\n### Payors\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /v2/payors/{payorId} | Get Payor |\n| POST | /v1/payors/{payorId}/applications | Create Application |\n| POST | /v1/payors/{payorId}/applications/{applicationId}/keys | Create API Key |\n| POST | /v1/payors/{payorId}/reminderEmailsUpdate | Reminder Email Opt-Out |\n| POST | /v1/payors/{payorId}/branding/logos | Add Logo |\n| GET | /v1/payors/{payorId}/branding | Get Branding |\n\n### PayorLinks\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /v1/payorLinks | List Payor Links |\n| POST | /v1/payorLinks | Create a Payor Link |\n\n### Payees\n| Method | Path | Description |\n|--------|------|-------------|\n| DELETE | /v3/payees/{payeeId} | Delete Payee by Id |\n| GET | /v3/payees/{payeeId} | Get Payee by Id |\n| GET | /v3/payees | List Payees |\n| POST | /v3/payees | Initiate Payee Creation |\n| GET | /v3/payees/batch/{batchId} | Query Batch Status |\n| POST | /v3/payees/{payeeId}/invite | Resend Payee Invite |\n| GET | /v3/payees/payors/{payorId}/invitationStatus | Get Payee Invitation Status |\n| GET | /v3/payees/deltas | List Payee Changes |\n| POST | /v3/payees/{payeeId}/remoteIdUpdate | Update Payee Remote Id |\n| POST | /v3/payees/{payeeId}/payeeDetailsUpdate | Update Payee Details |\n| DELETE | /v4/payees/{payeeId} | Delete Payee by Id |\n| GET | /v4/payees/{payeeId} | Get Payee by Id |\n| POST | /v4/payees/{payeeId}/payeeDetailsUpdate | Update Payee Details |\n| POST | /v4/payees/{payeeId}/remoteIdUpdate | Update Payee Remote Id |\n| GET | /v4/payees | List Payees |\n| POST | /v4/payees | Initiate Payee Creation |\n| GET | /v4/payees/batch/{batchId} | Query Batch Status |\n| POST | /v4/payees/{payeeId}/invite | Resend Payee Invite |\n| GET | /v4/payees/payors/{payorId}/invitationStatus | Get Payee Invitation Status |\n| GET | /v4/payees/deltas | List Payee Changes |\n| GET | /v4/payees/{payeeId}/paymentChannels/ | Get All Payment Channels Details |\n| POST | /v4/payees/{payeeId}/paymentChannels/ | Create Payment Channel |\n| DELETE | /v4/payees/{payeeId}/paymentChannels/{paymentChannelId} | Delete Payment Channel |\n| GET | /v4/payees/{payeeId}/paymentChannels/{paymentChannelId} | Get Payment Channel Details |\n| POST | /v4/payees/{payeeId}/paymentChannels/{paymentChannelId} | Update Payment Channel |\n| POST | /v4/payees/{payeeId}/paymentChannels/{paymentChannelId}/enable | Enable Payment Channel |\n| PUT | /v4/payees/{payeeId}/paymentChannels/order | Update Payees preferred Payment Channel order |\n\n### SourceAccounts\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /v1/sourceAccounts/{sourceAccountId}/notifications | Set notifications |\n| POST | /v2/sourceAccounts/{sourceAccountId}/fundingRequest | Create Funding Request |\n| GET | /v2/sourceAccounts | Get list of source accounts |\n| GET | /v2/sourceAccounts/{sourceAccountId} | Get Source Account |\n| POST | /v2/sourceAccounts/{sourceAccountId}/transfers | Transfer Funds between source accounts |\n| POST | /v3/sourceAccounts/{sourceAccountId}/fundingRequest | Create Funding Request |\n| GET | /v3/sourceAccounts | Get list of source accounts |\n| DELETE | /v3/sourceAccounts/{sourceAccountId} | Delete a source account by ID |\n| GET | /v3/sourceAccounts/{sourceAccountId} | Get details about given source account. |\n| POST | /v3/sourceAccounts/{sourceAccountId}/transfers | Transfer Funds between source accounts |\n| POST | /v3/sourceAccounts/{sourceAccountId}/notifications | Set notifications |\n\n### FundingAccounts\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /v2/fundingAccounts | Get Funding Accounts |\n| POST | /v2/fundingAccounts | Create Funding Account |\n| GET | /v2/fundingAccounts/{fundingAccountId} | Get Funding Account |\n\n### Deltas\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /v1/deltas/fundings | Get Funding Audit Delta |\n| GET | /v1/deltas/payments | V1 List Payment Changes |\n\n### Fundings\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /v1/fundings/{fundingId} | Get Funding |\n\n### Transactions\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /v1/transactions | Get Transactions |\n| POST | /v1/transactions | Create a Transaction |\n| GET | /v1/transactions/{transactionId} | Get Transaction |\n\n### Paymentaudit\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /v1/paymentaudit/fundings | V1 Get Fundings for Payor |\n| GET | /v1/paymentaudit/payoutStatistics | V1 Get Payout Statistics |\n| GET | /v3/paymentaudit/payouts | V3 Get Payouts for Payor |\n| GET | /v3/paymentaudit/payouts/{payoutId} | V3 Get Payments for Payout |\n| GET | /v3/paymentaudit/payments | V3 Get List of Payments |\n| GET | /v3/paymentaudit/payments/{paymentId} | V3 Get Payment |\n| GET | /v3/paymentaudit/transactions | V3 Export Transactions |\n| GET | /v4/paymentaudit/payouts | Get Payouts for Payor |\n| GET | /v4/paymentaudit/payouts/{payoutId} | Get Payments for Payout |\n| GET | /v4/paymentaudit/payments | Get List of Payments |\n| GET | /v4/paymentaudit/payments/{paymentId} | Get Payment |\n| GET | /v4/paymentaudit/fundings | Get Fundings for Payor |\n| GET | /v4/paymentaudit/payoutStatistics | Get Payout Statistics |\n| GET | /v4/paymentaudit/transactions | Export Transactions |\n\n### Payments\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /v4/payments/deltas | List Payment Changes |\n| POST | /v1/payments/{paymentId}/withdraw | Withdraw a Payment |\n\n### Payouts\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /v3/payouts | Submit Payout |\n| DELETE | /v3/payouts/{payoutId} | Withdraw Payout |\n| GET | /v3/payouts/{payoutId} | Get Payout Summary |\n| POST | /v3/payouts/{payoutId} | Instruct Payout |\n| POST | /v3/payouts/{payoutId}/quote | Create a quote for the payout |\n| GET | /v3/payouts/{payoutId}/payments | Retrieve payments for a payout |\n| DELETE | /v3/payouts/{payoutId}/schedule | Deschedule a payout |\n| POST | /v3/payouts/{payoutId}/schedule | Schedule a payout |\n\n### PaymentChannelRules\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /v1/paymentChannelRules | List Payment Channel Country Rules |\n\n### SupportedCountries\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /v1/supportedCountries | List Supported Countries |\n| GET | /v2/supportedCountries | List Supported Countries |\n\n### Currencies\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /v2/currencies | List Supported Currencies |\n\n### Webhooks\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /v1/webhooks | List the details about the webhooks for the given payor. |\n| POST | /v1/webhooks | Create Webhook |\n| GET | /v1/webhooks/{webhookId} | Get details about the given webhook. |\n| POST | /v1/webhooks/{webhookId} | Update Webhook |\n| POST | /v1/webhooks/{webhookId}/ping |  |\n\n## Common Questions\nMatch user requests to endpoints in references/api-spec.lap. Key patterns:\n- \"Create a authenticate?\" -> POST /v1/authenticate\n- \"Create a logout?\" -> POST /v1/logout\n- \"Create a reset?\" -> POST /v1/password/reset\n- \"Create a validate?\" -> POST /v1/validate\n- \"List all users?\" -> GET /v2/users\n- \"Delete a user?\" -> DELETE /v2/users/{userId}\n- \"Get user details?\" -> GET /v2/users/{userId}\n- \"Create a disable?\" -> POST /v2/users/{userId}/disable\n- \"Create a enable?\" -> POST /v2/users/{userId}/enable\n- \"Create a invite?\" -> POST /v2/users/invite\n- \"Create a roleUpdate?\" -> POST /v2/users/{userId}/roleUpdate\n- \"Create a unregister?\" -> POST /v2/users/{userId}/mfa/unregister\n- \"Create a token?\" -> POST /v2/users/{userId}/tokens\n- \"Create a unlock?\" -> POST /v2/users/{userId}/unlock\n- \"Create a userDetailsUpdate?\" -> POST /v2/users/{userId}/userDetailsUpdate\n- \"Create a sm?\" -> POST /v2/users/registration/sms\n- \"List all self?\" -> GET /v2/users/self\n- \"Create a password?\" -> POST /v2/users/self/password\n- \"Get payor details?\" -> GET /v2/payors/{payorId}\n- \"Create a application?\" -> POST /v1/payors/{payorId}/applications\n- \"Create a key?\" -> POST /v1/payors/{payorId}/applications/{applicationId}/keys\n- \"Create a reminderEmailsUpdate?\" -> POST /v1/payors/{payorId}/reminderEmailsUpdate\n- \"Create a logo?\" -> POST /v1/payors/{payorId}/branding/logos\n- \"List all branding?\" -> GET /v1/payors/{payorId}/branding\n- \"List all payorLinks?\" -> GET /v1/payorLinks\n- \"Create a payorLink?\" -> POST /v1/payorLinks\n- \"Delete a payee?\" -> DELETE /v3/payees/{payeeId}\n- \"Get payee details?\" -> GET /v3/payees/{payeeId}\n- \"List all payees?\" -> GET /v3/payees\n- \"Create a payee?\" -> POST /v3/payees\n- \"Get batch details?\" -> GET /v3/payees/batch/{batchId}\n- \"List all invitationStatus?\" -> GET /v3/payees/payors/{payorId}/invitationStatus\n- \"List all deltas?\" -> GET /v3/payees/deltas\n- \"Create a remoteIdUpdate?\" -> POST /v3/payees/{payeeId}/remoteIdUpdate\n- \"Create a payeeDetailsUpdate?\" -> POST /v3/payees/{payeeId}/payeeDetailsUpdate\n- \"List all paymentChannels?\" -> GET /v4/payees/{payeeId}/paymentChannels/\n- \"Create a paymentChannel?\" -> POST /v4/payees/{payeeId}/paymentChannels/\n- \"Delete a paymentChannel?\" -> DELETE /v4/payees/{payeeId}/paymentChannels/{paymentChannelId}\n- \"Get paymentChannel details?\" -> GET /v4/payees/{payeeId}/paymentChannels/{paymentChannelId}\n- \"Create a notification?\" -> POST /v1/sourceAccounts/{sourceAccountId}/notifications\n- \"Create a fundingRequest?\" -> POST /v2/sourceAccounts/{sourceAccountId}/fundingRequest\n- \"List all sourceAccounts?\" -> GET /v2/sourceAccounts\n- \"Get sourceAccount details?\" -> GET /v2/sourceAccounts/{sourceAccountId}\n- \"Create a transfer?\" -> POST /v2/sourceAccounts/{sourceAccountId}/transfers\n- \"Delete a sourceAccount?\" -> DELETE /v3/sourceAccounts/{sourceAccountId}\n- \"List all fundingAccounts?\" -> GET /v2/fundingAccounts\n- \"Create a fundingAccount?\" -> POST /v2/fundingAccounts\n- \"Get fundingAccount details?\" -> GET /v2/fundingAccounts/{fundingAccountId}\n- \"List all fundings?\" -> GET /v1/deltas/fundings\n- \"Get funding details?\" -> GET /v1/fundings/{fundingId}\n- \"List all transactions?\" -> GET /v1/transactions\n- \"Create a transaction?\" -> POST /v1/transactions\n- \"Get transaction details?\" -> GET /v1/transactions/{transactionId}\n- \"List all payoutStatistics?\" -> GET /v1/paymentaudit/payoutStatistics\n- \"List all payments?\" -> GET /v1/deltas/payments\n- \"List all payouts?\" -> GET /v3/paymentaudit/payouts\n- \"Get payout details?\" -> GET /v3/paymentaudit/payouts/{payoutId}\n- \"Get payment details?\" -> GET /v3/paymentaudit/payments/{paymentId}\n- \"Create a payout?\" -> POST /v3/payouts\n- \"Delete a payout?\" -> DELETE /v3/payouts/{payoutId}\n- \"Create a quote?\" -> POST /v3/payouts/{payoutId}/quote\n- \"Create a schedule?\" -> POST /v3/payouts/{payoutId}/schedule\n- \"List all paymentChannelRules?\" -> GET /v1/paymentChannelRules\n- \"Create a withdraw?\" -> POST /v1/payments/{paymentId}/withdraw\n- \"List all supportedCountries?\" -> GET /v1/supportedCountries\n- \"List all currencies?\" -> GET /v2/currencies\n- \"List all webhooks?\" -> GET /v1/webhooks\n- \"Create a webhook?\" -> POST /v1/webhooks\n- \"Get webhook details?\" -> GET /v1/webhooks/{webhookId}\n- \"Create a ping?\" -> POST /v1/webhooks/{webhookId}/ping\n- \"How to authenticate?\" -> See Auth section above\n\n## Response Tips\n- Check response schemas in references/api-spec.lap for field details\n- Paginated endpoints accept limit/offset or cursor parameters\n- Create/update endpoints return the modified resource on success\n- Error responses include status codes and descriptions in the spec\n\n## References\n- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas\n\n> Generated from the official API spec by [LAP](https://lap.sh)\n","references/api-spec.lap":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Velo Payments APIs\n@base https://api.sandbox.velopayments.com/\n@version 2.38.183\n@auth OAuth2 | Bearer basic | OAuth2\n@endpoints 109\n@hint download_for_search\n@toc authenticate(1), logout(1), password(1), validate(1), users(17), payors(6), payorLinks(2), payees(27), sourceAccounts(11), fundingAccounts(3), deltas(2), fundings(1), transactions(3), paymentaudit(14), payments(2), payouts(8), paymentChannelRules(1), supportedCountries(2), currencies(1), webhooks(5)\n\n@group authenticate\n@endpoint POST /v1/authenticate\n@desc Authentication endpoint\n@optional {grant_type: str=client_credentials # OAuth grant type. Should use 'client_credentials'}\n@returns(200) {access_token: str, token_type: str, expires_in: num, refresh_token: str, scope: str, entityIds: [str]} # Valid Authenication response\n\n@endgroup\n\n@group logout\n@endpoint POST /v1/logout\n@desc Logout\n@returns(204) User has been logged out\n@errors {401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions}\n\n@endgroup\n\n@group password\n@endpoint POST /v1/password/reset\n@desc Reset password\n@required {email: str(email) # the email address of the user requesting the reset password}\n@returns(204) the request was accepted\n@errors {400: Invalid request. See Error message payload for details of failure}\n\n@endgroup\n\n@group validate\n@endpoint POST /v1/validate\n@desc validate\n@required {otp: str # an OTP either sent via sms or generated by a registered MFA device}\n@optional {Authorization: str # Bearer token authorization leg of validate}\n@returns(200) {access_token: str, token_type: str, refresh_token: str, expires_in: int, scope: str, user_info: map{user_id: str(uuid), userType: str, mfa_details: map{mfa_type: str?, verified: bool}}, entityIds: [str]} # User request has been validated\n@errors {401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions}\n\n@endgroup\n\n@group users\n@endpoint GET /v2/users\n@desc List Users\n@optional {type: str # The Type of the User., status: str # The status of the User., entityId: str(uuid) # The entityId of the User., payeeType: str # The Type of the Payee entity. Either COMPANY or INDIVIDUAL., page: int(int32)=1 # Page number. Default is 1., pageSize: int(int32)=25 # The number of results to return in a page, sort: str=email:asc # List of sort fields (e.g. ?sort=email:asc,lastName:asc) Default is email:asc 'name' The supported sort fields are - email, lastNmae.}\n@returns(200) {page: any, links: [any], content: [map]} # Paginated list of Users filtered by query parameters\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions}\n\n@endpoint DELETE /v2/users/{userId}\n@desc Delete a User\n@required {userId: str(uuid) # The UUID of the User.}\n@returns(204) request completed okay\n@errors {401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endpoint GET /v2/users/{userId}\n@desc Get User\n@required {userId: str(uuid) # The UUID of the User.}\n@returns(200) {id: str(uuid), status: str, email: str(email), smsNumber: str, primaryContactNumber: str, secondaryContactNumber: str, firstName: str, lastName: str, entityId: str(uuid), companyName: str, roles: [map], userType: str, mfaType: str, mfaStatus: str, lockedOut: bool, lockedOutTimestamp: str(date-time)?} # Get User Details\n@errors {401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endpoint POST /v2/users/{userId}/disable\n@desc Disable a User\n@required {userId: str(uuid) # The UUID of the User.}\n@returns(204) Success the user was disabled or was already disabled\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endpoint POST /v2/users/{userId}/enable\n@desc Enable a User\n@required {userId: str(uuid) # The UUID of the User.}\n@returns(204) Success the user was enabled or was already enabled\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endpoint POST /v2/users/invite\n@desc Invite a User\n@required {email: str(email) # the email address of the invited user, mfaType: str(SMS/YUBIKEY/TOTP) # The MFA type that the user will use The type may be conditional on the role(s) the user has, smsNumber: str # The phone number of a device that the user can receive sms messages on, primaryContactNumber: str # The main contact number for the user, roles: [str] # The role(s) for the user The role must exist The role can be a custom role or a system role but the invoker must have the permissions to assign the role System roles are: velo.backoffice.admin, velo.payor.master_admin, velo.payor.admin, velo.payor.support, velo.payee.admin, velo.payee.support}\n@optional {secondaryContactNumber: str # The secondary contact number for the user, firstName: str, lastName: str, entityId: str(uuid) # The payorId or payeeId or null if the user is a backoffice admin, userType: str(BACKOFFICE/PAYOR/PAYEE) # Will default to PAYOR if not provided but entityId is provided, verificationCode: str # Optional property that MUST be suppied when manually verifying a user The user's smsNumber is registered via a separate endpoint and an OTP sent to them}\n@returns(204) No Content. The user was invited successfully\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 409: The request contained data that would result in a duplicate value, 412: The request could not be completed as a precondition was not met}\n\n@endpoint POST /v2/users/{userId}/roleUpdate\n@desc Update User Role\n@required {userId: str(uuid) # The UUID of the User., roles: [str] # The role(s) for the user The role must exist The role can be a custom role or a system role but the invoker must have the permissions to assign the role System roles are: backoffice.admin, payor.master_admin, payor.admin, payor.support}\n@optional {verificationCode: str # Optional property that MUST be suppied when manually verifying a user The user's smsNumber is registered via a separate endpoint and an OTP sent to them}\n@returns(204) request completed okay\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endpoint POST /v2/users/{userId}/mfa/unregister\n@desc Unregister MFA for the user\n@required {userId: str(uuid) # The UUID of the User., mfaType: str(YUBIKEY/TOTP) # The type of the MFA device}\n@optional {verificationCode: str # Optional property that MUST be suppied when manually verifying a user The user's smsNumber is registered via a separate endpoint and an OTP sent to them}\n@returns(204) the MFA Type to unregister\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endpoint POST /v2/users/{userId}/tokens\n@desc Resend a token\n@required {userId: str(uuid) # The UUID of the User., tokenType: str(INVITE_MFA_USER/MFA_REGISTRATION) # The type of the token to resend}\n@optional {verificationCode: str # Optional property that MUST be suppied when manually verifying a user The user's smsNumber is registered via a separate endpoint and an OTP sent to them}\n@returns(204) request completed okay\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions}\n\n@endpoint POST /v2/users/{userId}/unlock\n@desc Unlock a User\n@required {userId: str(uuid) # The UUID of the User.}\n@returns(204) Success the user was unlocked or was already unlocked\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endpoint POST /v2/users/{userId}/userDetailsUpdate\n@desc Update User Details\n@required {userId: str(uuid) # The UUID of the User.}\n@optional {primaryContactNumber: str # The main contact number for the user, secondaryContactNumber: str # The secondary contact number for the user, firstName: str, lastName: str, email: str(email) # the email address of the user, smsNumber: str # The phone number of a device that the user can receive sms messages on, mfaType: str(SMS/YUBIKEY/TOTP) # The type of the MFA device, verificationCode: str # Optional property that MUST be suppied when manually verifying a user The user's smsNumber is registered via a separate endpoint and an OTP sent to them}\n@returns(204) request completed okay\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available, 409: The request contained data that would result in a duplicate value}\n\n@endpoint POST /v2/users/registration/sms\n@desc Register SMS Number\n@required {smsNumber: str # The phone number of a device that the user can receive sms messages on}\n@returns(204) request completed okay\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions}\n\n@endpoint GET /v2/users/self\n@desc Get Self\n@returns(200) {id: str(uuid), status: str, email: str(email), smsNumber: str, primaryContactNumber: str, secondaryContactNumber: str, firstName: str, lastName: str, entityId: str(uuid), companyName: str, roles: [map], userType: str, mfaType: str, mfaStatus: str, lockedOut: bool, lockedOutTimestamp: str(date-time)?} # Get User Details\n@errors {401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions}\n\n@endpoint POST /v2/users/self/userDetailsUpdate\n@desc Update User Details for self\n@optional {primaryContactNumber: str # The main contact number for the user, secondaryContactNumber: str # The secondary contact number for the user, firstName: str, lastName: str, email: str(email) # the email address of the user, smsNumber: str # The phone number of a device that the user can receive sms messages on}\n@returns(204) request completed okay\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 409: The request contained data that would result in a duplicate value}\n\n@endpoint POST /v2/users/self/mfa/unregister\n@desc Unregister MFA for Self\n@required {mfaType: str(SMS/YUBIKEY/TOTP) # The type of the MFA device}\n@optional {Authorization: str # Bearer token authorization leg of validate}\n@returns(204) the MFA Type to unregister\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions}\n\n@endpoint POST /v2/users/self/password\n@desc Update Password for self\n@required {oldPassword: str # The user's current password, newPassword: str # The new password}\n@returns(204) the password was submitted and accepted\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions}\n\n@endpoint POST /v2/users/self/password/validate\n@desc Validate the proposed password\n@required {password: str # a password that passes validation}\n@returns(200) {score: int(int32), valid: bool, warning: str, suggestions: [str]} # the password was checked and a score returned\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions}\n\n@endgroup\n\n@group payors\n@endpoint GET /v2/payors/{payorId}\n@desc Get Payor\n@required {payorId: str(uuid) # The account owner Payor ID}\n@returns(200) {payorId: str(uuid), payorName: str, payorXid: str, provider: str, address: map{line1: str, line2: str, line3: str, line4: str, city: str, countyOrProvince: str, zipOrPostcode: str, country: str}, primaryContactName: str, primaryContactPhone: str, primaryContactEmail: str(email), kycState: str, manualLockout: bool, openBankingEnabled: bool, payeeGracePeriodProcessingEnabled: bool, payeeGracePeriodDays: int, collectiveAlias: str, supportContact: str, dbaName: str, allowsLanguageChoice: bool, reminderEmailsOptOut: bool, language: str, includesReports: bool, wuCustomerId: str, maxMasterPayorAdmins: int, paymentRails: str, remoteSystemIds: [str], usdTxnValueReportingThreshold: int, managingPayees: bool, createdAt: str(date-time)} # Get Payor Details\n@errors {400: Invalid request. See Error message payload for details of failure, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: Payor Id Not Found}\n\n@endpoint POST /v1/payors/{payorId}/applications\n@desc Create Application\n@required {payorId: str(uuid) # The account owner Payor ID, name: str # The name of the application.}\n@optional {description: str # Description of the application.}\n@returns(201) Success\n@errors {400: Invalid request. See Error message payload for details of failure, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available, 409: The request contained data that would result in a duplicate value}\n\n@endpoint POST /v1/payors/{payorId}/applications/{applicationId}/keys\n@desc Create API Key\n@required {payorId: str(uuid) # The account owner Payor ID, applicationId: str(uuid) # Application ID, name: str # A name for the key., roles: [str] # A role to assign to the key. If you want your API key to have write access then assign the role velo.payor.admin A later version will change this property from a list to string}\n@optional {description: str # Description of the key.}\n@returns(200) {apiKey: str(uuid), apiSecret: str(uuid)} # HTTP Ok, key created\n@errors {400: Invalid request. See Error message payload for details of failure, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endpoint POST /v1/payors/{payorId}/reminderEmailsUpdate\n@desc Reminder Email Opt-Out\n@required {payorId: str(uuid) # The account owner Payor ID, reminderEmailsOptOut: bool}\n@returns(202) HTTP Accepted\n@errors {400: Invalid request. See Error message payload for details of failure, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: Payor Id Not Found}\n\n@endpoint POST /v1/payors/{payorId}/branding/logos\n@desc Add Logo\n@required {payorId: str(uuid) # The account owner Payor ID}\n@returns(204) No Content\n@errors {400: Invalid request. See Error message payload for details of failure, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endpoint GET /v1/payors/{payorId}/branding\n@desc Get Branding\n@required {payorId: str(uuid) # The account owner Payor ID}\n@returns(200) {payorName: str, logoUrl: str(uri), collectiveAlias: str, supportContact: str, dbaName: str} # HTTP Ok, key created\n@errors {400: Invalid request. See Error message payload for details of failure, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: Payor Id Not Found}\n\n@endgroup\n\n@group payorLinks\n@endpoint GET /v1/payorLinks\n@desc List Payor Links\n@optional {descendantsOfPayor: str(uuid) # The Payor ID from which to start the query to show all descendants, parentOfPayor: str(uuid) # Query for the parent payor details for this payor id, fields: str # List of additional Payor fields to include in the response for each Payor The values of payorId and payorName are always included for each Payor by default You can add fields to the response for each payor by including them in the fields parameter separated by commas The supported fields are any combination of: primaryContactEmail,kycState}\n@returns(200) {links: [any], payors: [any]} # Details of Payor Links\n@errors {400: Invalid request. See Error message payload for details of failure, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endpoint POST /v1/payorLinks\n@desc Create a Payor Link\n@required {fromPayorId: str(uuid), linkType: str, toPayorId: str(uuid)}\n@returns(201) HTTP Creeated\n@errors {400: Invalid request. See Error message payload for details of failure, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endgroup\n\n@group payees\n@endpoint DELETE /v3/payees/{payeeId}\n@desc Delete Payee by Id\n@required {payeeId: str(uuid) # The UUID of the payee.}\n@returns(204) No content. Payee Id accepted for deletion.\n@errors {400: Invalid request. See Error message payload for details of failure, 404: Payee Id not found}\n\n@endpoint GET /v3/payees/{payeeId}\n@desc Get Payee by Id\n@required {payeeId: str(uuid) # The UUID of the payee.}\n@optional {sensitive: bool # Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values.}\n@returns(200) {payeeId: str(uuid), payorRefs: [map]?, email: str(email)?, onboardedStatus: str, watchlistStatus: str, watchlistOverrideExpiresAtTimestamp: str(date-time)?, watchlistOverrideComment: str, language: str, created: str(date-time), country: str, displayName: str, payeeType: str, disabled: bool, disabledComment: str, disabledUpdatedTimestamp: str(date-time), address: map{line1: str, line2: str?, line3: str?, line4: str?, city: str, countyOrProvince: str?, zipOrPostcode: str?, country: str}, individual: map{name: any, nationalIdentification: str, dateOfBirth: str}, company: map?{name: str, taxId: str?, operatingName: str?}, cellphoneNumber: str, watchlistStatusUpdatedTimestamp: str(date_time)?, gracePeriodEndDate: str(date)?, enhancedKycCompleted: bool, kycCompletedTimestamp: str(date_time)?, pausePayment: bool, pausePaymentTimestamp: str(date_time)?, marketingOptInDecision: bool, marketingOptInTimestamp: str(date_time)?, acceptTermsAndConditionsTimestamp: str(date-time)?, challenge: map{value: str, description: str}} # Success response, request completed okay\n@errors {404: The resource was not found or is no longer available}\n\n@endpoint GET /v3/payees\n@desc List Payees\n@required {payorId: str(uuid) # The account owner Payor ID}\n@optional {watchlistStatus: str # The watchlistStatus of the payees., disabled: bool # Payee disabled, onboardedStatus: str # The onboarded status of the payees., email: str(email) # Email address, displayName: str # The display name of the payees., remoteId: str # The remote id of the payees., payeeType: str # The onboarded status of the payees., payeeCountry: str # The country of the payee - 2 letter ISO 3166-1 country code (upper case), page: int(int32)=1 # Page number. Default is 1., pageSize: int(int32)=25 # Page size. Default is 25. Max allowable is 100., sort: str=displayName:asc # List of sort fields (e.g. ?sort=onboardedStatus:asc,name:asc) Default is name:asc 'name' is treated as company name for companies - last name + ',' + firstName for individuals The supported sort fields are - payeeId, displayName, payoutStatus, onboardedStatus.}\n@returns(200) {summary: any, page: any, links: [any], content: [map]} # Details of Payee\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endpoint POST /v3/payees\n@desc Initiate Payee Creation\n@required {payorId: str, payees: [map{payeeId: str(uuid), payorRefs: [map], email!: str(email), remoteId!: str, type!: str, address!: map, paymentChannel: map, challenge: map, language: str, company: map, individual: map}]}\n@returns(201) {batchId: str(uuid), rejectedCsvRows: [any]} # HTTP Created. Body created only on CSV requests\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endpoint GET /v3/payees/batch/{batchId}\n@desc Query Batch Status\n@required {batchId: str(uuid) # Batch Id}\n@returns(200) {status: str, failureCount: int(int64), pendingCount: int(int64), failures: [map]} # Get Batch Status\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endpoint POST /v3/payees/{payeeId}/invite\n@desc Resend Payee Invite\n@required {payeeId: str(uuid) # The UUID of the payee., payorId: str(uuid)}\n@returns(200) the request was accepted\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available, 409: The request contained data that would result in a duplicate value}\n\n@endpoint GET /v3/payees/payors/{payorId}/invitationStatus\n@desc Get Payee Invitation Status\n@required {payorId: str(uuid) # The account owner Payor ID}\n@optional {payeeId: str(uuid) # The UUID of the payee., invitationStatus: str # The invitation status of the payees., page: int(int32)=1 # Page number. Default is 1., pageSize: int(int32)=25 # Page size. Default is 25. Max allowable is 100.}\n@returns(200) {page: any, links: [any], content: [map]} # Get Payees with Invitaion status - filters of payeeId and invitationStatus\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endpoint GET /v3/payees/deltas\n@desc List Payee Changes\n@required {payorId: str(uuid) # The Payor ID to find associated Payees, updatedSince: str(date-time) # The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm}\n@optional {page: int(int32)=1 # Page number. Default is 1., pageSize: int(int32)=100 # Page size. Default is 100. Max allowable is 1000.}\n@returns(200) {page: any, links: [any], content: [map]} # Details of Payee Changes\n@errors {400: Invalid request. See Error message payload for details of failure}\n\n@endpoint POST /v3/payees/{payeeId}/remoteIdUpdate\n@desc Update Payee Remote Id\n@required {payeeId: str(uuid) # The UUID of the payee., payorId: str(uuid), remoteId: str}\n@returns(204) Accepted, No Content\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available, 409: The request contained data that would result in a duplicate value}\n\n@endpoint POST /v3/payees/{payeeId}/payeeDetailsUpdate\n@desc Update Payee Details\n@required {payeeId: str(uuid) # The UUID of the payee.}\n@optional {address: map{line1!: str, line2: str, line3: str, line4: str, city!: str, countyOrProvince: str, zipOrPostcode: str, country!: str}, individual: map{name!: any, nationalIdentification: str, dateOfBirth!: str}, company: map{name!: str, taxId: str, operatingName: str}, language: str # An IETF BCP 47 language code which has been configured for use within this Velo environment. See the /v1/supportedLanguages endpoint to list the available codes for an environment., payeeType: str(Individual/Company) # The type of the payee, challenge: map{value!: str, description!: str}, email: str(email), contactSmsNumber: str # The phone number of a device that the payee wishes to receive sms messages on}\n@returns(204) Request accepted\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endpoint DELETE /v4/payees/{payeeId}\n@desc Delete Payee by Id\n@required {payeeId: str(uuid) # The UUID of the payee.}\n@returns(204) No content. Payee Id accepted for deletion.\n@errors {400: Invalid request. See Error message payload for details of failure, 404: The resource was not found or is no longer available}\n\n@endpoint GET /v4/payees/{payeeId}\n@desc Get Payee by Id\n@required {payeeId: str(uuid) # The UUID of the payee.}\n@optional {sensitive: bool # Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values.}\n@returns(200) {payeeId: str(uuid), payorRefs: [map]?, paymentChannels: [map]?, email: str(email)?, onboardedStatus: str, watchlistStatus: str, watchlistOverrideExpiresAtTimestamp: str(date-time)?, watchlistOverrideComment: str, language: str, created: str(date-time), country: str, displayName: str, payeeType: str, disabled: bool, disabledComment: str, disabledUpdatedTimestamp: str(date-time), address: map{line1: str, line2: str?, line3: str?, line4: str?, city: str, countyOrProvince: str?, zipOrPostcode: str?, country: str}, individual: map{name: any, nationalIdentification: str, dateOfBirth: str}, company: map?{name: str, taxId: str?, operatingName: str?}, cellphoneNumber: str, managedByPayorId: str(uuid), watchlistStatusUpdatedTimestamp: str(date_time)?, gracePeriodEndDate: str(date)?, enhancedKycCompleted: bool, kycCompletedTimestamp: str(date_time)?, pausePayment: bool, pausePaymentTimestamp: str(date_time)?, marketingOptInDecision: bool, marketingOptInTimestamp: str(date_time)?, acceptTermsAndConditionsTimestamp: str(date-time)?, challenge: map{value: str, description: str}} # Success response, request completed okay\n@errors {404: The resource was not found or is no longer available}\n\n@endpoint POST /v4/payees/{payeeId}/payeeDetailsUpdate\n@desc Update Payee Details\n@required {payeeId: str(uuid) # The UUID of the payee.}\n@optional {address: map{line1!: str, line2: str, line3: str, line4: str, city!: str, countyOrProvince: str, zipOrPostcode: str, country!: str}, individual: map{name!: any, nationalIdentification: str, dateOfBirth!: str}, company: map{name!: str, taxId: str, operatingName: str}, language: str # An IETF BCP 47 language code which has been configured for use within this Velo environment. See the /v1/supportedLanguages endpoint to list the available codes for an environment., payeeType: str(Individual/Company) # The type of the payee, challenge: map{value!: str, description!: str} # Used to override the default challenge presented to the payee when they onboard Not used after the payee has onboarded, email: str(email), contactSmsNumber: str # The phone number of a device that the payee wishes to receive sms messages on}\n@returns(204) Request accepted\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endpoint POST /v4/payees/{payeeId}/remoteIdUpdate\n@desc Update Payee Remote Id\n@required {payeeId: str(uuid) # The UUID of the payee., payorId: str(uuid), remoteId: str}\n@returns(204) Accepted, No Content\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available, 409: The request contained data that would result in a duplicate value}\n\n@endpoint GET /v4/payees\n@desc List Payees\n@required {payorId: str(uuid) # The account owner Payor ID}\n@optional {watchlistStatus: str # The watchlistStatus of the payees., disabled: bool # Payee disabled, onboardedStatus: str # The onboarded status of the payees., email: str(email) # Email address, displayName: str # The display name of the payees., remoteId: str # The remote id of the payees., payeeType: str # The onboarded status of the payees., payeeCountry: str # The country of the payee - 2 letter ISO 3166-1 country code (upper case), ofacStatus: str # The ofacStatus of the payees., page: int(int32)=1 # Page number. Default is 1., pageSize: int(int32)=25 # Page size. Default is 25. Max allowable is 100., sort: str=displayName:asc # List of sort fields (e.g. ?sort=onboardedStatus:asc,name:asc) Default is name:asc 'name' is treated as company name for companies - last name + ',' + firstName for individuals The supported sort fields are - payeeId, displayName, payoutStatus, onboardedStatus.}\n@returns(200) {summary: any, page: any, links: [any], content: [map]} # Details of Payee\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endpoint POST /v4/payees\n@desc Initiate Payee Creation\n@required {payorId: str, payees: [map{email!: str(email), remoteId!: str, type!: str, address!: map, paymentChannel: map, challenge: map, language: str, company: map, individual: map}]}\n@returns(201) {batchId: str(uuid), rejectedCsvRows: [any]} # HTTP Created. Body created only on CSV requests\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endpoint GET /v4/payees/batch/{batchId}\n@desc Query Batch Status\n@required {batchId: str(uuid) # Batch Id}\n@returns(200) {status: str, failureCount: int(int64), pendingCount: int(int64), failures: [map]} # Get Batch Status\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endpoint POST /v4/payees/{payeeId}/invite\n@desc Resend Payee Invite\n@required {payeeId: str(uuid) # The UUID of the payee., payorId: str(uuid)}\n@returns(200) the request was accepted\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available, 409: The request contained data that would result in a duplicate value}\n\n@endpoint GET /v4/payees/payors/{payorId}/invitationStatus\n@desc Get Payee Invitation Status\n@required {payorId: str(uuid) # The account owner Payor ID}\n@optional {payeeId: str(uuid) # The UUID of the payee., invitationStatus: str # The invitation status of the payees., page: int(int32)=1 # Page number. Default is 1., pageSize: int(int32)=25 # Page size. Default is 25. Max allowable is 100.}\n@returns(200) {page: any, links: [any], content: [map]} # Get Payees with Invitaion status - filters of payeeId and invitationStatus\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endpoint GET /v4/payees/deltas\n@desc List Payee Changes\n@required {payorId: str(uuid) # The Payor ID to find associated Payees, updatedSince: str(date-time) # The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm}\n@optional {page: int(int32)=1 # Page number. Default is 1., pageSize: int(int32)=100 # Page size. Default is 100. Max allowable is 1000.}\n@returns(200) {page: any, links: [any], content: [map]} # Details of Payee Changes\n@errors {400: Invalid request. See Error message payload for details of failure}\n\n@endpoint GET /v4/payees/{payeeId}/paymentChannels/\n@desc Get All Payment Channels Details\n@required {payeeId: str(uuid) # The UUID of the payee.}\n@optional {payorId: str(uuid) # (UUID) the id of the Payor. If specified the payment channels are filtered to those mapped to this payor., payable: bool # payable if true only return the payment channel if the payee is payable, sensitive: bool # Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values., ignorePayorInviteStatus: bool # payable if true only return the payment channel if the payee is payable}\n@returns(200) {paymentChannels: [map], payorToPaymentChannelMappings: [map]} # Success response, request completed okay\n@returns(204) payee not payable but the request is valid\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endpoint POST /v4/payees/{payeeId}/paymentChannels/\n@desc Create Payment Channel\n@required {payeeId: str(uuid) # The UUID of the payee.}\n@optional {paymentChannelName: str, iban: str # Must match the regular expression ```^[A-Za-z0-9]+$```., accountNumber: str, routingNumber: str, countryCode: str # Valid ISO 3166 2 character country code. See the ISO specification for details., currency: str # Valid ISO 4217 3 letter currency code. See the ISO specification for details., accountName: str}\n@returns(201) Payment channel is created.\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available, 409: The request contained data that would result in a duplicate value}\n\n@endpoint DELETE /v4/payees/{payeeId}/paymentChannels/{paymentChannelId}\n@desc Delete Payment Channel\n@required {payeeId: str(uuid) # The UUID of the payee., paymentChannelId: str(uuid) # The UUID of the payment channel.}\n@returns(204) Deleted. No content.\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available, 409: The request contained data that would result in a duplicate value}\n\n@endpoint GET /v4/payees/{payeeId}/paymentChannels/{paymentChannelId}\n@desc Get Payment Channel Details\n@required {payeeId: str(uuid) # The UUID of the payee., paymentChannelId: str(uuid) # The UUID of the payment channel.}\n@optional {payable: bool # payable if true only return the payment channel if the payee is payable, sensitive: bool # Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values.}\n@returns(200) {id: str(uuid), payeeId: str(uuid), paymentChannelName: str, accountName: str, channelType: str, countryCode: str, routingNumber: str, accountNumber: str, iban: str, currency: str, payorIds: [str(uuid)], payeeName: str, bankName: str, bankSwiftBic: str, bankAddress: map{line1: str, line2: str?, line3: str?, line4: str?, city: str, countyOrProvince: str?, zipOrPostcode: str?, country: str}, deleted: bool, enabled: bool, disabledReasonCode: str, disabledReason: str, payable: bool} # Success response, request completed okay\n@returns(204) payee not payable but the request is valid\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endpoint POST /v4/payees/{payeeId}/paymentChannels/{paymentChannelId}\n@desc Update Payment Channel\n@required {payeeId: str(uuid) # The UUID of the payee., paymentChannelId: str(uuid) # The UUID of the payment channel.}\n@optional {routingNumber: str, accountNumber: str, iban: str # Must match the regular expression ```^[A-Za-z0-9]+$```., paymentChannelName: str, countryCode: str # Valid ISO 3166 2 character country code. See the ISO specification for details., accountName: str, currency: str # Valid ISO 4217 3 letter currency code. See the ISO specification for details.}\n@returns(204) Request accepted. No content.\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available, 409: The request contained data that would result in a duplicate value}\n\n@endpoint POST /v4/payees/{payeeId}/paymentChannels/{paymentChannelId}/enable\n@desc Enable Payment Channel\n@required {payeeId: str(uuid) # The UUID of the payee., paymentChannelId: str(uuid) # The UUID of the payment channel.}\n@returns(204) Enabled. No content.\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endpoint PUT /v4/payees/{payeeId}/paymentChannels/order\n@desc Update Payees preferred Payment Channel order\n@required {payeeId: str(uuid) # The UUID of the payee., paymentChannelIds: [str(uuid)]}\n@returns(204) Request accepted. No content.\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available, 409: The request contained data that would result in a duplicate value}\n\n@endgroup\n\n@group sourceAccounts\n@endpoint POST /v1/sourceAccounts/{sourceAccountId}/notifications\n@desc Set notifications\n@required {sourceAccountId: str(uuid) # Source account id, minimumBalance: int(int64) # Amount to set as minimum balance in minor units}\n@returns(204) Request Fulfilled\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endpoint POST /v2/sourceAccounts/{sourceAccountId}/fundingRequest\n@desc Create Funding Request\n@required {sourceAccountId: str(uuid) # Source account id, amount: int(int64) # Amount to fund, decimal implied}\n@returns(202) Request Accepted\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endpoint GET /v2/sourceAccounts\n@desc Get list of source accounts\n@optional {physicalAccountName: str # Physical Account Name, physicalAccountId: str(uuid) # The physical account ID, payorId: str(uuid) # The account owner Payor ID, fundingAccountId: str(uuid) # The funding account ID, page: int(int32)=1 # Page number. Default is 1., pageSize: int(int32)=25 # The number of results to return in a page, sort: str=fundingRef:asc # List of sort fields e.g. ?sort=name:asc Default is name:asc The supported sort fields are - fundingRef, name, balance}\n@returns(200) {page: any, links: [any], content: [map]} # List Source Account response\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endpoint GET /v2/sourceAccounts/{sourceAccountId}\n@desc Get Source Account\n@required {sourceAccountId: str(uuid) # Source account id}\n@returns(200) {id: str(uuid), balance: int(int64), currency: str, fundingRef: str, physicalAccountName: str, railsId: str, payorId: str(uuid), name: str, pooled: bool, balanceVisible: bool, customerId: str?, physicalAccountId: str(uuid), notifications: map{minimumBalance: int}, fundingAccountId: str(uuid)?, autoTopUpConfig: map{enabled: bool, minBalance: int(int64)?, targetBalance: int(int64)?}, accountType: str} # Source account response\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endpoint POST /v2/sourceAccounts/{sourceAccountId}/transfers\n@desc Transfer Funds between source accounts\n@required {sourceAccountId: str(uuid) # The 'from' source account id, which will be debited, toSourceAccountId: str(uuid) # The 'to' source account id, which will be credited, amount: int(int64) # Amount to transfer, in minor units, currency: str}\n@returns(204) Request Processed\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endpoint POST /v3/sourceAccounts/{sourceAccountId}/fundingRequest\n@desc Create Funding Request\n@required {sourceAccountId: str(uuid) # Source account id, fundingAccountId: str(uuid) # The funding account id, amount: int(int64) # Amount to fund in minor units}\n@returns(202) Request Accepted\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endpoint GET /v3/sourceAccounts\n@desc Get list of source accounts\n@optional {physicalAccountName: str # Physical Account Name, physicalAccountId: str(uuid) # The physical account ID, payorId: str(uuid) # The account owner Payor ID, fundingAccountId: str(uuid) # The funding account ID, includeUserDeleted: str(boolean) # A filter for retrieving both active accounts and user deleted ones, type: str # The type of source account., page: int(int32)=1 # Page number. Default is 1., pageSize: int(int32)=25 # The number of results to return in a page, sort: str=fundingRef:asc # List of sort fields e.g. ?sort=name:asc Default is name:asc The supported sort fields are - fundingRef, name, balance}\n@returns(200) {page: any, links: [any], content: [map]} # List Source Account response\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endpoint DELETE /v3/sourceAccounts/{sourceAccountId}\n@desc Delete a source account by ID\n@required {sourceAccountId: str(uuid) # Source account id}\n@returns(204) No Content - Source account is deleted\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available, 409: The request contained data that would result in a duplicate value}\n\n@endpoint GET /v3/sourceAccounts/{sourceAccountId}\n@desc Get details about given source account.\n@required {sourceAccountId: str(uuid) # Source account id}\n@returns(200) {id: str(uuid), balance: int(int64), currency: str, fundingRef: str, physicalAccountName: str, railsId: str, payorId: str(uuid), name: str, pooled: bool, customerId: str?, physicalAccountId: str(uuid), notifications: map{minimumBalance: int}, autoTopUpConfig: map{enabled: bool, minBalance: int(int64)?, targetBalance: int(int64)?, fundingAccountId: str(uuid)}, type: str, country: str, deleted: bool, userDeleted: bool, deletedAt: str(date-time), transmissionTypes: [str]} # Source account response\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endpoint POST /v3/sourceAccounts/{sourceAccountId}/transfers\n@desc Transfer Funds between source accounts\n@required {sourceAccountId: str(uuid) # The 'from' source account id, which will be debited, toSourceAccountId: str(uuid) # The 'to' source account id, which will be credited, amount: int(int64) # Amount to transfer, in minor units, currency: str # Valid ISO 4217 3 letter currency code. See the ISO specification for details.}\n@returns(204) Request Processed\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endpoint POST /v3/sourceAccounts/{sourceAccountId}/notifications\n@desc Set notifications\n@required {sourceAccountId: str(uuid) # Source account id, minimumBalance: int(int64) # Amount to set as minimum balance for notifications in minor units}\n@returns(204) Request Fulfilled\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endgroup\n\n@group fundingAccounts\n@endpoint GET /v2/fundingAccounts\n@desc Get Funding Accounts\n@optional {payorId: str(uuid), name: str # The descriptive funding account name, countryCode: str # The 2 letter ISO 3166-1 country code (upper case), currency: str # The ISO 4217 currency code, type: str # The type of funding account., page: int(int32)=1 # Page number. Default is 1., pageSize: int(int32)=25 # The number of results to return in a page, sort: str=accountName:asc # List of sort fields (e.g. ?sort=accountName:asc,name:asc) Default is accountName:asc The supported sort fields are - accountName, name., sensitive: bool=false}\n@returns(200) {page: any, links: [any], content: [map]} # Get Funding Accounts Response\n@errors {400: Invalid request. See Error message payload for details of failure, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions}\n\n@endpoint POST /v2/fundingAccounts\n@desc Create Funding Account\n@required {type: str(FBO/PRIVATE), name: str, payorId: str(uuid), countryCode: str # ISO 3166-1 2 letter country code (upper case)}\n@optional {accountName: str # Required if type is either FBO or PRIVATE, accountNumber: str # Required if type is either FBO or PRIVATE, routingNumber: str # Required if type is either FBO or PRIVATE}\n@returns(202) Funding Account Creation Request Accepted\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions}\n@example_request {\"type\":\"FBO\",\"name\":\"My FBO Account\",\"payorId\":\"ee53e01d-c078-43fd-abd4-47e92f4a06cf\",\"accountName\":\"My Account Name\",\"accountNumber\":1231231234556,\"routingNumber\":123456789,\"countryCode\":\"US\"}\n\n@endpoint GET /v2/fundingAccounts/{fundingAccountId}\n@desc Get Funding Account\n@required {fundingAccountId: str(uuid)}\n@optional {sensitive: bool=false}\n@returns(200) {id: str(uuid), payorId: str(uuid), accountName: str, accountNumber: str, routingNumber: str, name: str, currency: str, countryCode: str, type: str, archived: bool} # Funding Account Response\n@errors {400: Bad Request, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endgroup\n\n@group deltas\n@endpoint GET /v1/deltas/fundings\n@desc Get Funding Audit Delta\n@required {payorId: str(uuid), updatedSince: str(date-time)}\n@optional {page: int(int32)=1 # Page number. Default is 1., pageSize: int(int32)=25 # The number of results to return in a page}\n@returns(200) {links: [map], page: map{numberOfElements: int(int32), totalElements: int(int64), totalPages: int(int32), page: int(int32), pageSize: int(int32)}, content: [map]} # Funding Account Deltas\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions}\n\n@endgroup\n\n@group fundings\n@endpoint GET /v1/fundings/{fundingId}\n@desc Get Funding\n@required {fundingId: str(uuid)}\n@returns(200) {fundingId: str(uuid), payorId: str(uuid), createdAt: str(date-time), detectedFundingRef: str, amount: int(int64), currency: str, text: str, physicalAccountName: str, sourceAccountId: str(uuid), allocationType: str, allocatedAt: str(date-time), allocationDate: str(date-time), reason: str, hiddenDate: str(date-time), fundingAccountType: str, status: str} # Funding response\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endgroup\n\n@group transactions\n@endpoint GET /v1/transactions\n@desc Get Transactions\n@optional {payorId: str, transactionReference: str, page: int(int32)=1 # Page number. Default is 1., pageSize: int(int32)=25 # The number of results to return in a page, sort: str=createdAt:asc}\n@returns(200) {links: [map], page: map{numberOfElements: int(int32), totalElements: int(int64), totalPages: int(int32), page: int(int32), pageSize: int(int32)}, content: [map]} # default response\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions}\n\n@endpoint POST /v1/transactions\n@desc Create a Transaction\n@required {payorId: str(uuid) # Indicates the Payor creating the Transaction and which matches the payorId on the provided source account, sourceAccountName: str # The name of the source account that the new Transaction will be associated with and any funding containing the transactionShortCode will credit., transactionReference: str # The payors own reference for the transaction that can later be used for querying and retrieval.}\n@optional {transactionMetadata: map # Optional metadata that will be attached to the created transaction and can that can be retrieved later.| The total length of all the keys and values provided in the metadata must be no more than 4000 chars.}\n@returns(201) {transactionId: str(uuid), transactionShortCode: str} # Transaction Created\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions}\n\n@endpoint GET /v1/transactions/{transactionId}\n@desc Get Transaction\n@required {transactionId: str(uuid)}\n@returns(200) {transactionId: str(uuid), transactionShortCode: str, payorId: str(uuid), sourceAccountName: str, sourceAccountId: str(uuid), transactionReference: str, transactionMetadata: map?, balance: int(int64), currency: str, createdAt: str(date-time)} # Transaction response\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endgroup\n\n@group paymentaudit\n@endpoint GET /v1/paymentaudit/fundings\n@desc V1 Get Fundings for Payor\n@required {payorId: str(uuid) # The account owner Payor ID}\n@optional {page: int(int32)=1 # Page number. Default is 1., pageSize: int(int32)=25 # The number of results to return in a page, sort: str # List of sort fields. Example: ```?sort=destinationCurrency:asc,destinationAmount:asc``` Default is no sort. The supported sort fields are: dateTime and amount.}\n@returns(200) {page: any, links: [any], content: [map]} # Get Fundings normal response\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endpoint GET /v1/paymentaudit/payoutStatistics\n@desc V1 Get Payout Statistics\n@optional {payorId: str(uuid) # The account owner Payor ID. Required for external users.}\n@returns(200) {thisMonthPayoutsCount: int, thisMonthFailedPaymentsCount: int} # Payout Statistics response\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endgroup\n\n@group deltas\n@endpoint GET /v1/deltas/payments\n@desc V1 List Payment Changes\n@required {payorId: str(uuid) # The Payor ID to find associated Payments, updatedSince: str(date-time) # The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm}\n@optional {page: int(int32)=1 # Page number. Default is 1., pageSize: int(int32)=100 # The number of results to return in a page}\n@returns(200) {page: any, links: [any], content: [map]} # Details of Payment Changes\n@errors {400: Invalid request. See Error message payload for details of failure}\n\n@endgroup\n\n@group paymentaudit\n@endpoint GET /v3/paymentaudit/payouts\n@desc V3 Get Payouts for Payor\n@required {payorId: str(uuid) # The account owner Payor ID}\n@optional {payoutMemo: str # Payout Memo filter - case insensitive sub-string match, status: str(ACCEPTED/REJECTED/SUBMITTED/QUOTED/INSTRUCTED/COMPLETED/INCOMPLETE/CONFIRMED/WITHDRAWN) # Payout Status, submittedDateFrom: str(date) # The submitted date from range filter. Format is yyyy-MM-dd., submittedDateTo: str(date) # The submitted date to range filter. Format is yyyy-MM-dd., page: int(int32)=1 # Page number. Default is 1., pageSize: int(int32)=25 # The number of results to return in a page, sort: str # List of sort fields (e.g. ?sort=submittedDateTime:asc,instructedDateTime:asc,status:asc) Default is submittedDateTime:asc The supported sort fields are: submittedDateTime, instructedDateTime, status.}\n@returns(200) {page: any, links: [any], content: [map]} # Payor data found\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endpoint GET /v3/paymentaudit/payouts/{payoutId}\n@desc V3 Get Payments for Payout\n@required {payoutId: str(uuid) # The id (UUID) of the payout.}\n@optional {remoteId: str # The remote id of the payees., status: str(ACCEPTED/AWAITING_FUNDS/FUNDED/UNFUNDED/BANK_PAYMENT_REQUESTED/REJECTED/ACCEPTED_BY_RAILS/CONFIRMED/FAILED/RETURNED/WITHDRAWN) # Payment Status, sourceAmountFrom: int(int32) # The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom, sourceAmountTo: int(int32) # The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo, paymentAmountFrom: int(int32) # The payment amount from range filter. Filters for paymentAmount >= paymentAmountFrom, paymentAmountTo: int(int32) # The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo, submittedDateFrom: str(date) # The submitted date from range filter. Format is yyyy-MM-dd., submittedDateTo: str(date) # The submitted date to range filter. Format is yyyy-MM-dd., page: int(int32)=1 # Page number. Default is 1., pageSize: int(int32)=25 # The number of results to return in a page, sort: str # List of sort fields (e.g. ?sort=submittedDateTime:asc,status:asc). Default is sort by remoteId The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime and status, sensitive: bool # Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values.}\n@returns(200) {summary: any, page: any, links: [any], content: [map]} # 200 response, data found okay\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endpoint GET /v3/paymentaudit/payments\n@desc V3 Get List of Payments\n@optional {payeeId: str(uuid) # The UUID of the payee., payorId: str(uuid) # The account owner Payor Id. Required for external users., payorName: str # The payor’s name. This filters via a case insensitive substring match., remoteId: str # The remote id of the payees., status: str(ACCEPTED/AWAITING_FUNDS/FUNDED/UNFUNDED/BANK_PAYMENT_REQUESTED/REJECTED/ACCEPTED_BY_RAILS/CONFIRMED/FAILED/RETURNED/WITHDRAWN) # Payment Status, sourceAccountName: str # The source account name filter. This filters via a case insensitive substring match., sourceAmountFrom: int(int32) # The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom, sourceAmountTo: int(int32) # The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo, sourceCurrency: str # The source currency filter. Filters based on an exact match on the currency., paymentAmountFrom: int(int32) # The payment amount from range filter. Filters for paymentAmount >= paymentAmountFrom, paymentAmountTo: int(int32) # The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo, paymentCurrency: str # The payment currency filter. Filters based on an exact match on the currency., submittedDateFrom: str(date) # The submitted date from range filter. Format is yyyy-MM-dd., submittedDateTo: str(date) # The submitted date to range filter. Format is yyyy-MM-dd., paymentMemo: str # The payment memo filter. This filters via a case insensitive substring match., page: int(int32)=1 # Page number. Default is 1., pageSize: int(int32)=25 # The number of results to return in a page, sort: str # List of sort fields (e.g. ?sort=submittedDateTime:asc,status:asc). Default is sort by remoteId The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime and status, sensitive: bool # Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values.}\n@returns(200) {page: any, links: [any], content: [map]} # Paginated list of payments\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions}\n\n@endpoint GET /v3/paymentaudit/payments/{paymentId}\n@desc V3 Get Payment\n@required {paymentId: str(uuid) # Payment Id}\n@optional {sensitive: bool # Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values.}\n@returns(200) {paymentId: str(uuid), payeeId: str(uuid), payorId: str(uuid), payorName: str, quoteId: str(uuid), sourceAccountId: str(uuid), sourceAccountName: str, remoteId: str, sourceAmount: int, sourceCurrency: str, paymentAmount: int, paymentCurrency: str, rate: num(float), invertedRate: num(float), submittedDateTime: str(date-time), status: str, fundingStatus: str, routingNumber: str, accountNumber: str, iban: str, paymentMemo: str, filenameReference: str, individualIdentificationNumber: str, traceNumber: str, payorPaymentId: str, paymentChannelId: str, paymentChannelName: str, accountName: str, railsId: str, countryCode: str, events: [map], returnCost: int, returnReason: str, railsPaymentId: str, railsBatchId: str, paymentScheme: str, rejectionReason: str} # 200 response, request completed okay\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endpoint GET /v3/paymentaudit/transactions\n@desc V3 Export Transactions\n@optional {payorId: str(uuid) # The Payor ID for whom you wish to run the report. For a Payor requesting the report, this could be their exact Payor, or it could be a child/descendant Payor., startDate: str(date) # Start date, inclusive. Format is YYYY-MM-DD, endDate: str(date) # End date, inclusive. Format is YYYY-MM-DD}\n@returns(200) Export Transactions response\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions}\n\n@endpoint GET /v4/paymentaudit/payouts\n@desc Get Payouts for Payor\n@optional {payorId: str(uuid) # The id (UUID) of the payor funding the payout or the payor whose payees are being paid., payoutMemo: str # Payout Memo filter - case insensitive sub-string match, status: str(ACCEPTED/REJECTED/SUBMITTED/QUOTED/INSTRUCTED/COMPLETED/INCOMPLETE/CONFIRMED/WITHDRAWN) # Payout Status, submittedDateFrom: str(date) # The submitted date from range filter. Format is yyyy-MM-dd., submittedDateTo: str(date) # The submitted date to range filter. Format is yyyy-MM-dd., fromPayorName: str # The name of the payor whose payees are being paid. This filters via a case insensitive substring match., scheduledForDateFrom: str(date) # Filter payouts scheduled to run on or after the given date. Format is yyyy-MM-dd., scheduledForDateTo: str(date) # Filter payouts scheduled to run on or before the given date. Format is yyyy-MM-dd., scheduleStatus: str(ANY/SCHEDULED/EXECUTED/FAILED) # Payout Schedule Status, page: int(int32)=1 # Page number. Default is 1., pageSize: int(int32)=25 # The number of results to return in a page, sort: str # List of sort fields (e.g. ?sort=submittedDateTime:asc,instructedDateTime:asc,status:asc) Default is submittedDateTime:asc The supported sort fields are: submittedDateTime, instructedDateTime, status, totalPayments, payoutId, scheduledFor}\n@returns(200) {page: any, links: [any], content: [map]} # Payor data found\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endpoint GET /v4/paymentaudit/payouts/{payoutId}\n@desc Get Payments for Payout\n@required {payoutId: str(uuid) # The id (UUID) of the payout.}\n@optional {railsId: str # Payout Rails ID filter - case insensitive match. Any value is allowed, but you should use one of the supported railsId values. To get this list of values, you should call the 'Get Supported Rails' endpoint., remoteId: str # The remote id of the payees., remoteSystemId: str # The id of the remote system that is orchestrating payments, status: str(ACCEPTED/AWAITING_FUNDS/FUNDED/UNFUNDED/BANK_PAYMENT_REQUESTED/REJECTED/ACCEPTED_BY_RAILS/CONFIRMED/FAILED/RETURNED/WITHDRAWN) # Payment Status, sourceAmountFrom: int(int32) # The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom, sourceAmountTo: int(int32) # The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo, paymentAmountFrom: int(int32) # The payment amount from range filter. Filters for paymentAmount >= paymentAmountFrom, paymentAmountTo: int(int32) # The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo, submittedDateFrom: str(date) # The submitted date from range filter. Format is yyyy-MM-dd., submittedDateTo: str(date) # The submitted date to range filter. Format is yyyy-MM-dd., transmissionType: str(ACH/SAME_DAY_ACH/WIRE/LOCAL/GACHO) # Transmission Type * ACH * SAME_DAY_ACH * WIRE * GACHO, page: int(int32)=1 # Page number. Default is 1., pageSize: int(int32)=25 # The number of results to return in a page, sort: str # List of sort fields (e.g. ?sort=submittedDateTime:asc,status:asc). Default is sort by remoteId The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime and status, sensitive: bool # Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values.}\n@returns(200) {summary: any, page: any, links: [any], content: [map]} # 200 response, data found okay\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endpoint GET /v4/paymentaudit/payments\n@desc Get List of Payments\n@optional {payeeId: str(uuid) # The UUID of the payee., payorId: str(uuid) # The account owner Payor Id. Required for external users., payorName: str # The payor’s name. This filters via a case insensitive substring match., remoteId: str # The remote id of the payees., remoteSystemId: str # The id of the remote system that is orchestrating payments, status: str(ACCEPTED/AWAITING_FUNDS/FUNDED/UNFUNDED/BANK_PAYMENT_REQUESTED/REJECTED/ACCEPTED_BY_RAILS/CONFIRMED/FAILED/RETURNED/WITHDRAWN) # Payment Status, transmissionType: str(ACH/SAME_DAY_ACH/WIRE/LOCAL/GACHO) # Transmission Type * ACH * SAME_DAY_ACH * WIRE * GACHO, sourceAccountName: str # The source account name filter. This filters via a case insensitive substring match., sourceAmountFrom: int(int32) # The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom, sourceAmountTo: int(int32) # The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo, sourceCurrency: str # The source currency filter. Filters based on an exact match on the currency., paymentAmountFrom: int(int32) # The payment amount from range filter. Filters for paymentAmount >= paymentAmountFrom, paymentAmountTo: int(int32) # The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo, paymentCurrency: str # The payment currency filter. Filters based on an exact match on the currency., submittedDateFrom: str(date) # The submitted date from range filter. Format is yyyy-MM-dd., submittedDateTo: str(date) # The submitted date to range filter. Format is yyyy-MM-dd., paymentMemo: str # The payment memo filter. This filters via a case insensitive substring match., payorPaymentId: str # Payor's Id of the Payment, railsId: str # Payout Rails ID filter - case insensitive match. Any value is allowed, but you should use one of the supported railsId values. To get this list of values, you should call the 'Get Supported Rails' endpoint., scheduledForDateFrom: str(date) # Filter payouts scheduled to run on or after the given date. Format is yyyy-MM-dd., scheduledForDateTo: str(date) # Filter payouts scheduled to run on or before the given date. Format is yyyy-MM-dd., scheduleStatus: str(ANY/SCHEDULED/EXECUTED/FAILED) # Payout Schedule Status, postInstructFxStatus: str(ANY/INITIATED/CANCELLED/EXECUTED/COMPLETED/RETURNED/RESUBMITTED/REFUNDED) # The status of the post instruct FX step if one was required for the payment, transactionReference: str # Query for all payments associated with a specific transaction reference, transactionId: str(uuid) # Query for all payments associated with a specific transaction id, page: int(int32)=1 # Page number. Default is 1., pageSize: int(int32)=25 # The number of results to return in a page, sort: str # List of sort fields (e.g. ?sort=submittedDateTime:asc,status:asc). Default is sort by submittedDateTime:desc,paymentId:asc The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime, status and paymentId, sensitive: bool # Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values.}\n@returns(200) {page: any, links: [any], content: [map]} # Paginated list of payments\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions}\n\n@endpoint GET /v4/paymentaudit/payments/{paymentId}\n@desc Get Payment\n@required {paymentId: str(uuid) # Payment Id}\n@optional {sensitive: bool # Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values.}\n@returns(200) {paymentId: str(uuid), payeeId: str(uuid), payorId: str(uuid), payorName: str, quoteId: str(uuid), sourceAccountId: str(uuid), sourceAccountName: str, remoteId: str, remoteSystemId: str, remoteSystemPaymentId: str, sourceAmount: int, sourceCurrency: str, paymentAmount: int, paymentCurrency: str, rate: num(double), invertedRate: num(double), isPaymentCcyBaseCcy: bool, submittedDateTime: str(date-time), status: str, fundingStatus: str, routingNumber: str, accountNumber: str, iban: str, paymentMemo: str, filenameReference: str, individualIdentificationNumber: str, traceNumber: str, payorPaymentId: str, paymentChannelId: str, paymentChannelName: str, accountName: str, railsId: str, countryCode: str, payeeAddressCountryCode: str, events: [map], returnCost: int, returnReason: str, railsPaymentId: str, railsBatchId: str, railsAccountId: str, paymentScheme: str, rejectionReason: str, railsRejectionInformation: str, withdrawnReason: str, withdrawable: bool, autoWithdrawnReasonCode: str, transmissionType: str, transmissionTypeRequested: str, paymentTrackingReference: str, paymentMetadata: str, transactionId: str(uuid), transactionReference: str, schedule: map{scheduleStatus: str, scheduledAt: str(date-time), scheduledFor: str(date-time), scheduledByPrincipalId: str, notificationsEnabled: bool, scheduledBy: str}, postInstructFxInfo: map{fxMode: str, fxStatus: str, fxStatusUpdatedAt: str(date-time), fxTransactionReference: str}, payout: any} # 200 response, request completed okay\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endpoint GET /v4/paymentaudit/fundings\n@desc Get Fundings for Payor\n@required {payorId: str(uuid) # The account owner Payor ID}\n@optional {sourceAccountName: str # The source account name, page: int(int32)=1 # Page number. Default is 1., pageSize: int(int32)=25 # The number of results to return in a page, sort: str # List of sort fields. Example: ```?sort=destinationCurrency:asc,destinationAmount:asc``` Default is no sort. The supported sort fields are: dateTime and amount.}\n@returns(200) {page: any, links: [any], content: [map]} # Get Fundings normal response\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endpoint GET /v4/paymentaudit/payoutStatistics\n@desc Get Payout Statistics\n@optional {payorId: str(uuid) # The account owner Payor ID. Required for external users.}\n@returns(200) {thisMonthPayoutsCount: int, thisMonthFailedPaymentsCount: int} # Payout Statistics response\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endgroup\n\n@group payments\n@endpoint GET /v4/payments/deltas\n@desc List Payment Changes\n@required {payorId: str(uuid) # The Payor ID to find associated Payments, updatedSince: str(date-time) # The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm}\n@optional {page: int(int32)=1 # Page number. Default is 1., pageSize: int(int32)=100 # The number of results to return in a page}\n@returns(200) {page: any, links: [any], content: [map]} # Details of Payment Changes\n@errors {400: Invalid request. See Error message payload for details of failure}\n\n@endgroup\n\n@group paymentaudit\n@endpoint GET /v4/paymentaudit/transactions\n@desc Export Transactions\n@optional {payorId: str(uuid) # The Payor ID for whom you wish to run the report. For a Payor requesting the report, this could be their exact Payor, or it could be a child/descendant Payor., startDate: str(date) # Start date, inclusive. Format is YYYY-MM-DD, endDate: str(date) # End date, inclusive. Format is YYYY-MM-DD, include: str(payorOnly/payorAndDescendants) # Mode to determine whether to include other Payor's data in the results. May only be used if payorId is specified. Can be omitted or set to 'payorOnly' or 'payorAndDescendants'. payorOnly: Only include results for the specified Payor. This is the default if 'include' is omitted. payorAndDescendants: Aggregate results for all descendant Payors of the specified Payor. Should only be used if the Payor with the specified payorId has at least one child Payor. Note when a Payor requests the report and include=payorAndDescendants is used, the following additional columns are included in the CSV: Payor Name, Payor Id}\n@returns(200) Export Transactions response\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Not Authorized, 403: Forbidden}\n\n@endgroup\n\n@group payouts\n@endpoint POST /v3/payouts\n@desc Submit Payout\n@required {payments: [map{remoteId!: str, currency!: str, amount!: int(int64), paymentMemo: str, sourceAccountName: str, transactionId: str(uuid), payorPaymentId: str, transmissionType: str, remoteSystemId: str, paymentMetadata: str}]}\n@optional {payoutFromPayorId: str(uuid) # The id of the payor whose source account(s) will be debited payoutFromPayorId and payoutToPayorId must be both supplied or both omitted, payoutToPayorId: str(uuid) # The id of the payor whose payees will be paid payoutFromPayorId and payoutToPayorId must be both supplied or both omitted, payoutMemo: str # Text applied to all payment memos unless specified explicitly on a payment This should be the reference field on the statement seen by the payee (but not via ACH)}\n@returns(202) Successful submission of the payout\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions}\n\n@endpoint DELETE /v3/payouts/{payoutId}\n@desc Withdraw Payout\n@required {payoutId: str(uuid) # Id of the payout}\n@returns(202) HTTP 202 Accepted\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endpoint GET /v3/payouts/{payoutId}\n@desc Get Payout Summary\n@required {payoutId: str(uuid) # Id of the payout}\n@returns(200) {payoutId: str(uuid), status: str, paymentsSubmitted: int, paymentsAccepted: int, paymentsRejected: int, paymentsWithdrawn: int, fxSummaries: [map], accounts: [map], acceptedPayments: [map], rejectedPayments: [map], schedule: map{scheduleStatus: str, scheduledAt: str(date-time), scheduledFor: str(date-time), scheduledByPrincipalId: str, notificationsEnabled: bool}} # Details of Payout\n@errors {401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endpoint POST /v3/payouts/{payoutId}\n@desc Instruct Payout\n@required {payoutId: str(uuid) # Id of the payout}\n@optional {fxRateDegradationThresholdPercentage: num(float) # Halt instruction if the FX rates have become worse since the last quote. Previously called fxRateDegredationThresholdPercentage.}\n@returns(202) HTTP 202 Accepted\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available, 409: The request contained data that would result in a duplicate value}\n\n@endpoint POST /v3/payouts/{payoutId}/quote\n@desc Create a quote for the payout\n@required {payoutId: str(uuid) # Id of the payout}\n@returns(200) {fxSummaries: [map]} # Quote for payout\n@errors {404: The resource was not found or is no longer available, 409: The request contained data that would result in a duplicate value}\n\n@endpoint GET /v3/payouts/{payoutId}/payments\n@desc Retrieve payments for a payout\n@required {payoutId: str(uuid) # Id of the payout}\n@optional {status: str(ACCEPTED/REJECTED/WITHDRAWN/WITHDRAWABLE) # Payment Status * ACCEPTED: any payment which was accepted at submission time (status may have changed since) * REJECTED: any payment rejected by initial submission processing * WITHDRAWN: any payment which has been withdrawn * WITHDRAWABLE: any payment eligible for withdrawal, remoteId: str # The remote id of the payees., payorPaymentId: str # Payor's Id of the Payment, sourceAccountName: str # Physical Account Name, transmissionType: str # Transmission Type * ACH * SAME_DAY_ACH * WIRE, paymentMemo: str # Payment Memo of the Payment, pageSize: int(int32)=25 # The number of results to return in a page, page: int(int32)=1 # Page number. Default is 1.}\n@returns(200) {page: any, links: [any], content: [map]} # Payments for payout\n@errors {404: The resource was not found or is no longer available}\n\n@endpoint DELETE /v3/payouts/{payoutId}/schedule\n@desc Deschedule a payout\n@required {payoutId: str(uuid) # Id of the payout}\n@returns(204) Descheduled payout successfully\n@errors {401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available, 409: The request contained data that would result in a duplicate value}\n\n@endpoint POST /v3/payouts/{payoutId}/schedule\n@desc Schedule a payout\n@required {payoutId: str(uuid) # Id of the payout, scheduledFor: str(date-time) # UTC timestamp for instructing the payout. Format is ISO-8601., notificationsEnabled: bool # Flag to indicate whether to receive notifications when scheduled payout is processed}\n@returns(204) Payout is scheduled successfully\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available, 409: The request contained data that would result in a duplicate value}\n\n@endgroup\n\n@group paymentChannelRules\n@endpoint GET /v1/paymentChannelRules\n@desc List Payment Channel Country Rules\n@returns(200) {bank: [map]} # List Payment Channel Country Rules\n@errors {401: Invalid access token. May be expired or invalid}\n\n@endgroup\n\n@group payments\n@endpoint POST /v1/payments/{paymentId}/withdraw\n@desc Withdraw a Payment\n@required {paymentId: str(uuid) # Id of the Payment, reason: str # Reason for withdrawal}\n@returns(204) The payment was withdrawn\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endgroup\n\n@group supportedCountries\n@endpoint GET /v1/supportedCountries\n@desc List Supported Countries\n@returns(200) {countries: [map]} # List of Supported Countries\n\n@endpoint GET /v2/supportedCountries\n@desc List Supported Countries\n@returns(200) {countries: [map]} # List of Supported Countries\n\n@endgroup\n\n@group currencies\n@endpoint GET /v2/currencies\n@desc List Supported Currencies\n@returns(200) {currencies: [map]} # List Supported Currencies\n\n@endgroup\n\n@group webhooks\n@endpoint GET /v1/webhooks\n@desc List the details about the webhooks for the given payor.\n@required {payorId: str(uuid) # The Payor ID}\n@optional {page: int(int32)=1 # Page number. Default is 1., pageSize: int(int32)=25 # The number of results to return in a page}\n@returns(200) {page: map{numberOfElements: int(int64), totalElements: int(int64), totalPages: int(int64), page: int(int64), pageSize: int(int64)}, links: [map], content: [map]} # Webhook response\n@errors {400: Invalid Request Parameters, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions}\n\n@endpoint POST /v1/webhooks\n@desc Create Webhook\n@required {payorId: str(uuid), webhookUrl: str # the webhook URL to use., enabled: bool # whether the webhook is enabled.}\n@optional {authorizationHeader: str # the authorization header to include with the notification., categories: [str] # the categories to enable.}\n@returns(201) Webhook Created\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions}\n\n@endpoint GET /v1/webhooks/{webhookId}\n@desc Get details about the given webhook.\n@required {webhookId: str(uuid) # Webhook id}\n@returns(200) {id: str(uuid), payorId: str(uuid), webhookUrl: str, authorizationHeader: str, enabled: bool, categories: [str]} # Webhook response\n@errors {400: Bad Request, Invalid path parameter, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endpoint POST /v1/webhooks/{webhookId}\n@desc Update Webhook\n@required {webhookId: str(uuid) # Webhook id}\n@optional {webhookUrl: str # the webhook URL to use., authorizationHeader: str # the authorization header to include with the notification., enabled: bool # whether the webhook is enabled., categories: [str] # The notification categories to enable.}\n@returns(204) Webhook Updated\n@errors {400: Invalid request. See Error message payload for details of failure, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endpoint POST /v1/webhooks/{webhookId}/ping\n@required {webhookId: str(uuid) # Webhook id}\n@returns(202) {id: str(uuid), webhookId: str(uuid)} # Send ping\n@errors {400: Bad Request, Invalid path parameter, 401: Invalid access token. May be expired or invalid, 403: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions, 404: The resource was not found or is no longer available}\n\n@endgroup\n\n@end\n"}}