---
title: "Create payout request"
method: POST
path: "/merchants/{merchantId}/payouts"
tags: ["Payouts"]
---

# Create payout request

`POST /merchants/{merchantId}/payouts`

The API supports multiple payouts in a payout request. For multiple payouts, include them in the same payout request rather than creating a payout request for each.

For more information, see the [documentation](https://developer.peachpayments.com/docs/payouts-api-1#create-payout-request-flow), and for sample calls, see the [public Postman collection](https://www.postman.com/peachpayments/peach-payments-public-workspace/request/cc3tzt6/create-payouts?ctx=documentation).

## Path parameters

- `merchantId` string, required — A unique merchant ID provided by Peach Payments in hexadecimal format.

## Request body

- object
  - `payouts` TymePayout[], required — A list of payouts.
    - `payoutId` string — A valid v4 UUID expressed in lowercase with dashes.
    - `currency` 'ZAR', required
    - `amount` number, required — The amount allocated for the payout, in minor currency (that is, cents) where 3443 is 34.43 in the major currency. It must be greater than or equal to 1000 cents and less than or equal to 500000000 cents.
    - `accountNumber` string, required — The account number that you're paying out to.
    - `branchCode` string, required — The branch code of the bank that you're paying out to.
    - `reference` string, required — The payout reference.
    - `bankName` 'STANDARD BANK' | 'NEDBANK' | 'FNB' | 'OLD MUTUAL BANK' | 'ACCESS BANK' | 'AFRICAN BANK' | 'UBANK LTD' | 'BIDVEST BANK' | 'BIDVEST BANK ALLIANCES' | 'CAPITEC BANK' | 'ABSA' | 'HBZ BANK LIMITED' | 'FINBOND MUTUAL BANK' | 'INVESTEC BANK LIMITED' | 'FINBOND EPE' | 'DISCOVERY BANK' | 'TYMEBANK' | 'SASFIN BANK' | 'STANDARD CHARTERED BANK SA' | 'ALBARAKA BANK' | 'CAPITEC BUSINESS' | 'AFRICAN BANK BUSINESS' | 'BANK ZERO MUTUAL BANK' | 'YWBN MUTUAL BANK', required — The bank associated with the payout.
    - `accountHolder` string, required — The account holder's name.
    - `merchantReference` string — Use this reference for your own tracking.
    - `payoutMethod` 'realtime-eft', required
    - `proofOfPayout` object — When provided, a proof of payout email with a PDF attachment is sent to the specified recipients when the payout is successfully processed.
      - `to` string[], required — Email addresses to send the proof of payout to. At least one required.
      - `cc` string[] — Email addresses to CC on the proof of payout.

## Response `201`

Created or requested.

- PayoutRequestStatus — The combined result of your payout request.
  - `payoutRequestId` string — A valid v4 UUID expressed in lowercase with dashes.
  - `created` string, date-time — The ISO-8601 timestamp of when the payout request was made.
  - `payouts` PayoutStatus[] — The response to the create payout request contains the list of payouts accepted along with their unique IDs which can be used in subsequent calls to query the status of the payouts.
    - `currency` 'ZAR', required — A three-letter currency code (ISO 4217). ZAR is supported for Tyme payouts.
    - `amount` number, required — The amount that was paid out, in minor currency (that is, cents) where 3443 is 34.43 in the major currency. It must be greater than or equal to 1000 cents and less than or equal to 500000000 cents.
    - `accountNumber` string, required — The account number that was paid out to.
    - `branchCode` string, required — The branch code of the bank that was paid out to.
    - `reference` string, required — The reference for the payout.
    - `bankName` 'STANDARD BANK' | 'NEDBANK' | 'FNB' | 'OLD MUTUAL BANK' | 'ACCESS BANK' | 'AFRICAN BANK' | 'UBANK LTD' | 'BIDVEST BANK' | 'BIDVEST BANK ALLIANCES' | 'CAPITEC BANK' | 'ABSA' | 'HBZ BANK LIMITED' | 'FINBOND MUTUAL BANK' | 'INVESTEC BANK LIMITED' | 'FINBOND EPE' | 'DISCOVERY BANK' | 'TYMEBANK' | 'SASFIN BANK' | 'STANDARD CHARTERED BANK SA' | 'ALBARAKA BANK' | 'CAPITEC BUSINESS' | 'AFRICAN BANK BUSINESS' | 'BANK ZERO MUTUAL BANK' | 'YWBN MUTUAL BANK', required — The bank associated with the payout.
    - `accountHolder` string, required — The account holder for the payout.
    - `merchantReference` string, nullable — Use this reference for your own tracking.
    - `payoutMethod` 'realtime-eft', required — The type of payout based on the payout delivery method.
    - `status` 'pending' | 'processing' | 'failed' | 'successful' | 'cancelled' | 'reversed', required — The current state of the payout.
    - `payoutId` string, required — A valid v4 UUID expressed in lowercase with dashes.
    - `lastUpdated` string, date-time, required — The ISO-8601 timestamp of when the payout was last updated.
    - `created` string, date-time — The ISO-8601 timestamp of when the payout was created.
    - `resultCode` string, string — The result code indicating the status or error of the payout.
    - `payoutPartnerRespondedAt` string, date-time, nullable — ISO-8601 timestamp when the payout partner completed the payout. Present only when no longer processing
    - `missingCreditQueryStatus` 'not_queried' | 'queried' | 'successful' | 'failed' — The missing credit query status of the payout.
    - `error` Error — Error messages all follow the default error pattern as described below. Some errors may contain additional details to help you diagnose the issues.
      - `title` string, required
      - `message` string, required
      - `code` string, required
      - `errors` object

## Other responses

- `400` — There have been one or more field validation errors.
- `401` — The request is not authenticated. Please re-authenticate and provide a new token.
- `403` — The request is not authorised. Please contact your business administrator.

---

[API](https://skmtc.net/peachpayments/apis/checkout.md) · [All operations](https://skmtc.net/peachpayments/apis/checkout/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/peachpayments/checkout/versions/3a98165665f8/schema)