# Velo Payments APIs ## API Docs - Login [Authentication endpoint](https://9s88b112dp.apidog.io/api-3536019.md): Use this endpoint to obtain an access token for calling Velo Payments APIs. Use HTTP Basic Auth. String value of - Login [Logout](https://9s88b112dp.apidog.io/api-3536002.md):

Given a valid access token in the header then log out the authenticated user or client

- Login [Reset password](https://9s88b112dp.apidog.io/api-3536000.md):

Reset password

- Login [validate](https://9s88b112dp.apidog.io/api-3536003.md):

The second part of login involves validating using an MFA device

- Funding Manager [Get Funding Audit Delta](https://9s88b112dp.apidog.io/api-3536004.md): Get funding audit deltas for a payor - Funding Manager [Get Funding Accounts](https://9s88b112dp.apidog.io/api-3536017.md): Get the funding accounts. - Funding Manager [Get Funding Account](https://9s88b112dp.apidog.io/api-3536014.md): Get Funding Account by ID - Funding Manager [Get list of source accounts](https://9s88b112dp.apidog.io/api-3536006.md): List source accounts. - Funding Manager [Get details about given source account.](https://9s88b112dp.apidog.io/api-3536005.md): Get details about given source account. - Funding Manager [Create Funding Request](https://9s88b112dp.apidog.io/api-3536007.md): Instruct a funding request to transfer funds from the payor’s funding bank to the payor’s balance held within Velo. - Funding Manager [Set notifications](https://9s88b112dp.apidog.io/api-3536012.md): Set notifications for a given source account - Funding Manager [Get Funding Accounts](https://9s88b112dp.apidog.io/api-3536001.md): Get the funding accounts. - Funding Manager [Get Funding Account](https://9s88b112dp.apidog.io/api-3536016.md): Get Funding Account by ID - Funding Manager [Get list of source accounts](https://9s88b112dp.apidog.io/api-3536009.md): List source accounts. - Funding Manager [Get details about given source account.](https://9s88b112dp.apidog.io/api-3536010.md): Get details about given source account. - Funding Manager [Create Funding Request](https://9s88b112dp.apidog.io/api-3536018.md): 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). - Funding Manager [Transfer Funds between source accounts](https://9s88b112dp.apidog.io/api-3536013.md): 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. - Funding Manager [Get list of source accounts](https://9s88b112dp.apidog.io/api-3536011.md): List source accounts. - Funding Manager [Get details about given source account.](https://9s88b112dp.apidog.io/api-3536008.md): Get details about given source account. - Funding Manager [Create Funding Request](https://9s88b112dp.apidog.io/api-3536015.md): 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). - Funding Manager [Transfer Funds between source accounts](https://9s88b112dp.apidog.io/api-3536020.md): 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. - Payment Audit Service (Deprecated) [V1 List Payment Changes](https://9s88b112dp.apidog.io/api-3536021.md): Deprecated (use /v4/payments/deltas instead) - Payment Audit Service (Deprecated) [V1 Get Fundings for Payor](https://9s88b112dp.apidog.io/api-3536022.md): Deprecated (use /v4/paymentaudit/fundings) - Payment Audit Service (Deprecated) [V1 Get Payout Statistics](https://9s88b112dp.apidog.io/api-3536023.md): Deprecated (Use /v4/paymentaudit/payoutStatistics) - Payment Audit Service (Deprecated) [V3 Get List of Payments](https://9s88b112dp.apidog.io/api-3536024.md): Deprecated (use /v4/paymentaudit/payments instead) - Payment Audit Service (Deprecated) [V3 Get Payment](https://9s88b112dp.apidog.io/api-3536025.md): Deprecated (use /v4/paymentaudit/payments/ instead) - Payment Audit Service (Deprecated) [V3 Get Payouts for Payor](https://9s88b112dp.apidog.io/api-3536026.md): Deprecated (use /v4/paymentaudit/payouts instead) - Payment Audit Service (Deprecated) [V3 Get Payments for Payout](https://9s88b112dp.apidog.io/api-3536027.md): Deprecated (use /v4/paymentaudit/payouts/ instead) - Payment Audit Service (Deprecated) [V3 Export Transactions](https://9s88b112dp.apidog.io/api-3536029.md): Deprecated (use /v4/paymentaudit/transactions instead) - Countries [List Payment Channel Country Rules](https://9s88b112dp.apidog.io/api-3536028.md): List the country specific payment channel rules. - Countries [List Supported Countries](https://9s88b112dp.apidog.io/api-3536030.md):

List the supported countries.

- Countries [List Supported Countries](https://9s88b112dp.apidog.io/api-3536031.md): List the supported countries. - Payout Service [Withdraw a Payment](https://9s88b112dp.apidog.io/api-3536038.md):

withdraw a payment

- Payout Service [Submit Payout](https://9s88b112dp.apidog.io/api-3536037.md):

Create a new payout and return a location header with a link to get the payout.

- Payout Service [Withdraw Payout](https://9s88b112dp.apidog.io/api-3536036.md): Withdraw Payout will delete payout details from payout service and rails services but will just move the status of the payout to WITHDRAWN in payment audit. - Payout Service [Get Payout Summary](https://9s88b112dp.apidog.io/api-3536035.md): Get payout summary - returns the current state of the payout. - Payout Service [Instruct Payout](https://9s88b112dp.apidog.io/api-3536040.md): Instruct a payout to be made for the specified payoutId. - Payout Service [Retrieve payments for a payout](https://9s88b112dp.apidog.io/api-3536032.md): Retrieve payments for a payout - Payout Service [Create a quote for the payout](https://9s88b112dp.apidog.io/api-3536033.md): Create quote for a payout - Payors [List Payor Links](https://9s88b112dp.apidog.io/api-3536039.md): This endpoint allows you to list payor links - Payors [Get Payor](https://9s88b112dp.apidog.io/api-3536034.md): Get a Single Payor by Id. - Payors [Create Application](https://9s88b112dp.apidog.io/api-3536041.md): Create an application for the given Payor ID. Applications are programatic users which can be assigned unique keys. - Payors [Create API Key](https://9s88b112dp.apidog.io/api-3536042.md): Create an an API key for the given payor Id and application Id - Payors [Get Branding](https://9s88b112dp.apidog.io/api-3536043.md): Get the payor branding details. - Payors [Add Logo](https://9s88b112dp.apidog.io/api-3536044.md): Add Payor Logo. Logo file is used in your branding, and emails sent to payees. - Payors [Reminder Email Opt-Out](https://9s88b112dp.apidog.io/api-3536045.md): Update the emailRemindersOptOut field for a Payor. This API can be used to opt out - Payors [Get Payor](https://9s88b112dp.apidog.io/api-3536046.md): Get a Single Payor by Id. - Payors Private [Create a Payor Link](https://9s88b112dp.apidog.io/api-3536047.md): This endpoint allows you to create a payor link. - Webhooks [List the details about the webhooks for the given payor.](https://9s88b112dp.apidog.io/api-3536048.md): List the details about the webhooks for the given payor. - Webhooks [Create Webhook](https://9s88b112dp.apidog.io/api-3536050.md): Create Webhook - Webhooks [Get details about the given webhook.](https://9s88b112dp.apidog.io/api-3536049.md): Get details about the given webhook. - Webhooks [Update Webhook](https://9s88b112dp.apidog.io/api-3536051.md): Update Webhook - Webhooks [/v1/webhooks/{webhookId}/ping](https://9s88b112dp.apidog.io/api-3536054.md): - Currencies [List Supported Currencies](https://9s88b112dp.apidog.io/api-3536052.md): List the supported currencies. - Funding Manager Private [Create Funding Account](https://9s88b112dp.apidog.io/api-3536053.md): Create Funding Account - Funding Manager Private [Delete a source account by ID](https://9s88b112dp.apidog.io/api-3536055.md): Mark a source account as deleted by ID - Users [List Users](https://9s88b112dp.apidog.io/api-3536056.md): Get a paginated response listing the Users - Users [Invite a User](https://9s88b112dp.apidog.io/api-3536058.md): Create a User and invite them to the system - Users [Register SMS Number](https://9s88b112dp.apidog.io/api-3536057.md):

Register an Sms number and send an OTP to it

- Users [Get Self](https://9s88b112dp.apidog.io/api-3536059.md): Get the user's details - Users [Unregister MFA for Self](https://9s88b112dp.apidog.io/api-3536060.md):

Unregister the MFA device for the user

- Users [Update Password for self](https://9s88b112dp.apidog.io/api-3536061.md): Update password for self - Users [Validate the proposed password](https://9s88b112dp.apidog.io/api-3536062.md): validate the password and return a score - Users [Update User Details for self](https://9s88b112dp.apidog.io/api-3536063.md):

Update the profile details for the given user

- Users [Delete a User](https://9s88b112dp.apidog.io/api-3536065.md): Delete User by Id. - Users [Get User](https://9s88b112dp.apidog.io/api-3536064.md): Get a Single User by Id. - Users [Disable a User](https://9s88b112dp.apidog.io/api-3536067.md):

If a user is enabled this endpoint will disable them

- Users [Enable a User](https://9s88b112dp.apidog.io/api-3536066.md):

If a user has been disabled this endpoints will enable them

- Users [Unregister MFA for the user](https://9s88b112dp.apidog.io/api-3536069.md):

Unregister the MFA device for the user

- Users [Update User Role](https://9s88b112dp.apidog.io/api-3536068.md):

Update the user's Role

- Users [Unlock a User](https://9s88b112dp.apidog.io/api-3536070.md): If a user is locked this endpoint will unlock them - Users [Update User Details](https://9s88b112dp.apidog.io/api-3536072.md):

Update the profile details for the given user

- Tokens [Resend a token](https://9s88b112dp.apidog.io/api-3536071.md):

Resend the specified token

- Payees [List Payees](https://9s88b112dp.apidog.io/api-3536073.md):

Use v4 instead

- Payees [List Payee Changes](https://9s88b112dp.apidog.io/api-3536074.md):

Use v4 instead

- Payees [Delete Payee by Id](https://9s88b112dp.apidog.io/api-3536075.md):

Use v4 instead

- Payees [Get Payee by Id](https://9s88b112dp.apidog.io/api-3536077.md):

Use v4 instead

- Payees [Update Payee Details](https://9s88b112dp.apidog.io/api-3536076.md):

Use v4 instead

- Payees [Update Payee Remote Id](https://9s88b112dp.apidog.io/api-3536078.md):

Use v4 instead

- Payees [List Payees](https://9s88b112dp.apidog.io/api-3536082.md): Get a paginated response listing the payees for a payor. - Payees [List Payee Changes](https://9s88b112dp.apidog.io/api-3536079.md): Get a paginated response listing payee changes (updated since a particular time) to a limited set of fields: - Payees [Delete Payee by Id](https://9s88b112dp.apidog.io/api-3536081.md):

This API will delete Payee by Id (UUID). Deletion by ID is not allowed if:

- Payees [Get Payee by Id](https://9s88b112dp.apidog.io/api-3536080.md): Get Payee by Id - Payees [Update Payee Details](https://9s88b112dp.apidog.io/api-3536084.md):

Update payee details for the given Payee Id.

- Payees [Update Payee Remote Id](https://9s88b112dp.apidog.io/api-3536083.md):

Update the remote Id for the given Payee Id.

- Payee Invitation [Initiate Payee Creation](https://9s88b112dp.apidog.io/api-3536085.md):

Use v4 instead

- Payee Invitation [Query Batch Status](https://9s88b112dp.apidog.io/api-3536086.md):

Use v4 instead

- Payee Invitation [Get Payee Invitation Status](https://9s88b112dp.apidog.io/api-3536087.md):

Use v4 instead

- Payee Invitation [Resend Payee Invite](https://9s88b112dp.apidog.io/api-3536089.md):

Use v4 instead

- Payee Invitation [Initiate Payee Creation](https://9s88b112dp.apidog.io/api-3536088.md): Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query - Payee Invitation [Query Batch Status](https://9s88b112dp.apidog.io/api-3536090.md): Fetch the status of a specific batch of payees. The batch is fully processed when status is ACCEPTED and pendingCount is 0 ( 200 - OK, 404 - batch not found ). - Payee Invitation [Get Payee Invitation Status](https://9s88b112dp.apidog.io/api-3536091.md): Returns a filtered, paginated list of payees associated with a payor, along with invitation status and grace period end date. - Payee Invitation [Resend Payee Invite](https://9s88b112dp.apidog.io/api-3536093.md):

Resend an invite to the Payee The payee must have already been invited by the payor and not yet accepted or declined

- Payment Audit Service [Get Fundings for Payor](https://9s88b112dp.apidog.io/api-3536092.md):

Get a list of Fundings for a payor.

- Payment Audit Service [Get List of Payments](https://9s88b112dp.apidog.io/api-3536095.md): Get payments for the given payor Id - Payment Audit Service [Get Payment](https://9s88b112dp.apidog.io/api-3536097.md): Get the payment with the given id. This contains the payment history. - Payment Audit Service [Get Payout Statistics](https://9s88b112dp.apidog.io/api-3536094.md):

Get payout statistics for a payor.

- Payment Audit Service [Get Payouts for Payor](https://9s88b112dp.apidog.io/api-3536096.md): Get List of payouts for payor - Payment Audit Service [Get Payments for Payout](https://9s88b112dp.apidog.io/api-3536099.md): Get List of payments for Payout, allowing for RETURNED status - Payment Audit Service [Export Transactions](https://9s88b112dp.apidog.io/api-3536098.md): Download a CSV file containing payments in a date range. Uses Transfer-Encoding - chunked to stream to the client. Date range is inclusive of both the start and end dates. - Payment Audit Service [List Payment Changes](https://9s88b112dp.apidog.io/api-3536100.md): Get a paginated response listing payment changes.