Velo Payments APIs
Terms and Definitions Throughout this document and the Velo platform the following terms are used: * Payor. An entity (typically a corporation) which wishes…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Terms and Definitions
Throughout this document and the Velo platform the following terms are used:
- Payor. An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout.
- Payee. The recipient of funds paid out by a payor.
- Payment. A single transfer of funds from a payor to a payee.
- Payout. A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee.
- Sandbox. An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking.
Overview
The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution:
- Authenticate with the Velo platform
- Maintain a collection of payees
- Query the payor’s current balance of funds within the platform and perform additional funding
- Issue payments to payees
- Query the platform for a history of those payments
This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference.
API Considerations
The Velo Payments API is REST based and uses the JSON format for requests and responses.
Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details.
Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters).
Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print.
Authenticating with the Velo Platform
Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner.
You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following:
create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529
base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==
create an HTTP Authorization header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==
perform the Velo authentication REST call using the HTTP header created above e.g. via curl:
curl -X POST \
-H "Content-Type: application/json" \
-H "Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==" \
'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials'If successful, this call will result in a 200 HTTP status code and a response body such as:
{
"access_token":"19f6bafd-93fd-4747-b229-00507bbc991f",
"token_type":"bearer",
"expires_in":1799,
"scope":"..."
}API access following authentication
Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated.
This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below:
-H "Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f "If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a 401 HTTP status response.
Endpoints 100
Payees
- GETList Payees
/v3/payees?payorId=3fa85f64-5717-4562-b3fc-2c963f66afa6&watchlistStatus=string&disabled=true&onboardedStatus=string&email=bob@example.com&displayName=Bob Smith&remoteId=remoteId123&payeeType=string&payeeCountry=US&page=1&pageSize=25&sort=displayName:ascDeprecated. <p>Use v4 instead</p> Get a paginated response listing the payees for a payor. - GETList Payee Changes
/v3/payees/deltas?payorId=3fa85f64-5717-4562-b3fc-2c963f66afa6&updatedSince=2024-01-01T00:00:00Z&page=1&pageSize=100Deprecated. <p>Use v4 instead</p> <p>Get a paginated response listing payee changes.</p> - GETGet Payee by Id
/v3/payees/:payeeId?sensitive=trueDeprecated. <p>Use v4 instead</p> <p>Get Payee by Id</p> - DELETEDelete Payee by Id
/v3/payees/:payeeIdDeprecated. <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… - POSTUpdate Payee Details
/v3/payees/:payeeId/payeeDetailsUpdateDeprecated. <p>Use v4 instead</p> <p>Update payee details for the given Payee Id.<p> - POSTUpdate Payee Remote Id
/v3/payees/:payeeId/remoteIdUpdateDeprecated. <p>Use v4 instead</p> <p>Update the remote Id for the given Payee Id.</p> - GETList Payees
/v4/payees?payorId=3fa85f64-5717-4562-b3fc-2c963f66afa6&watchlistStatus=string&disabled=true&onboardedStatus=string&email=bob@example.com&displayName=Bob Smith&remoteId=remoteId123&payeeType=string&payeeCountry=US&ofacStatus=string&page=1&pageSize=25&sort=displayName:ascGet a paginated response listing the payees for a payor. - GETList Payee Changes
/v4/payees/deltas?payorId=3fa85f64-5717-4562-b3fc-2c963f66afa6&updatedSince=2024-01-01T00:00:00Z&page=1&pageSize=100Get a paginated response listing payee changes (updated since a particular time) to a limited set of fields: dbaName displayName email onboardedStatus… - GETGet Payee by Id
/v4/payees/:payeeId?sensitive=trueGet Payee by Id - DELETEDelete Payee by Id
/v4/payees/:payeeId<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>… - POSTUpdate Payee Details
/v4/payees/:payeeId/payeeDetailsUpdate<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> - POSTUpdate Payee Remote Id
/v4/payees/:payeeId/remoteIdUpdate<p>Update the remote Id for the given Payee Id.</p>
Payee Invitation
- POSTInitiate Payee Creation
/v3/payeesDeprecated. <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 -… - GETQuery Batch Status
/v3/payees/batch/:batchIdDeprecated. <p>Use v4 instead</p> Fetch the status of a specific batch of payees. The batch is fully processed when status is ACCEPTED and pendingCount is 0 (… - GETGet Payee Invitation Status
/v3/payees/payors/:payorId/invitationStatus?payeeId=2aa5d7e0-2ecb-403f-8494-1865ed0454e9&invitationStatus=string&page=1&pageSize=25Deprecated. <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… - POSTResend Payee Invite
/v3/payees/:payeeId/inviteDeprecated. <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>… - POSTInitiate Payee Creation
/v4/payees<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… - GETQuery Batch Status
/v4/payees/batch/:batchIdFetch the status of a specific batch of payees. The batch is fully processed when status is ACCEPTED and pendingCount is 0 ( 200 - OK, 404 - batch not found ). - GETGet Payee Invitation Status
/v4/payees/payors/:payorId/invitationStatus?payeeId=2aa5d7e0-2ecb-403f-8494-1865ed0454e9&invitationStatus=string&page=1&pageSize=25Returns a filtered, paginated list of payees associated with a payor, along with invitation status and grace period end date. - POSTResend Payee Invite
/v4/payees/:payeeId/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…
Payors
- GETGet Payor
/v1/payors/:payorIdDeprecated. <p>Get a Single Payor by Id.</p> <p>deprecated since v2.10 - Use /v2/payors - POSTCreate Application
/v1/payors/:payorId/applications<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… - POSTCreate API Key
/v1/payors/:payorId/applications/:applicationId/keys<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… - GETGet Branding
/v1/payors/:payorId/brandingGet the payor branding details. - POSTAdd Logo
/v1/payors/:payorId/branding/logos<p>Add Payor Logo</p> <p>Logo file is used in your branding and emails sent to payees</p> - POSTReminder Email Opt-Out
/v1/payors/:payorId/reminderEmailsUpdateUpdate 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… - GETGet Payor
/v2/payors/:payorIdGet a Single Payor by Id.
Payor Hierarchy
- GETList Payor Links
/v1/payorLinks?descendantsOfPayor=3fa85f64-5717-4562-b3fc-2c963f66afa6&parentOfPayor=3fa85f64-5717-4562-b3fc-2c963f66afa6&fields=string<p>If the payor is set up as part of a hierarchy you can use this API to traverse the hierarchy</p>
Payouts
- POSTWithdraw a Payment
/v1/payments/:paymentId/withdraw<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>… - POSTSubmit Payout
/v3/payouts<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… - GETGet Payout Summary
/v3/payouts/:payoutIdGet payout summary - returns the current state of the payout. - POSTInstruct Payout
/v3/payouts/:payoutIdInstruct a payout to be made for the specified payoutId. - DELETEWithdraw Payout
/v3/payouts/:payoutIdWithdraw Payout will remove the payout details from the rails but the payout will still be accessible in payout service in WITHDRAWN status. - GETRetrieve payments for a payout
/v3/payouts/:payoutId/payments?status=ACCEPTED&remoteId=string&payorPaymentId=string&sourceAccountName=string&transmissionType=ACH&paymentMemo=string&pageSize=25&page=1Retrieve payments for a payout - POSTCreate a quote for the payout
/v3/payouts/:payoutId/quoteCreate quote for a payout - POSTSchedule a payout
/v3/payouts/:payoutId/schedule<p>Schedule a payout for auto-instruction in the future or update existing payout schedule if the payout has been scheduled before.</p> - DELETEDeschedule a payout
/v3/payouts/:payoutId/scheduleRemove the schedule for a scheduled payout
Funding
- GETGet Funding Audit Delta
/v1/deltas/fundings?payorId=3fa85f64-5717-4562-b3fc-2c963f66afa6&updatedSince=2024-01-01T00:00:00Z&page=1&pageSize=25Get funding audit deltas for a payor - GETGet Funding
/v1/fundings/:fundingIdGet Funding by Id - GETGet Funding Accounts
/v2/fundingAccounts?payorId=3fa85f64-5717-4562-b3fc-2c963f66afa6&name=string&country=US¤cy=USD&type=FBO&page=1&pageSize=25&sort=accountName:asc&sensitive=falseGet the funding accounts. - GETGet Funding Account
/v2/fundingAccounts/:fundingAccountId?sensitive=falseGet Funding Account by ID - POSTCreate Funding Request
/v2/sourceAccounts/:sourceAccountId/fundingRequestDeprecated. 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… - POSTCreate Funding Request
/v3/sourceAccounts/:sourceAccountId/fundingRequest<p>Instruct a funding request to transfer funds from the payor’s funding bank to the payor’s balance held within Velo</p>
Source Accounts
- POSTSet notifications
/v1/sourceAccounts/:sourceAccountId/notificationsDeprecated. <p>Set notifications for a given source account</p> <p>deprecated since 2.34 (use v3 version)</p> - GETGet list of source accounts
/v2/sourceAccounts?physicalAccountName=string&physicalAccountId=3fa85f64-5717-4562-b3fc-2c963f66afa6&payorId=3fa85f64-5717-4562-b3fc-2c963f66afa6&fundingAccountId=3fa85f64-5717-4562-b3fc-2c963f66afa6&page=1&pageSize=25&sort=fundingRef:ascDeprecated. List source accounts. - GETGet Source Account
/v2/sourceAccounts/:sourceAccountIdDeprecated. Get details about given source account. - POSTTransfer Funds between source accounts
/v2/sourceAccounts/:sourceAccountId/transfersDeprecated. 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.… - GETGet list of source accounts
/v3/sourceAccounts?physicalAccountName=string&physicalAccountId=3fa85f64-5717-4562-b3fc-2c963f66afa6&payorId=3fa85f64-5717-4562-b3fc-2c963f66afa6&fundingAccountId=3fa85f64-5717-4562-b3fc-2c963f66afa6&includeUserDeleted=string&type=string&page=1&pageSize=25&sort=fundingRef:ascList source accounts. - GETGet details about given source account.
/v3/sourceAccounts/:sourceAccountIdGet details about given source account. - POSTSet notifications
/v3/sourceAccounts/:sourceAccountId/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… - POSTTransfer Funds between source accounts
/v3/sourceAccounts/:sourceAccountId/transfersTransfer 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'…
Payment Audit Service
- GETGet Fundings for Payor
/v4/paymentaudit/fundings?payorId=3fa85f64-5717-4562-b3fc-2c963f66afa6&sourceAccountName=string&page=1&pageSize=25&sort=string<p>Get a list of Fundings for a payor.</p> - GETGet List of Payments
/v4/paymentaudit/payments?payeeId=3fa85f64-5717-4562-b3fc-2c963f66afa6&payorId=3fa85f64-5717-4562-b3fc-2c963f66afa6&payorName=string&remoteId=string&remoteSystemId=string&status=ACCEPTED&transmissionType=ACH&sourceAccountName=string&sourceAmountFrom=0&sourceAmountTo=0&sourceCurrency=string&paymentAmountFrom=0&paymentAmountTo=0&paymentCurrency=string&submittedDateFrom=2024-01-01&submittedDateTo=2024-01-01&paymentMemo=string&railsId=string&scheduledForDateFrom=2024-01-01&scheduledForDateTo=2024-01-01&scheduleStatus=ANY&postInstructFxStatus=ANY&page=1&pageSize=25&sort=string&sensitive=trueGet payments for the given payor Id - GETGet Payment
/v4/paymentaudit/payments/:paymentId?sensitive=trueGet the payment with the given id. This contains the payment history. - GETGet Payout Statistics
/v4/paymentaudit/payoutStatistics?payorId=3fa85f64-5717-4562-b3fc-2c963f66afa6<p>Get payout statistics for a payor.</p> - GETGet Payouts for Payor
/v4/paymentaudit/payouts?payorId=3fa85f64-5717-4562-b3fc-2c963f66afa6&payoutMemo=string&status=ACCEPTED&submittedDateFrom=2024-01-01&submittedDateTo=2024-01-01&fromPayorName=string&scheduledForDateFrom=2024-01-01&scheduledForDateTo=2024-01-01&scheduleStatus=ANY&page=1&pageSize=25&sort=stringGet List of payouts for payor - GETGet Payments for Payout
/v4/paymentaudit/payouts/:payoutId?remoteId=string&remoteSystemId=string&status=ACCEPTED&sourceAmountFrom=0&sourceAmountTo=0&paymentAmountFrom=0&paymentAmountTo=0&submittedDateFrom=2024-01-01&submittedDateTo=2024-01-01&transmissionType=ACH&page=1&pageSize=25&sort=string&sensitive=trueGet List of payments for Payout, allowing for RETURNED status - GETExport Transactions
/v4/paymentaudit/transactions?payorId=3fa85f64-5717-4562-b3fc-2c963f66afa6&startDate=2024-01-01&endDate=2024-01-01&include=payorOnlyDownload a CSV file containing payments in a date range. Uses Transfer-Encoding - chunked to stream to the client. Date range is inclusive of both the start… - GETList Payment Changes
/v4/payments/deltas?payorId=3fa85f64-5717-4562-b3fc-2c963f66afa6&updatedSince=2024-01-01T00:00:00Z&page=1&pageSize=100Get a paginated response listing payment changes.
Tokens
- POSTResend a token
/v2/users/:userId/tokens<p>Resend the specified token </p> <p>The token to resend must already exist for the user </p> <p>It will be revoked and a new one issued</p>
Login
- POSTAuthentication endpoint
/v1/authenticate?grant_type=client_credentials<p>Use this endpoint to obtain an access token for calling Velo Payments APIs. </p> <p>You need your API key and API secret issued by Velo</p> <p>To login and… - POSTLogout
/v1/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> - POSTReset password
/v1/password/reset<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… - POSTvalidate
/v1/validate<p>The second part of login involves validating using an MFA device</p> <p>An access token with PRE_AUTH authorities is required</p>
Payment Audit Service (Deprecated)
- GETV1 List Payment Changes
/v1/deltas/payments?payorId=3fa85f64-5717-4562-b3fc-2c963f66afa6&updatedSince=2024-01-01T00:00:00Z&page=1&pageSize=100Deprecated. Deprecated (use /v4/payments/deltas instead) - GETV1 Get Fundings for Payor
/v1/paymentaudit/fundings?payorId=3fa85f64-5717-4562-b3fc-2c963f66afa6&page=1&pageSize=25&sort=stringDeprecated. Deprecated (use /v4/paymentaudit/fundings) - GETV1 Get Payout Statistics
/v1/paymentaudit/payoutStatistics?payorId=3fa85f64-5717-4562-b3fc-2c963f66afa6Deprecated. Deprecated (Use /v4/paymentaudit/payoutStatistics) - GETV3 Get List of Payments
/v3/paymentaudit/payments?payeeId=3fa85f64-5717-4562-b3fc-2c963f66afa6&payorId=3fa85f64-5717-4562-b3fc-2c963f66afa6&payorName=string&remoteId=string&status=ACCEPTED&sourceAccountName=string&sourceAmountFrom=0&sourceAmountTo=0&sourceCurrency=string&paymentAmountFrom=0&paymentAmountTo=0&paymentCurrency=string&submittedDateFrom=2024-01-01&submittedDateTo=2024-01-01&paymentMemo=string&page=1&pageSize=25&sort=string&sensitive=trueDeprecated. Deprecated (use /v4/paymentaudit/payments instead) - GETV3 Get Payment
/v3/paymentaudit/payments/:paymentId?sensitive=trueDeprecated. Deprecated (use /v4/paymentaudit/payments/<paymentId> instead) - GETV3 Get Payouts for Payor
/v3/paymentaudit/payouts?payorId=3fa85f64-5717-4562-b3fc-2c963f66afa6&payoutMemo=string&status=ACCEPTED&submittedDateFrom=2024-01-01&submittedDateTo=2024-01-01&page=1&pageSize=25&sort=stringDeprecated. Deprecated (use /v4/paymentaudit/payouts instead) - GETV3 Get Payments for Payout
/v3/paymentaudit/payouts/:payoutId?remoteId=string&status=ACCEPTED&sourceAmountFrom=0&sourceAmountTo=0&paymentAmountFrom=0&paymentAmountTo=0&submittedDateFrom=2024-01-01&submittedDateTo=2024-01-01&page=1&pageSize=25&sort=string&sensitive=trueDeprecated. Deprecated (use /v4/paymentaudit/payouts/<payoutId> instead) - GETV3 Export Transactions
/v3/paymentaudit/transactions?payorId=3fa85f64-5717-4562-b3fc-2c963f66afa6&startDate=2024-01-01&endDate=2024-01-01Deprecated. Deprecated (use /v4/paymentaudit/transactions instead)
Countries
- GETList Payment Channel Country Rules
/v1/paymentChannelRulesList the country specific payment channel rules. - GETList Supported Countries
/v1/supportedCountriesDeprecated. <p>List the supported countries.</p> <p>This version will be retired in March 2020. Use /v2/supportedCountries</p> - GETList Supported Countries
/v2/supportedCountriesList the supported countries.
Payors Private
- POSTCreate a Payor Link
/v1/payorLinksThis endpoint allows you to create a payor link.
Webhooks
- GETList the details about the webhooks for the given payor.
/v1/webhooks?page=1&pageSize=25&payorId=3fa85f64-5717-4562-b3fc-2c963f66afa6List the details about the webhooks for the given payor. - POSTCreate Webhook
/v1/webhooksCreate Webhook - GETGet details about the given webhook.
/v1/webhooks/:webhookIdGet details about the given webhook. - POSTUpdate Webhook
/v1/webhooks/:webhookIdUpdate Webhook - POSTpingWebhookV1
/v1/webhooks/:webhookId/ping
Currencies
- GETList Supported Currencies
/v2/currenciesList the supported currencies.
Funding Manager Private
- POSTCreate Funding Account
/v2/fundingAccountsCreate Funding Account - DELETEDelete a source account by ID
/v3/sourceAccounts/:sourceAccountIdMark a source account as deleted by ID
Users
- GETList Users
/v2/users?type=PAYOR&status=ENABLED&entityId=3fa85f64-5717-4562-b3fc-2c963f66afa6&payeeType=COMPANY&page=1&pageSize=25&sort=email:ascGet a paginated response listing the Users - POSTInvite a User
/v2/users/inviteCreate a User and invite them to the system - POSTRegister SMS Number
/v2/users/registration/sms<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… - GETGet Self
/v2/users/selfGet the user's details - POSTUnregister MFA for Self
/v2/users/self/mfa/unregister<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… - POSTUpdate Password for self
/v2/users/self/passwordUpdate password for self - POSTValidate the proposed password
/v2/users/self/password/validatevalidate the password and return a score - POSTUpdate User Details for self
/v2/users/self/userDetailsUpdate<p>Update the profile details for the given user</p> <p>Only Payee user types are supported</p> - GETGet User
/v2/users/:userIdGet a Single User by Id. - DELETEDelete a User
/v2/users/:userIdDelete User by Id. - POSTDisable a User
/v2/users/:userId/disable<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>… - POSTEnable a User
/v2/users/:userId/enable<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… - POSTUnregister MFA for the user
/v2/users/:userId/mfa/unregister<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… - POSTUpdate User Role
/v2/users/:userId/roleUpdate<p>Update the user's Role</p> - POSTUnlock a User
/v2/users/:userId/unlockIf a user is locked this endpoint will unlock them - POSTUpdate User Details
/v2/users/:userId/userDetailsUpdate<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>
API details
- Base URL
https://api.sandbox.velopayments.comhttps://api.payouts.velopayments.com- Authentication
- OAuth 2.0 (client credentials flow) with 1 scope
HTTP Basic authentication (username and password)
OAuth 2.0 (client credentials flow) with 1 scope - Operations
- 100 operations on 87 pathsGET 49POST 45DELETE 6
25 marked deprecated - Main resources
- Users 17Payees 12Payouts 9Payee Invitation 8Payment Audit Service 8Payment Audit Service (Deprecated) 8Source Accounts 8Payors 7Funding 6Webhooks 5
- Response formats
application/jsonapplication/csv- Description format
- OpenAPI 3.0.2, API version
2.34.63 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Velo Payments APIs in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Velo Payments APIs collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (client credentials flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “List Payees” (GET /v3/payees?payorId=3fa85f64-5717-4562-b3fc-2c963f66afa6&watchlistStatus=string&disabled=true&onboardedStatus=string&email=bob@example.com&displayName=Bob Smith&remoteId=remoteId123&payeeType=string&payeeCountry=US&page=1&pageSize=25&sort=displayName:asc), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Velo Payments APIs?
Terms and Definitions Throughout this document and the Velo platform the following terms are used: * Payor. An entity (typically a corporation) which wishes… It is listed under E-commerce and has 100 endpoints.
Who publishes the Velo Payments APIs?
It is listed from Velopayments's public API description (an OpenAPI document), not published by Velopayments on Swastik Codes. Anyone who controls velopayments.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Velo Payments APIs?
Its description lists 2 base URLs: https://api.sandbox.velopayments.com, https://api.payouts.velopayments.com. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the Velo Payments APIs?
It accepts 3 methods: OAuth 2.0 (client credentials flow) with 1 scope; HTTP Basic authentication (username and password); OAuth 2.0 (client credentials flow) with 1 scope.
How many endpoints does the Velo Payments APIs have?
100 operations on 87 paths (49 GET, 45 POST, 6 DELETE). The largest groups are Users, Payees, Payouts, Payee Invitation.
Is forking the Velo Payments APIs free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.