New payout request

loading...

POST

/payouts

Send

Header

Body

Payouts are only available when using Volt Connect

This will create a payout request to send funds from your Connect account to a beneficiary. For regulatory purposes, it's a closed-loop payout system, meaning you may only payout funds to a person or organisation you've previously received money from using Volt Connect.

Usage

Pass the details of the payout you'd like to make in the body of the request.

Approval

Payouts don't require approval if you create them using the API. If you need to review payouts before sending, this workflow should take place on your own system before you call this endpoint.

More information

Full details on payouts can be found in our comprehensive integration guides.

Header Parameters

Details of the payout you'd like to create

Response Body

curl -X POST "https://connect-api-sandbox.volt.io/payouts" \  -H "Content-Type: application/json" \  -d '{}'

{
  "id": "93b85f3c-76eb-4316-b1ae-f3370ddc59bc"
}

{
  "exception": {
    "code": 400,
    "message": "Validation exception",
    "errorList": [
      {
        "property": "currency",
        "message": "This value is not a valid currency"
      }
    ]
  }
}

{
  "exception": {
    "code": 403,
    "message": "Payouts are not enabled for your account"
  }
}

{
  "exception": {
    "code": 403,
    "message": "A resource has already been created with this idempotency key."
  }
}

{
  "exception": {
    "code": 422,
    "message": "You cannot send payouts to this beneficiary"
  }
}