# Get Payout

> GET `/getpayout`
> Part of the Payouts API reference. Source: https://hub.ozow.com/api-reference/payouts-api/get-getpayout/

Server: `https://payoutsapi.ozow.com/v1` (Production)

Other environments: `https://stagingpayoutsapi.ozow.com/v1` (Staging)

Retrieve a single payout by its identifier.

## Authentication

- `ApiKey` (API key in the ApiKey header)

## Query parameters

- `payoutId` (string, required) - The unique payout identifier.

## Header parameters

- `SiteCode` (string, required) - A unique code for the site currently in use. A site code is generated when adding a site in the Ozow merchant admin section. [Please contact support for SiteCode - support@ozow.com]

## Responses

### 200 OK. The payout was found, which says nothing about how it went. Its outcome is `payoutStatus`, and a failed payout is a 200 with the reason in `payoutStatus.subStatus` and `payoutStatus.errorMessage`.

- `id` (string, uuid, required, max length 50) - Ozow's unique reference for the payout.
- `amount` (number, double, required, min 0) - The payout amount.
- `siteCode` (string, required, max length 50) - A unique code for the site currently in use. A site code is generated when adding a site in the Ozow merchant admin section. [Please contact support for SiteCode - support@ozow.com]
- `merchantReference` (string, required, max length 20) - The merchant's reference for the transaction.
- `customerBankReference` (string, required, max length 20, pattern ^[A-Za-z0-9 -]+) - The reference that will appear on the merchant’s bank statement and can be used for recon purposes. Only alphanumeric characters, spaces and dashes are allowed.
- `notifyUrl` (string, uri, max length 150) - The URL that we should use to post all payout notifications.
- `isRtc` (boolean, required) - Whether the payout should be processed as an RTC payout. ***RTC is not available in the staging environment so should always be set to false when testing in this environment***
- `bankingDetails` (object, required) - Payout destination banking details.
- `payoutStatus` (object, required) - Payout status.

### 400 Bad Request. The request did not reach the API. A required header or query parameter is missing, or the body does not match the expected shape.

- `message` (string) - What was wrong with the request.

### 403 Forbidden. The `SiteCode` and `ApiKey` pair was not accepted.

- `message` (string) - What was wrong with the request.

### 500 Internal Server Error. The gateway could not reach the service or the integration failed. A failure inside the service is not this one. Those come back as a 200 with the reason in the payload, because the gateway maps every integration response it has no other rule for onto 200.

- `message` (string) - What was wrong with the request.