# Payout Zambia

## Create a Payout to Zambia

<mark style="color:green;">`POST`</mark> `/`[`auth/payout`](https://sandbox.yogupay.com/auth/payout)

**Headers**

<table><thead><tr><th>Name</th><th>Value</th></tr></thead><tbody><tr><td>Content-Type</td><td><code>application/json</code></td></tr><tr><td>Token</td><td><pre><code>token
</code></pre></td></tr></tbody></table>

**Body**

{% hint style="info" %}
The required fields for this request are marked <mark style="color:red;">\*</mark>
{% endhint %}

<table><thead><tr><th width="242">Name</th><th width="138">Type</th><th>Description</th></tr></thead><tbody><tr><td>bank_account_number</td><td>string</td><td>The bank account number of the recipient.</td></tr><tr><td>bank_code</td><td>string</td><td>The bank code of the recipient's bank</td></tr><tr><td>country_code<mark style="color:red;">*</mark></td><td>string</td><td>The <a data-footnote-ref href="#user-content-fn-1">country code</a> of the recipient </td></tr><tr><td>source_currency<mark style="color:red;">*</mark></td><td>string</td><td>The currency in which the funds will be deducted from.</td></tr><tr><td>source_amount<mark style="color:red;">*</mark></td><td>number</td><td>The amount the recipient will receive .</td></tr><tr><td>purpose_of_funds</td><td>string</td><td>The purpose of the funds transfer</td></tr><tr><td>recipient_name<mark style="color:red;">*</mark></td><td>string</td><td>The name of the recipient.</td></tr><tr><td>msisdn<mark style="color:red;">*</mark></td><td>string</td><td>The mobile number of the recipient.</td></tr><tr><td>recipient_email</td><td>string</td><td>The email address of the recipient.</td></tr><tr><td>payment_reference<mark style="color:red;">*</mark></td><td>string</td><td>A reference unique to your system</td></tr><tr><td>collection_network<mark style="color:red;">*</mark></td><td>string</td><td>The collection network for the payout</td></tr><tr><td>channel<mark style="color:red;">*</mark></td><td>string</td><td>The channel through which the payout will be made.</td></tr></tbody></table>

**Request & Response**

{% tabs %}
{% tab title="Request" %}

```json
{
    "bank_account_number": "",
    "country_code": "ZM",
    "source_currency": "ZMW",
    "source_amount": "1000",
    "purpose_of_funds": "School Fees",
    "recipient_name": "John Doe",
    "bank_code": "",
    "msisdn": "2250767475356",
    "recipient_email": "johndoe@yogupay.com",
    "payment_reference": "johnXOFtest1",
    "collection_network": "BANKTRANSFER",
    "channel": "BANKTRANSFER"
}

```

{% endtab %}

{% tab title="Successful Response" %}

```json
{
    "status": 1,
    "trx_code": "ECEM8LGFEO",
    "message": "Success You have successfully initiated a transfer. Please wait a few minutes as we complete this for you"
}
```

{% endtab %}

{% tab title="Unsuccessful Response" %}

```json
{
  "error": "Invalid request"
}
```

{% endtab %}
{% endtabs %}

[^1]: <mark style="background-color:blue;">In this case, it will be 'ZM'</mark>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://yogupay.gitbook.io/yogupay-payout-api/payouts/payout-africa/payout-zambia.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.