> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.shimi.cash/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.shimi.cash/_mcp/server.

# Send Payout

POST https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transfer
Content-Type: application/json

Sends money from one of your settlement accounts to a bank account previously resolved with **Validate Bank Account**. See the folder description above for how to handle the `200` / `400` / `202` outcomes.

**`Idempotency-Key` header is required.** Reusing the same key for a retried request returns the original result instead of creating a second payout — always reuse the same key when retrying after a network error or timeout on your end, and always generate a new one for a genuinely new payout.

**Headers**

| Header           | Required | Notes                                                                                                                                              |
| ---------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| `idempotencyKey` | yes      | The server reads exactly this header name (case-insensitive). `Idempotency-Key` is **not** recognised and gives `400 Idempotency key is required`. |

**Body (JSON)** - checked by Joi (`settlementPayoutSchema`).

| Field       | Type   | Required | Rules                                             |
| ----------- | ------ | -------- | ------------------------------------------------- |
| `verify_id` | string | yes      | 5-100 chars; `data.id` from Validate Bank Account |
| `amount`    | number | yes      | ₦300 - ₦10,000,000                                |
| `pin`       | string | yes      | exactly 4 chars                                   |
| `narration` | string | no       | 5-255 chars                                       |

**Outcomes**

* `200` - provider confirmed. `data.reference` = the payout reference (same as `verify_id`).
* `202` - debit recorded, provider has not answered within about 18 s. Poll **Check Payout Status** or wait for the Payout Outcome webhook. Don't retry.
* `400 Transfer failed: ...` - provider declined. The debit (amount + fee) has been reversed to your settlement balance, and the error text ends with `[FAILED - REVERSED: <provider reason>]`.

**Business errors (400)**

* `Transaction already processed` - same `idempotencyKey` reused, or this `verify_id` already has a payout in flight.
* `Transaction does not exist` - unknown `verify_id`, or one whose payout already finished.
* `Insufficient funds for transfer` - balance must be **strictly greater** than amount + fee.

**Idempotency:** retrying with the same key does **not** return the original result. You get a 400 as above, so check status instead.

Reference: https://docs.shimi.cash/api-reference/shimi-api/settlement-payouts/send-payout

## Authentication

- `Authorization` header (bearer token, required) — Access token from Generate Access Token (valid 15 minutes).

## Request

### Headers

- `idempotencyKey` (string, required)

### Body (application/json)

This endpoint expects an object.

- `verify_id` (string, optional)
- `amount` (integer, optional)
- `pin` (string, optional)
- `narration` (string, optional)

## Response

### 200

OK

- `message` (string, optional)
- `data` (SettlementTransferPostResponsesContentApplicationJsonSchemaData, optional)

### 202

Accepted

- `message` (string, optional)
- `data` (SettlementTransferPostResponsesContentApplicationJsonSchemaData, optional)

## Errors

### 400 Bad Request Error

Failed (provider declined) / Duplicate / already processed / Insufficient funds / verify_id unknown or already used / Invalid PIN / Idempotency key missing / Validation error

- `error` (string, optional)
- `status` (string, optional)
- `message` (string, optional)
- `details` (list of string, optional)

### 401 Unauthorized Error

Unauthorized

- `message` (string, optional)

### 403 Forbidden Error

Invalid or expired access token / KYB not approved / Account deactivated

- `message` (string, optional)
- `code` (string, optional)
- `kybStatus` (string, optional)

## Types

### SettlementTransferPostResponsesContentApplicationJsonSchemaData

- `reference` (string, optional)
- `status` (string, optional)

## Examples

### 200 Success

**Response**

```json
{
  "message": "Transfer successful",
  "data": {
    "reference": "cmgb3n7q20007lp4x9s1t6e8d"
  }
}
```

**SDK Code**

```python 200 Success
import requests

url = "https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transfer"

headers = {
    "idempotencyKey": "idempotencyKey",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, headers=headers)

print(response.json())
```

```javascript 200 Success
const url = 'https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transfer';
const options = {
  method: 'POST',
  headers: {idempotencyKey: 'idempotencyKey', Authorization: 'Bearer <token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go 200 Success
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transfer"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("idempotencyKey", "idempotencyKey")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby 200 Success
require 'uri'
require 'net/http'

url = URI("https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transfer")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["idempotencyKey"] = 'idempotencyKey'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java 200 Success
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transfer")
  .header("idempotencyKey", "idempotencyKey")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php 200 Success
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transfer', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'idempotencyKey' => 'idempotencyKey',
  ],
]);

echo $response->getBody();
```

```csharp 200 Success
using RestSharp;

var client = new RestClient("https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transfer");
var request = new RestRequest(Method.POST);
request.AddHeader("idempotencyKey", "idempotencyKey");
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift 200 Success
import Foundation

let headers = [
  "idempotencyKey": "idempotencyKey",
  "Authorization": "Bearer <token>"
]

let request = NSMutableURLRequest(url: NSURL(string: "https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transfer")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### 202 Processing

**Response**

```json
{
  "message": "Transfer is being processed and will be confirmed shortly. You will be notified via webhook, or you can check its status.",
  "data": {
    "reference": "cmgb3n7q20007lp4x9s1t6e8d",
    "status": "processing"
  }
}
```

**SDK Code**

```python 202 Processing
import requests

url = "https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transfer"

headers = {
    "idempotencyKey": "idempotencyKey",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, headers=headers)

print(response.json())
```

```javascript 202 Processing
const url = 'https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transfer';
const options = {
  method: 'POST',
  headers: {idempotencyKey: 'idempotencyKey', Authorization: 'Bearer <token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go 202 Processing
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transfer"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("idempotencyKey", "idempotencyKey")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby 202 Processing
require 'uri'
require 'net/http'

url = URI("https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transfer")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["idempotencyKey"] = 'idempotencyKey'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java 202 Processing
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transfer")
  .header("idempotencyKey", "idempotencyKey")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php 202 Processing
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transfer', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'idempotencyKey' => 'idempotencyKey',
  ],
]);

echo $response->getBody();
```

```csharp 202 Processing
using RestSharp;

var client = new RestClient("https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transfer");
var request = new RestRequest(Method.POST);
request.AddHeader("idempotencyKey", "idempotencyKey");
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift 202 Processing
import Foundation

let headers = [
  "idempotencyKey": "idempotencyKey",
  "Authorization": "Bearer <token>"
]

let request = NSMutableURLRequest(url: NSURL(string: "https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transfer")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Settlement & Payouts_sendPayout_example

**Request**

```json
{
  "verify_id": "{{verify_id}}",
  "amount": 50000,
  "pin": "1234",
  "narration": "Vendor payment"
}
```

**Response**

```json
{
  "message": "Transfer successful",
  "data": {
    "reference": "cmgb3n7q20007lp4x9s1t6e8d"
  }
}
```

**SDK Code**

```python Settlement & Payouts_sendPayout_example
import requests

url = "https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transfer"

payload = {
    "verify_id": "{{verify_id}}",
    "amount": 50000,
    "pin": "1234",
    "narration": "Vendor payment"
}
headers = {
    "idempotencyKey": "idempotencyKey",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript Settlement & Payouts_sendPayout_example
const url = 'https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transfer';
const options = {
  method: 'POST',
  headers: {
    idempotencyKey: 'idempotencyKey',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: '{"verify_id":"{{verify_id}}","amount":50000,"pin":"1234","narration":"Vendor payment"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Settlement & Payouts_sendPayout_example
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transfer"

	payload := strings.NewReader("{\n  \"verify_id\": \"{{verify_id}}\",\n  \"amount\": 50000,\n  \"pin\": \"1234\",\n  \"narration\": \"Vendor payment\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("idempotencyKey", "idempotencyKey")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Settlement & Payouts_sendPayout_example
require 'uri'
require 'net/http'

url = URI("https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transfer")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["idempotencyKey"] = 'idempotencyKey'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"verify_id\": \"{{verify_id}}\",\n  \"amount\": 50000,\n  \"pin\": \"1234\",\n  \"narration\": \"Vendor payment\"\n}"

response = http.request(request)
puts response.read_body
```

```java Settlement & Payouts_sendPayout_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transfer")
  .header("idempotencyKey", "idempotencyKey")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"verify_id\": \"{{verify_id}}\",\n  \"amount\": 50000,\n  \"pin\": \"1234\",\n  \"narration\": \"Vendor payment\"\n}")
  .asString();
```

```php Settlement & Payouts_sendPayout_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transfer', [
  'body' => '{
  "verify_id": "{{verify_id}}",
  "amount": 50000,
  "pin": "1234",
  "narration": "Vendor payment"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
    'idempotencyKey' => 'idempotencyKey',
  ],
]);

echo $response->getBody();
```

```csharp Settlement & Payouts_sendPayout_example
using RestSharp;

var client = new RestClient("https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transfer");
var request = new RestRequest(Method.POST);
request.AddHeader("idempotencyKey", "idempotencyKey");
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"verify_id\": \"{{verify_id}}\",\n  \"amount\": 50000,\n  \"pin\": \"1234\",\n  \"narration\": \"Vendor payment\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Settlement & Payouts_sendPayout_example
import Foundation

let headers = [
  "idempotencyKey": "idempotencyKey",
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "verify_id": "{{verify_id}}",
  "amount": 50000,
  "pin": "1234",
  "narration": "Vendor payment"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transfer")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```