## 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 tran
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://api.sandbox.velopayments.com https://api.payouts.velopayments.com
auth: b a s i c ,
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
## 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
| method | path | what the vendor says it does |
|---|---|---|
POST | /v1/authenticate | Authentication endpoint Use this endpoint to obtain an access token for calling Velo Payments APIs. You need |
GET | /v1/deltas/fundings | Get Funding Audit Delta Get funding audit deltas for a payor Funding |
GET | /v1/deltas/payments | V1 List Payment Changes Deprecated (use /v4/payments/deltas instead) Payment Audit Service (Deprecated) |
GET | /v1/fundings/{fundingId} | Get Funding Get Funding by Id Funding |
POST | /v1/logout | Logout Given a valid access token in the header then log out the authenticated user or client Will revoke the |
POST | /v1/password/reset | Reset password Reset password An email with an embedded link will be sent to the receipient of the email addr |
GET | /v1/paymentChannelRules | List Payment Channel Country Rules List the country specific payment channel rules. Countries |
GET | /v1/paymentaudit/fundings | V1 Get Fundings for Payor Deprecated (use /v4/paymentaudit/fundings) Payment Audit Service (Deprecated) |
GET | /v1/paymentaudit/payoutStatistics | V1 Get Payout Statistics Deprecated (Use /v4/paymentaudit/payoutStatistics) Payment Audit Service (Deprecated) |
POST | /v1/payments/{paymentId}/withdraw | Withdraw a Payment withdraw a payment There are a variety of reasons why this can fail the payment must |
GET | /v1/payorLinks | List Payor Links If the payor is set up as part of a hierarchy you can use this API to traverse the hierarchy |
POST | /v1/payorLinks | Create a Payor Link This endpoint allows you to create a payor link. Payors Private |
GET | /v1/payors/{payorId} | Get Payor Get a Single Payor by Id. deprecated since v2.10 - Use /v2/payors Payors |
POST | /v1/payors/{payorId}/applications | Create Application Create an application for the given Payor ID. Applications provide a means to group your AP |
POST | /v1/payors/{payorId}/applications/{applicationId}/keys | Create API Key Create an an API key for the given payor Id and application Id You can create multiple API Keys |
GET | /v1/payors/{payorId}/branding | Get Branding Get the payor branding details. Payors |
POST | /v1/payors/{payorId}/branding/logos | Add Logo Add Payor Logo Logo file is used in your branding and emails sent to payees Payors |
POST | /v1/payors/{payorId}/reminderEmailsUpdate | Reminder Email Opt-Out Update the emailRemindersOptOut field for a Payor. This API can be used to opt out or o |
POST | /v1/sourceAccounts/{sourceAccountId}/notifications | Set notifications Set notifications for a given source account deprecated since 2.34 (use v3 version) Source A |
GET | /v1/supportedCountries | List Supported Countries List the supported countries. This version will be retired in March 2020. Use /v2/sup |
POST | /v1/validate | validate The second part of login involves validating using an MFA device An access token with PRE_AUTH author |
GET | /v1/webhooks | List the details about the webhooks for the given payor. List the details about the webhooks for the given pay |
POST | /v1/webhooks | Create Webhook Create Webhook Webhooks |
GET | /v1/webhooks/{webhookId} | Get details about the given webhook. Get details about the given webhook. Webhooks |
POST | /v1/webhooks/{webhookId} | Update Webhook Update Webhook Webhooks |
GET | /v2/currencies | List Supported Currencies List the supported currencies. Currencies |
GET | /v2/fundingAccounts | Get Funding Accounts Get the funding accounts. Funding |
POST | /v2/fundingAccounts | Create Funding Account Create Funding Account Funding Manager Private |
GET | /v2/fundingAccounts/{fundingAccountId} | Get Funding Account Get Funding Account by ID Funding |
GET | /v2/payors/{payorId} | Get Payor Get a Single Payor by Id. Payors |
GET | /v2/sourceAccounts | Get list of source accounts List source accounts. Source Accounts |
GET | /v2/sourceAccounts/{sourceAccountId} | Get Source Account Get details about given source account. Source Accounts |
POST | /v2/sourceAccounts/{sourceAccountId}/fundingRequest | Create Funding Request Instruct a funding request to transfer funds from the payor’s funding bank to the payor |
POST | /v2/sourceAccounts/{sourceAccountId}/transfers | Transfer Funds between source accounts Transfer funds between source accounts for a Payor. The 'from' source a |
GET | /v2/supportedCountries | List Supported Countries List the supported countries. Countries |
GET | /v2/users | List Users Get a paginated response listing the Users Users |
POST | /v2/users/invite | Invite a User Create a User and invite them to the system Users |
POST | /v2/users/registration/sms | Register SMS Number Register an Sms number and send an OTP to it Used for manual verification of a user The |
GET | /v2/users/self | Get Self Get the user's details Users |
POST | /v2/users/self/mfa/unregister | Unregister MFA for Self Unregister the MFA device for the user If the user does not require further verificat |
and 59 more operation(s) in this specification, all searchable.
specification origin: https://raw.githubusercontent.com/velopaymentsapi/VeloOpenApi/master/spec/openapi.yaml
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.