Payouts

Submit Payout

Create a new payout and return a location header with a link to 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

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,
      "paymentMetadata": "invoiceeId_123|abc001:12345|xyz002:4567",
      "currency": "USD",
      "payorPaymentId": "123211321ABSD",
      "transmissionType": "ACH",
      "paymentMemo": "my memo",
      "remoteSystemId": "remoteSystemId",
      "transactionId": "859af785-223b-4d5b-a708-5fa57f006dbb",
      "remoteId": "remoteId1234",
      "sourceAccountName": "MyAccountName"
    },
    {
      "amount": 1299,
      "paymentMetadata": "invoiceeId_123|abc001:12345|xyz002:4567",
      "currency": "USD",
      "payorPaymentId": "123211321ABSD",
      "transmissionType": "ACH",
      "paymentMemo": "my memo",
      "remoteSystemId": "remoteSystemId",
      "transactionId": "859af785-223b-4d5b-a708-5fa57f006dbb",
      "remoteId": "remoteId1234",
      "sourceAccountName": "MyAccountName"
    },
    {
      "amount": 1299,
      "paymentMetadata": "invoiceeId_123|abc001:12345|xyz002:4567",
      "currency": "USD",
      "payorPaymentId": "123211321ABSD",
      "transmissionType": "ACH",
      "paymentMemo": "my memo",
      "remoteSystemId": "remoteSystemId",
      "transactionId": "859af785-223b-4d5b-a708-5fa57f006dbb",
      "remoteId": "remoteId1234",
      "sourceAccountName": "MyAccountName"
    },
    {
      "amount": 1299,
      "paymentMetadata": "invoiceeId_123|abc001:12345|xyz002:4567",
      "currency": "USD",
      "payorPaymentId": "123211321ABSD",
      "transmissionType": "ACH",
      "paymentMemo": "my memo",
      "remoteSystemId": "remoteSystemId",
      "transactionId": "859af785-223b-4d5b-a708-5fa57f006dbb",
      "remoteId": "remoteId1234",
      "sourceAccountName": "MyAccountName"
    },
    {
      "amount": 1299,
      "paymentMetadata": "invoiceeId_123|abc001:12345|xyz002:4567",
      "currency": "USD",
      "payorPaymentId": "123211321ABSD",
      "transmissionType": "ACH",
      "paymentMemo": "my memo",
      "remoteSystemId": "remoteSystemId",
      "transactionId": "859af785-223b-4d5b-a708-5fa57f006dbb",
      "remoteId": "remoteId1234",
      "sourceAccountName": "MyAccountName"
    }
  ],
  "payoutMemo": "Monthly Payment"
}

Response

Successful submission of the payout

Changes

Changed in 9 of the 50 revisions of this API.291867

Jul 13, 202605c3f09fc50a104See the full diff
- ▲
  removed the enum value ACH of the request property file/items/transmissionType (media type: multipart/form-data)
  request-property-enum-value-removed
- ▲
  removed the enum value ACH of the request property payments/items/transmissionType (media type: application/json)
  request-property-enum-value-removed
- ▲
  removed the enum value LOCAL of the request property file/items/transmissionType (media type: multipart/form-data)
  request-property-enum-value-removed
- ▲
  removed the enum value LOCAL of the request property payments/items/transmissionType (media type: application/json)
  request-property-enum-value-removed
- ▲
  removed the enum value SAME_DAY_ACH of the request property file/items/transmissionType (media type: multipart/form-data)
  request-property-enum-value-removed
- ▲
  removed the enum value SAME_DAY_ACH of the request property payments/items/transmissionType (media type: application/json)
  request-property-enum-value-removed
- ▲
  removed the enum value SWIFT of the request property file/items/transmissionType (media type: multipart/form-data)
  request-property-enum-value-removed
- ▲
  removed the enum value SWIFT of the request property payments/items/transmissionType (media type: application/json)
  request-property-enum-value-removed
- ▲
  removed the enum value WIRE of the request property file/items/transmissionType (media type: multipart/form-data)
  request-property-enum-value-removed
- ▲
  removed the enum value WIRE of the request property payments/items/transmissionType (media type: application/json)
  request-property-enum-value-removed
- ○
  added the new optional request property file/items/transactionId (media type: multipart/form-data)
  new-optional-request-property
- ○
  added the new optional request property payments/items/transactionId (media type: application/json)
  new-optional-request-property
- ○
  the request property file/items/sourceAccountName became optional (media type: multipart/form-data)
  request-property-became-optional
- ○
  the request property payments/items/sourceAccountName became optional (media type: application/json)
  request-property-became-optional
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Dec 22, 20222c03ca69ee092See the full diff
- ○
  api tag Payouts added
  api-tag-added
- ○
  api tag Payout Service removed
  api-tag-removed
Jun 27, 20221e7a1734a45c4See the full diff
- ○
  added the new LOCAL enum value to the request property file/items/transmissionType (media type: multipart/form-data)
  request-property-enum-value-added
- ○
  added the new LOCAL enum value to the request property payments/items/transmissionType (media type: application/json)
  request-property-enum-value-added
- ○
  added the new SWIFT enum value to the request property file/items/transmissionType (media type: multipart/form-data)
  request-property-enum-value-added
- ○
  added the new SWIFT enum value to the request property payments/items/transmissionType (media type: application/json)
  request-property-enum-value-added
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jan 14, 20215e436969863914See the full diff
- ●
  removed the request property payorId (media type: application/json)
  request-property-removed
- ○
  added the new optional request property file/items/paymentMetadata (media type: multipart/form-data)
  new-optional-request-property
- ○
  added the new optional request property file/items/remoteSystemId (media type: multipart/form-data)
  new-optional-request-property
- ○
  added the new optional request property payments/items/paymentMetadata (media type: application/json)
  new-optional-request-property
- ○
  added the new optional request property payments/items/remoteSystemId (media type: application/json)
  new-optional-request-property
This revision also has 27 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 25, 2020dd71433847a6318See the full diff
- ▲
  the errors/items/ response's property type/format changed from / to object/ for status 400
  response-property-type-changed
- ▲
  the errors/items/ response's property type/format changed from / to object/ for status 401
  response-property-type-changed
- ▲
  the errors/items/ response's property type/format changed from / to object/ for status 403
  response-property-type-changed
- ○
  added the optional property errors/items/errorCode to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property errors/items/errorCode to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property errors/items/errorCode to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property errors/items/errorData to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property errors/items/errorData to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property errors/items/errorData to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property errors/items/localisationDetails to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property errors/items/localisationDetails to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property errors/items/localisationDetails to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property httpStatusCode to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property httpStatusCode to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property httpStatusCode to the response with the 403 status
  response-optional-property-added
- ○
  response property errors/items/locationType deprecated
  response-property-deprecated
- ○
  response property errors/items/locationType deprecated
  response-property-deprecated
- ○
  response property errors/items/locationType deprecated
  response-property-deprecated
- ○
  response property errors/items/reasonCode deprecated
  response-property-deprecated
- ○
  response property errors/items/reasonCode deprecated
  response-property-deprecated
- ○
  response property errors/items/reasonCode deprecated
  response-property-deprecated
This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 24, 2020aded220b0d7b5See the full diff
- ○
  api operation id submitPayout removed and replaced with submitPayoutV3
  api-operation-id-removed
- ○
  api tag Payout Service added
  api-tag-added
- ○
  api tag Submit Payout removed
  api-tag-removed
- ○
  added the new optional request property file/items/transmissionType (media type: multipart/form-data)
  new-optional-request-property
- ○
  added the new optional request property payments/items/transmissionType (media type: application/json)
  new-optional-request-property
This revision also has 26 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jan 28, 20201b2abf26b5d61035See the full diff
- ▲
  removed the enum value EUR of the request property file/items/currency (media type: multipart/form-data)
  request-property-enum-value-removed
- ▲
  removed the enum value EUR of the request property payments/items/currency (media type: application/json)
  request-property-enum-value-removed
- ▲
  removed the enum value GBP of the request property file/items/currency (media type: multipart/form-data)
  request-property-enum-value-removed
- ▲
  removed the enum value GBP of the request property payments/items/currency (media type: application/json)
  request-property-enum-value-removed
- ▲
  removed the enum value USD of the request property file/items/currency (media type: multipart/form-data)
  request-property-enum-value-removed
- ▲
  removed the enum value USD of the request property payments/items/currency (media type: application/json)
  request-property-enum-value-removed
- ▲
  the file/items/currency request property's minLength was increased from 0 to 3 (media type: multipart/form-data)
  request-property-min-length-increased
- ▲
  the payments/items/currency request property's minLength was increased from 0 to 3 (media type: application/json)
  request-property-min-length-increased
- ▲
  added the pattern ^[A-Z]{3}$ to the request property file/items/currency (media type: multipart/form-data)
  request-property-pattern-added
- ▲
  added the pattern ^[A-Z]{3}$ to the request property payments/items/currency (media type: application/json)
  request-property-pattern-added
- ●
  the file/items/currency request property's maxLength was set to 3 (media type: multipart/form-data)
  request-property-max-length-set
- ●
  the payments/items/currency request property's maxLength was set to 3 (media type: application/json)
  request-property-max-length-set
- ●
  the payoutMemo request property's maxLength was set to 40 (media type: application/json)
  request-property-max-length-set
- ○
  added the media type application/json for the response with the status 400
  response-media-type-added
- ○
  added the non-success response with the status 401
  response-non-success-status-added
- ○
  added the non-success response with the status 403
  response-non-success-status-added
- ○
  removed the non-success response with the status 404
  response-non-success-status-removed
- ○
  removed the non-success response with the status 503
  response-non-success-status-removed
This revision also has 13 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Oct 17, 2019f27462c28e5f7See the full diff
- ○
  added the new optional request property payoutFromPayorId (media type: application/json)
  new-optional-request-property
- ○
  added the new optional request property payoutFromPayorId (media type: multipart/form-data)
  new-optional-request-property
- ○
  added the new optional request property payoutToPayorId (media type: application/json)
  new-optional-request-property
- ○
  added the new optional request property payoutToPayorId (media type: multipart/form-data)
  new-optional-request-property
- ○
  the request property payorId became optional (media type: application/json)
  request-property-became-optional
- ○
  request property payorId deprecated (media type: application/json)
  request-property-deprecated
- ○
  request property payorId deprecated (media type: multipart/form-data)
  request-property-deprecated
This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 15, 2019ced8e167a97c61418See the full diff
- ▲
  added the new required request property payorId (media type: application/json)
  new-required-request-property
- ▲
  request property file/items/currency was restricted to a list of enum values (media type: multipart/form-data)
  request-property-became-enum
- ▲
  request property payments/items/currency was restricted to a list of enum values (media type: application/json)
  request-property-became-enum
- ▲
  the request property file/items/sourceAccountName became required (media type: multipart/form-data)
  request-property-became-required
- ▲
  the request property payments/items/sourceAccountName became required (media type: application/json)
  request-property-became-required
- ▲
  removed the media type application/json for the response with the status 400
  response-media-type-removed
- ●
  the file/items/amount request property's max was set to 9223372036854775808.00 (media type: multipart/form-data)
  request-property-max-set
- ●
  the payments/items/amount request property's max was set to 9223372036854775808.00 (media type: application/json)
  request-property-max-set
- ●
  removed the request property file/items/paymentMetadata (media type: multipart/form-data)
  request-property-removed
- ●
  removed the request property file/items/remoteSystemId (media type: multipart/form-data)
  request-property-removed
- ●
  removed the request property file/items/transactionId (media type: multipart/form-data)
  request-property-removed
- ●
  removed the request property file/items/transmissionType (media type: multipart/form-data)
  request-property-removed
- ●
  removed the request property payments/items/paymentMetadata (media type: application/json)
  request-property-removed
- ●
  removed the request property payments/items/remoteSystemId (media type: application/json)
  request-property-removed
- ●
  removed the request property payments/items/transactionId (media type: application/json)
  request-property-removed
- ●
  removed the request property payments/items/transmissionType (media type: application/json)
  request-property-removed
- ●
  removed the request property payoutFromPayorId (media type: application/json)
  request-property-removed
- ●
  removed the request property payoutFromPayorId (media type: multipart/form-data)
  request-property-removed
- ●
  removed the request property payoutToPayorId (media type: application/json)
  request-property-removed
- ●
  removed the request property payoutToPayorId (media type: multipart/form-data)
  request-property-removed
- ○
  api operation id submitPayoutV3 removed and replaced with submitPayout
  api-operation-id-removed
- ○
  api tag Submit Payout added
  api-tag-added
- ○
  api tag Payouts removed
  api-tag-removed
- ○
  added the new EUR enum value to the request property file/items/currency (media type: multipart/form-data)
  request-property-enum-value-added
- ○
  added the new EUR enum value to the request property payments/items/currency (media type: application/json)
  request-property-enum-value-added
- ○
  added the new GBP enum value to the request property file/items/currency (media type: multipart/form-data)
  request-property-enum-value-added
- ○
  added the new GBP enum value to the request property payments/items/currency (media type: application/json)
  request-property-enum-value-added
- ○
  added the new USD enum value to the request property file/items/currency (media type: multipart/form-data)
  request-property-enum-value-added
- ○
  added the new USD enum value to the request property payments/items/currency (media type: application/json)
  request-property-enum-value-added
- ○
  the file/items/currency request property's minLength was decreased from 3 to 0 (media type: multipart/form-data)
  request-property-min-length-decreased
- ○
  the payments/items/currency request property's minLength was decreased from 3 to 0 (media type: application/json)
  request-property-min-length-decreased
- ○
  removed the pattern ^[A-Z]{3}$ from the request property file/items/currency (media type: multipart/form-data)
  request-property-pattern-removed
- ○
  removed the pattern ^[A-Z]{3}$ from the request property payments/items/currency (media type: application/json)
  request-property-pattern-removed
- ○
  request property payorId reactivated (media type: multipart/form-data)
  request-property-reactivated
- ○
  added the non-success response with the status 404
  response-non-success-status-added
- ○
  added the non-success response with the status 503
  response-non-success-status-added
- ○
  removed the non-success response with the status 401
  response-non-success-status-removed
- ○
  removed the non-success response with the status 403
  response-non-success-status-removed
This revision also has 257 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history