Sign in
Submit Payout

Submit Payout

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.

post/v3/payouts

Request body

payorIdstring uuid

Deprecated in v2.16. Any value supplied here will be ignored.

payoutFromPayorIdstring uuid

The id of the payor whose source account(s) will be debited. payoutFromPayorId and payoutToPayorId must be both supplied or both omitted.

payoutToPayorIdstring uuid

The id of the payor whose payees will be paid. payoutFromPayorId and payoutToPayorId must be both supplied or both omitted.

payoutMemostring

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)

Example request

{
  "payoutFromPayorId": "c4261044-13df-4a6c-b1d4-fa8be2b46f5a",
  "payoutToPayorId": "9afc6b39-de12-466a-a9ca-07c7a23b312d",
  "payments": [
    {
      "amount": 1299,
      "currency": "USD",
      "payorPaymentId": "123211321ABSD",
      "paymentMemo": "my memo",
      "remoteId": "remoteId1234",
      "sourceAccountName": "MyAccountName"
    },
    {
      "amount": 1299,
      "currency": "USD",
      "payorPaymentId": "123211321ABSD",
      "paymentMemo": "my memo",
      "remoteId": "remoteId1234",
      "sourceAccountName": "MyAccountName"
    },
    {
      "amount": 1299,
      "currency": "USD",
      "payorPaymentId": "123211321ABSD",
      "paymentMemo": "my memo",
      "remoteId": "remoteId1234",
      "sourceAccountName": "MyAccountName"
    },
    {
      "amount": 1299,
      "currency": "USD",
      "payorPaymentId": "123211321ABSD",
      "paymentMemo": "my memo",
      "remoteId": "remoteId1234",
      "sourceAccountName": "MyAccountName"
    },
    {
      "amount": 1299,
      "currency": "USD",
      "payorPaymentId": "123211321ABSD",
      "paymentMemo": "my memo",
      "remoteId": "remoteId1234",
      "sourceAccountName": "MyAccountName"
    }
  ],
  "payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "payoutMemo": "Monthly Payment"
}

Response

Detailed response of payout instructions

Changes