Velo Payments APIs
  1. Payout Service
Velo Payments APIs
  • Login
    • Authentication endpoint
      POST
    • Logout
      POST
    • Reset password
      POST
    • validate
      POST
  • Funding Manager
    • Get Funding Audit Delta
      GET
    • Get Funding Accounts
      GET
    • Get Funding Account
      GET
    • Get list of source accounts
      GET
    • Get details about given source account.
      GET
    • Create Funding Request
      POST
    • Set notifications
      POST
    • Get Funding Accounts
      GET
    • Get Funding Account
      GET
    • Get list of source accounts
      GET
    • Get details about given source account.
      GET
    • Create Funding Request
      POST
    • Transfer Funds between source accounts
      POST
    • Get list of source accounts
      GET
    • Get details about given source account.
      GET
    • Create Funding Request
      POST
    • Transfer Funds between source accounts
      POST
  • Payment Audit Service (Deprecated)
    • V1 List Payment Changes
    • V1 Get Fundings for Payor
    • V1 Get Payout Statistics
    • V3 Get List of Payments
    • V3 Get Payment
    • V3 Get Payouts for Payor
    • V3 Get Payments for Payout
    • V3 Export Transactions
  • Countries
    • List Payment Channel Country Rules
    • List Supported Countries
    • List Supported Countries
  • Payout Service
    • Withdraw a Payment
      POST
    • Submit Payout
      POST
    • Withdraw Payout
      DELETE
    • Get Payout Summary
      GET
    • Instruct Payout
      POST
    • Retrieve payments for a payout
      GET
    • Create a quote for the payout
      POST
  • Payors
    • List Payor Links
    • Get Payor
    • Create Application
    • Create API Key
    • Get Branding
    • Add Logo
    • Reminder Email Opt-Out
    • Get Payor
  • Payors Private
    • Create a Payor Link
  • Webhooks
    • List the details about the webhooks for the given payor.
    • Create Webhook
    • Get details about the given webhook.
    • Update Webhook
    • /v1/webhooks/{webhookId}/ping
  • Currencies
    • List Supported Currencies
  • Funding Manager Private
    • Create Funding Account
    • Delete a source account by ID
  • Users
    • List Users
    • Invite a User
    • Register SMS Number
    • Get Self
    • Unregister MFA for Self
    • Update Password for self
    • Validate the proposed password
    • Update User Details for self
    • Delete a User
    • Get User
    • Disable a User
    • Enable a User
    • Unregister MFA for the user
    • Update User Role
    • Unlock a User
    • Update User Details
  • Tokens
    • Resend a token
  • Payees
    • List Payees
    • List Payee Changes
    • Delete Payee by Id
    • Get Payee by Id
    • Update Payee Details
    • Update Payee Remote Id
    • List Payees
    • List Payee Changes
    • Delete Payee by Id
    • Get Payee by Id
    • Update Payee Details
    • Update Payee Remote Id
  • Payee Invitation
    • Initiate Payee Creation
    • Query Batch Status
    • Get Payee Invitation Status
    • Resend Payee Invite
    • Initiate Payee Creation
    • Query Batch Status
    • Get Payee Invitation Status
    • Resend Payee Invite
  • Payment Audit Service
    • Get Fundings for Payor
    • Get List of Payments
    • Get Payment
    • Get Payout Statistics
    • Get Payouts for Payor
    • Get Payments for Payout
    • Export Transactions
    • List Payment Changes
  1. Payout Service

Instruct Payout

Velo Payments Sandbox for testing
https://api.sandbox.velopayments.com/
Velo Payments Sandbox for testing
https://api.sandbox.velopayments.com/
POST
/v3/payouts/{payoutId}
Instruct a payout to be made for the specified payoutId.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.sandbox.velopayments.com//v3/payouts/'
Response Response Example
202 - Example 1
{}

Request

Path Params

Responses

🟢202HTTP 202 Accepted
application/json
Body

🟠400Invalid request. See Error message payload for details of failure
🟠401Invalid access token. May be expired or invalid
🟠403The 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
🟠404The resource was not found or is no longer available
🟠409The request contained data that would result in a duplicate value
Modified at 2022-09-11 21:50:18
Previous
Get Payout Summary
Next
Retrieve payments for a payout
Built with