---
title: "Submit Payout"
method: POST
path: "/v3/payouts"
tags: ["Submit Payout"]
---

# Submit Payout

`POST /v3/payouts`

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

Basic validation of the payout is performed before returning but more comprehensive validation is done asynchronously.

The results can be obtained by issuing a HTTP GET to the URL returned in the location header.

\*\*NOTE:\*\* amount values in payments must be in 'minor units' format. E.g. cents for USD, pence for GBP etc.

with no decimal places.

## Request body

- CreatePayoutRequest
  - `payorId` string, uuid — Deprecated in v2.16. Any value supplied here will be ignored.
  - `payoutFromPayorId` string, uuid — The id of the payor whose source account(s) will be debited. payoutFromPayorId and payoutToPayorId must be both supplied or both omitted.
  - `payoutToPayorId` string, uuid — The id of the payor whose payees will be paid. payoutFromPayorId and payoutToPayorId must be both supplied or both omitted.
  - `payoutMemo` string — Text applied to all payment memos unless specified explicitly on a payment. This should be the reference field on the statement seen by the payee (but not via ACH)
  - `payments` PaymentInstruction[], required
    - `remoteId` string, required — Your identifier for payee
    - `currency` string, required — Valid ISO 4217 3 letter currency code. See the <a href="https://www.iso.org/iso-4217-currency-codes.html" target="_blank" a>ISO specification</a> for details.
    - `amount` integer, required — <p>Amount to send to Payee</p> <p>The maximum payment amount is dependent on the currency</p>
    - `paymentMemo` string
    - `sourceAccountName` string, required
    - `payorPaymentId` string

## Response `202`

Detailed response of payout instructions

## Other responses

- `400` — Invalid request. See Error message payload for details of failure
- `401` — Invalid access token. May be expired or invalid
- `403` — The 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

## Changes

- **2020-01-28** `1b2abf26b5d6` — 10 breaking, 3 warning, 5 info
  - removed the enum value `EUR` of the request property `file/items/currency` (media type: multipart/form-data)
  - removed the enum value `EUR` of the request property `payments/items/currency` (media type: application/json)
  - removed the enum value `GBP` of the request property `file/items/currency` (media type: multipart/form-data)
  - removed the enum value `GBP` of the request property `payments/items/currency` (media type: application/json)
  - …14 more
- **2019-10-17** `f27462c28e5f` — 7 info
  - added the new optional request property `payoutFromPayorId` (media type: application/json)
  - added the new optional request property `payoutFromPayorId` (media type: multipart/form-data)
  - added the new optional request property `payoutToPayorId` (media type: application/json)
  - added the new optional request property `payoutToPayorId` (media type: multipart/form-data)
  - …3 more
- **2019-07-15** `ced8e167a97c` — 6 breaking, 14 warning, 18 info
  - added the new required request property `payorId` (media type: application/json)
  - request property `file/items/currency` was restricted to a list of enum values (media type: multipart/form-data)
  - request property `payments/items/currency` was restricted to a list of enum values (media type: application/json)
  - the request property `file/items/sourceAccountName` became required (media type: multipart/form-data)
  - …34 more

[Change history](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis/changes/v3/payouts/post.md)

---

[API](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis.md) · [All operations](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis/llms.txt) · [OpenAPI document](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis/revisions/1b2abf26b5d6?raw)