> For the complete documentation index, see [llms.txt](https://developers.klasha.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.klasha.com/transfers/payout/ngn-payout-new-encryption.md).

# NGN Payout (new encryption)

### Summary

These APIs are used to initiate a NGN payout

{% hint style="info" %}
Before you begin!

* Find your keys on the Klasha Dashboard → Settings → Generate API Keys ([here](https://dashboard.klasha.com/settings/keys))

<img src="/files/LFFicElNA6dWGpxBEdo1" alt="" data-size="original">
{% endhint %}

## Integration steps

{% content-ref url="/pages/p15ikIRu4qZuG2xRX2op" %}
[Authentication](/overview/authentication.md)
{% endcontent-ref %}

#### [Encryption algorithm here](/accepting-payments/payments-api.md#encryption-algorithm)

### **Get Bank Lists**

## Make a GET call to the Bank List API&#x20;

<mark style="color:blue;">`GET`</mark> `{{env_url}}/wallet/merchant/bank/transfer/request/banks/NGN`

#### Headers

{% tabs %}
{% tab title="200: OK " %}

<pre class="language-json"><code class="lang-json">{
    "message": "success",
    "error": null,
    "data": [
<strong>        {
</strong>            "code": "90527",
            "name": " OJOKORO MICROFINANCE BANK"
        },
        {
            "code": "110072",
            "name": "78 FINANCE COMPANY LIMITED"
        },
        {
            "code": "090629",
            "name": "9jaPay Microfinance Bank"
        },
        {
            "code": "120001",
            "name": "9PAYMENT SERVICE BANK"
        }
    ]
}
</code></pre>

{% endtab %}
{% endtabs %}

### **Resolve Bank Account**&#x20;

## Make a POST call to the resolve account API&#x20;

<mark style="color:green;">`POST`</mark> `{{env_url}}/wallet/merchant/bank/transfer/request/resolve/account`

#### Headers

| Key           | Value                |
| ------------- | -------------------- |
| Context-Type  | application/json     |
| Authorization | Bearer \<token here> |
|               |                      |

#### Request Body

| Name                                            | Type | Description |
| ----------------------------------------------- | ---- | ----------- |
| bankCode<mark style="color:red;">\*</mark>      |      | 100004      |
| countryCode<mark style="color:red;">\*</mark>   |      | NG          |
| accountNumber<mark style="color:red;">\*</mark> |      | 9067285661  |

{% tabs %}
{% tab title="200: OK " %}

```json
{
    "status": "success",
    "message": "Account details fetched",
    "data": {
        "account_number": "9067777000",
        "account_name": "John Jane Doe"
    }
}
```

{% endtab %}

{% tab title="400: Bad Request " %}

```javascript
This error occurs when the account number cannot be verified
{
    "status": "error",
    "message": "Account could not be resolved"
}
```

{% endtab %}

{% tab title="400: Bad Request " %}

```javascript
This error occurs when the right "countryCode" is not passed in
{
    "message": "Operation not allowed.",
    "error": "Operation not allowed",
    "data": null
}
```

{% endtab %}
{% endtabs %}

### **Merchant Payout request**

## Make a POST call to the Merchant payout request API

<mark style="color:green;">`POST`</mark> `{{env_url}}/wallet/merchant/{businessId}/bank/transfer/v2/request`

You would need to pass, as a header the <mark style="color:red;">x-auth-token</mark>. This can be obtained from your merchant **dashboard → Settings → Generate API keys → Merchant public key**.

#### Headers

| Key           | Value                    |
| ------------- | ------------------------ |
| Content-Type  | application/json         |
| x-auth-token  | Your merchant public key |
| Authorization | Bearer \<token here>     |

**Request body (encrypted):**

```json
{ 
  "message": "encrypted-request-body"
}
```

**Request body (plain)**

#### Request Body

<table><thead><tr><th width="264">Name</th><th width="160">Type</th><th>Description</th></tr></thead><tbody><tr><td>country<mark style="color:red;">*</mark></td><td></td><td>NG</td></tr><tr><td>bankCode<mark style="color:red;">*</mark></td><td></td><td>10004</td></tr><tr><td>amount<mark style="color:red;">*</mark></td><td></td><td>1000</td></tr><tr><td>accountName<mark style="color:red;">*</mark></td><td></td><td>John Jane Doe</td></tr><tr><td>requestId<mark style="color:red;">*</mark></td><td>String</td><td>kbtr-3857-011-133-166993253334816</td></tr><tr><td>description<mark style="color:red;">*</mark></td><td>String</td><td>Payout</td></tr><tr><td>currency<mark style="color:red;">*</mark></td><td>String</td><td>NGN</td></tr><tr><td>bankName<mark style="color:red;">*</mark></td><td>String</td><td>Opay Limited</td></tr><tr><td>accountNumber<mark style="color:red;">*</mark></td><td>String</td><td>9067285661</td></tr></tbody></table>

{% tabs %}
{% tab title="200: OK " %}

```json
{
    "id": 3,
    "amount": 1000,
    "payoutStatus": "PENDING",
    "requestId": "kbtr-3857-011-133-166993253334816",
    "narration": "certification",
    "country": "NG",
    "fee": 54,
    "bankCode": "10004",
    "bankName": "Opay Limited",
    "accountNumber": "9067285661",
    "accountName": "John Jane Doe"
}
```

{% endtab %}

{% tab title="400: Bad Request " %}

```javascript
{
    "message": "A human readable error message",
    "error": "Bad Request",
    "data": null
}
```

{% endtab %}
{% endtabs %}

### **Query payout status**

Make a [call](/transfers/payout.md#polling-transfer-statuses) to fetch status of initiated payouts.
