actionPOSTv1.0.0
Add Logo
<p>Add Payor Logo</p> <p>Logo file is used in your branding and emails sent to payees</p>
actionPOSTv1.0.0
Create a Payor Link
This endpoint allows you to create a payor link.
actionPOSTv1.0.0
Create a quote for the payout
Create quote for a payout
actionPOSTv1.0.0
Create API Key
<p>Create an an API key for the given payor Id and application Id</p> <p>You can create multiple API Keys for a given application</p> <p>API Keys are programmatic users for integrating your application with the Velo platform</p>
actionPOSTv1.0.0
Create Application
<p>Create an application for the given Payor ID.</p> <p>Applications provide a means to group your API Keys</p> <p>For example you might have an SAP application that you wish to integrate with Velo</p> <p>You can create an application and then create one or more API keys for the application</p>
actionPOSTv1.0.0
Create Funding Account
Create Funding Account
actionPOSTv1.0.0
Create Funding Request
Instruct a funding request to transfer funds from the payor’s funding bank to the payor’s balance held within Velo (202 - accepted, 400 - invalid request body, 404 - source account not found).
actionPOSTv1.0.0
Create Funding Request
<p>Instruct a funding request to transfer funds from the payor’s funding bank to the payor’s balance held within Velo</p>
actionDELETEv1.0.0
Delete a source account by ID
Mark a source account as deleted by ID
actionDELETEv1.0.0
Delete a User
Delete User by Id.
actionDELETEv1.0.0
Delete Payee by Id
<p>Use v4 instead</p> <p>This API will delete Payee by Id (UUID). Deletion by ID is not allowed if:</p> <p>* Payee ID is not found</p> <p>* If Payee has not been on-boarded</p> <p>* If Payee is in grace period</p> <p>* If Payee has existing payments</p>
actionDELETEv1.0.0
Delete Payee by Id
<p>This API will delete Payee by Id (UUID). Deletion by ID is not allowed if:</p> <p>* Payee ID is not found</p> <p>* If Payee has not been on-boarded</p> <p>* If Payee is in grace period</p> <p>* If Payee has existing payments</p>
actionDELETEv1.0.0
Deschedule a payout
Remove the schedule for a scheduled payout
actionPOSTv1.0.0
Disable a User
<p>If a user is enabled this endpoint will disable them </p> <p>The invoker must have the appropriate permission </p> <p>A user cannot disable themself </p> <p>When a user is disabled any active access tokens will be revoked and the user will not be able to log in</p>
actionPOSTv1.0.0
Enable a User
<p>If a user has been disabled this endpoints will enable them </p> <p>The invoker must have the appropriate permission </p> <p>A user cannot enable themself </p> <p>If the user is a payor user and the payor is disabled this operation is not allowed</p> <p>If enabling a payor user would breach the limit for master admin payor users the request will be rejected </p>
actionGETv1.0.0
Get Branding
Get the payor branding details.
actionGETv1.0.0
Get details about given source account.
Get details about given source account.
actionGETv1.0.0
Get Funding
Get Funding by Id
actionGETv1.0.0
Get Funding Account
Get Funding Account by ID
actionGETv1.0.0
Get Funding Accounts
Get the funding accounts.
actionGETv1.0.0
Get Funding Audit Delta
Get funding audit deltas for a payor
actionGETv1.0.0
Get Fundings for Payor
<p>Get a list of Fundings for a payor.</p>
actionGETv1.0.0
Get List of Payments
Get payments for the given payor Id
actionGETv1.0.0
Get list of source accounts
List source accounts.
actionGETv1.0.0
Get list of source accounts
List source accounts.
actionGETv1.0.0
Get Payee by Id
<p>Use v4 instead</p> <p>Get Payee by Id</p>
actionGETv1.0.0
Get Payee by Id
Get Payee by Id
actionGETv1.0.0
Get Payee Invitation Status
<p>Use v4 instead</p> <p>Returns a filtered, paginated list of payees associated with a payor, along with invitation status and grace period end date.</p>
actionGETv1.0.0
Get Payee Invitation Status
Returns a filtered, paginated list of payees associated with a payor, along with invitation status and grace period end date.
actionGETv1.0.0
Get Payment
Get the payment with the given id. This contains the payment history.
actionGETv1.0.0
Get Payments for Payout
Get List of payments for Payout, allowing for RETURNED status
actionGETv1.0.0
Get Payor
<p>Get a Single Payor by Id.</p> <p>deprecated since v2.10 - Use /v2/payors
actionGETv1.0.0
Get Payor
Get a Single Payor by Id.
actionGETv1.0.0
Get Payout Statistics
<p>Get payout statistics for a payor.</p>
actionGETv1.0.0
Get Payout Summary
Get payout summary - returns the current state of the payout.
actionGETv1.0.0
Get Payouts for Payor
Get List of payouts for payor
actionGETv1.0.0
Get Self
Get the user's details
actionGETv1.0.0
Get Source Account
Get details about given source account.
actionGETv1.0.0
Get User
Get a Single User by Id.
actionPOSTv1.0.0
Initiate Payee Creation
<p>Use v4 instead</p> Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query for status (201 - Created, 400 - invalid request body. In addition to standard semantic validations, a 400 will also result if there is a duplicate remote id within the batch / if there is a duplicate email within the batch, i.e. if there is a conflict between the data provided for one payee within the batch and that provided for another payee within the same batch). The validation at this stage is intra-batch only. Validation against payees who have already been invited occurs subsequently during processing of the batch.
actionPOSTv1.0.0
Initiate Payee Creation
<p>Initiate the process of creating 1 to 2000 payees in a batch</p> <p>Use the batchId in the response to query for status.</p> <p>In addition to standard semantic validations, a 400 will also result if: </p> <ul> <li>there is a duplicate remote id within the batch</li> <li>there is a duplicate email within the batch, i.e. if there is a conflict between the data provided for one payee within the batch and that provided for another payee within the same batch).</li> </ul> <p>The validation at this stage is intra-batch only.</p> <p>Validation against payees who have already been invited occurs subsequently during processing of the batch.</p>
actionPOSTv1.0.0
Instruct Payout
Instruct a payout to be made for the specified payoutId.
actionPOSTv1.0.0
Invite a User
Create a User and invite them to the system
actionGETv1.0.0
List Payee Changes
<p>Use v4 instead</p> <p>Get a paginated response listing payee changes.</p>
actionGETv1.0.0
List Payee Changes
Get a paginated response listing payee changes (updated since a particular time) to a limited set of fields: - dbaName - displayName - email - onboardedStatus - payeeCountry - payeeId - remoteId
actionGETv1.0.0
List Payees
<p>Use v4 instead</p> Get a paginated response listing the payees for a payor.
actionGETv1.0.0
List Payees
Get a paginated response listing the payees for a payor.
actionGETv1.0.0
List Payment Changes
Get a paginated response listing payment changes.
actionGETv1.0.0
List Payment Channel Country Rules
List the country specific payment channel rules.
actionGETv1.0.0
List Payor Links
<p>If the payor is set up as part of a hierarchy you can use this API to traverse the hierarchy</p>
actionGETv1.0.0
List Supported Countries
<p>List the supported countries.</p> <p>This version will be retired in March 2020. Use /v2/supportedCountries</p>
actionGETv1.0.0
List Supported Countries
List the supported countries.
actionGETv1.0.0
List Supported Currencies
List the supported currencies.
actionGETv1.0.0
List Users
Get a paginated response listing the Users
actionPOSTv1.0.0
Logout
<p>Given a valid access token in the header then log out the authenticated user or client </p> <p>Will revoke the token</p>
actionPOSTv1.0.0
Register SMS Number
<p>Register an Sms number and send an OTP to it </p> <p>Used for manual verification of a user </p> <p>The backoffice user initiates the request to send the OTP to the user's sms </p> <p>The user then reads back the OTP which the backoffice user enters in the verifactionCode property for requests that require it</p>
actionPOSTv1.0.0
Reminder Email Opt-Out
Update the emailRemindersOptOut field for a Payor. This API can be used to opt out or opt into Payor Reminder emails. These emails are typically around payee events such as payees registering and onboarding.
actionPOSTv1.0.0
Resend Payee Invite
<p>Use v4 instead</p> <p>Resend an invite to the Payee The payee must have already been invited by the payor and not yet accepted or declined</p> <p>Any previous invites to the payee by this Payor will be invalidated</p>
actionPOSTv1.0.0
Resend Payee Invite
<p>Resend an invite to the Payee The payee must have already been invited by the payor and not yet accepted or declined</p> <p>Any previous invites to the payee by this Payor will be invalidated</p>
actionPOSTv1.0.0
Reset password
<p>Reset password </p> <p>An email with an embedded link will be sent to the receipient of the email address </p> <p>The link will contain a token to be used for resetting the password </p>
actionGETv1.0.0
Retrieve payments for a payout
Retrieve payments for a payout
actionPOSTv1.0.0
Schedule a payout
<p>Schedule a payout for auto-instruction in the future or update existing payout schedule if the payout has been scheduled before.</p>
actionPOSTv1.0.0
Set notifications
<p>Set notifications for a given source account</p> <p>deprecated since 2.34 (use v3 version)</p>
actionPOSTv1.0.0
Set notifications
<p>Set notifications for a given source account</p> <p>If the balance falls below the amount set in the request an email notification will be sent to the email address registered in the payor profile</p>
actionPOSTv1.0.0
Submit Payout
<p>Create a new payout and return a location header with a link to the payout</p> <p>Basic validation of the payout is performed before returning but more comprehensive validation is done asynchronously</p> <p>The results can be obtained by issuing a HTTP GET to the URL returned in the location header</p> <p>**NOTE:** amount values in payments must be in 'minor units' format. E.g. cents for USD, pence for GBP etc with no decimal places</p>
actionPOSTv1.0.0
Transfer Funds between source accounts
Transfer funds between source accounts for a Payor. The 'from' source account is identified in the URL, and is the account which will be debited. The 'to' (destination) source account is in the body, and is the account which will be credited. Both source accounts must belong to the same Payor. There must be sufficient balance in the 'from' source account, otherwise the transfer attempt will fail.
actionPOSTv1.0.0
Transfer Funds between source accounts
Transfer funds between source accounts for a Payor. The 'from' source account is identified in the URL, and is the account which will be debited. The 'to' (destination) source account is in the body, and is the account which will be credited. Both source accounts must belong to the same Payor. There must be sufficient balance in the 'from' source account, otherwise the transfer attempt will fail.
actionPOSTv1.0.0
Unlock a User
If a user is locked this endpoint will unlock them
actionPOSTv1.0.0
Unregister MFA for Self
<p>Unregister the MFA device for the user </p> <p>If the user does not require further verification then a register new MFA device token will be sent to them via their email address</p>
actionPOSTv1.0.0
Unregister MFA for the user
<p>Unregister the MFA device for the user </p> <p>If the user does not require further verification then a register new MFA device token will be sent to them via their email address</p>
actionPOSTv1.0.0
Update Password for self
Update password for self
actionPOSTv1.0.0
Update Payee Details
<p>Use v4 instead</p> <p>Update payee details for the given Payee Id.<p>
actionPOSTv1.0.0
Update Payee Details
<p>Update payee details for the given Payee Id.</p> <p>Payors may only update the payee details if the payee has not yet onboarded</p>
actionPOSTv1.0.0
Update Payee Remote Id
<p>Use v4 instead</p> <p>Update the remote Id for the given Payee Id.</p>
actionPOSTv1.0.0
Update Payee Remote Id
<p>Update the remote Id for the given Payee Id.</p>
actionPOSTv1.0.0
Update User Details
<p>Update the profile details for the given user</p> <p>When updating Payor users with the role of payor.master_admin a verificationCode is required</p>
actionPOSTv1.0.0
Update User Details for self
<p>Update the profile details for the given user</p> <p>Only Payee user types are supported</p>
actionPOSTv1.0.0
Update User Role
<p>Update the user's Role</p>
actionGETv1.0.0
V1 Get Fundings for Payor
Deprecated (use /v4/paymentaudit/fundings)
actionGETv1.0.0
V1 Get Payout Statistics
Deprecated (Use /v4/paymentaudit/payoutStatistics)
actionGETv1.0.0
V1 List Payment Changes
Deprecated (use /v4/payments/deltas instead)
actionGETv1.0.0
V3 Get List of Payments
Deprecated (use /v4/paymentaudit/payments instead)
actionGETv1.0.0
V3 Get Payment
Deprecated (use /v4/paymentaudit/payments/<paymentId> instead)
actionGETv1.0.0
V3 Get Payments for Payout
Deprecated (use /v4/paymentaudit/payouts/<payoutId> instead)
actionGETv1.0.0
V3 Get Payouts for Payor
Deprecated (use /v4/paymentaudit/payouts instead)
actionPOSTv1.0.0
Validate the proposed password
validate the password and return a score
actionPOSTv1.0.0
Withdraw a Payment
<p>withdraw a payment </p> <p>There are a variety of reasons why this can fail</p> <ul> <li>the payment must be in a state of 'accepted' or 'unfunded'</li> <li>the payout must not be in a state of 'instructed'</li> </ul>
actionDELETEv1.0.0
Withdraw Payout
Withdraw Payout will remove the payout details from the rails but the payout will still be accessible in payout service in WITHDRAWN status.
Beyond the catalog
Any provider, on request.
01
Request it
Tell us which provider you need, and we will ship it in the registry.
02
Generate it
Point swirls add at an OpenAPI or GraphQL spec. Typed actions for any API you hold credentials for, today.
acme · integrations
terminal
~/acme $swirls add linear
✓ 12 typed actions · scopes and schemas included
~/acme $swirls add https://api.acme.dev/openapi.json
◆ Fetched spec · 38 operations
✓ 6 typed actions · generated from spec