Sign in

v1

latestOpenAPI 3.0.2Apache License 2.02026-07-13109285691.8 KB
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
<p>The id of the payor whose source account(s) will be debited</p> <p>payoutFromPayorId and payoutToPayorId must be both supplied or both omitted</p>
payoutToPayorIdstring uuid
<p>The id of the payor whose payees will be paid</p> <p>payoutFromPayorId and payoutToPayorId must be both supplied or both omitted</p>
payoutMemostring
<p>Text applied to all payment memos unless specified explicitly on a payment</p> <p>This should be the reference field on the statement seen by the payee (but not via ACH)</p>

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