> For the complete documentation index, see [llms.txt](https://doc.borderlesspaymentng.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.borderlesspaymentng.com/payment/payout-local/integration.md).

# Integration

{% hint style="warning" %}
You have to redirect to the link which is returned in respomse data. In addition, you need to store the value of field reference and orderid for using api Verify Transaction.
{% endhint %}

## Payout Transaction

<mark style="color:green;">`POST`</mark> `https://borderlesspaymentng.com/api/payout`

#### Headers

| Name                                            | Type   | Description              |
| ----------------------------------------------- | ------ | ------------------------ |
| authorization<mark style="color:red;">\*</mark> | String | Bearer YOUR\_SECRET\_KEY |
| content-type<mark style="color:red;">\*</mark>  | String | application/json         |

#### Request Body

<table><thead><tr><th>Name</th><th width="191">Type</th><th>Description</th></tr></thead><tbody><tr><td>amount<mark style="color:red;">*</mark></td><td>String</td><td>amount</td></tr><tr><td>currency<mark style="color:red;">*</mark></td><td>String</td><td>currency - NGN/KES/GHN</td></tr><tr><td>reference<mark style="color:red;">*</mark></td><td>String</td><td>your transaction reference </td></tr><tr><td>receiver_name<mark style="color:red;">*</mark></td><td>String</td><td>receiver name</td></tr><tr><td>sender_name<mark style="color:red;">*</mark></td><td>String</td><td>sender name</td></tr><tr><td>email<mark style="color:red;">*</mark></td><td>String</td><td>email</td></tr><tr><td>phone<mark style="color:red;">*</mark></td><td>String</td><td>phone</td></tr><tr><td>receiver_address<mark style="color:red;">*</mark></td><td>String</td><td>receiver address</td></tr><tr><td>sender_address<mark style="color:red;">*</mark></td><td>String</td><td>sender address</td></tr><tr><td>bank_name<mark style="color:red;">*</mark></td><td>String</td><td>bank name if type is BANK</td></tr><tr><td>bank_account_number<mark style="color:red;">*</mark></td><td>String</td><td>bank account number if type is BANK</td></tr><tr><td>network_name<mark style="color:red;">*</mark></td><td>String</td><td>name of mobile network if type is MOBILE</td></tr><tr><td>ip_address<mark style="color:red;">*</mark></td><td>String</td><td>ip address</td></tr><tr><td>type<mark style="color:red;">*</mark></td><td>string</td><td>BANK / MOBILE</td></tr><tr><td>webhook_url<mark style="color:red;">*</mark></td><td>String</td><td>webhook url with method POST</td></tr></tbody></table>

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

```json
{
  "status" : "success",
  "message" : "success",
  "data":
   {
      "status" : "approved",
      "message" : "Successfully deposited N100.00 to bank account ******1748. Transaction Id: NYHD0.",
      "transaction" :
      {
         "reference" : "e5d7d46e76c378ba3b188648f964d824",
         "orderid" : "NYHD0",
         "bank_uuid" : "30AE3B3E-F20D-431F-959B-DDC9CEEE79A5",
         "bank_account_number" : "7063861748",
         "amount" : "100.00",
         "fee" : 53.75,
         "vat" : 3.75
      }
   } 
}
```

{% endtab %}

{% tab title="401: Unauthorized " %}

```json
{
    "status" : "failed",
    "message" : "Invalid Token"
}
```

{% endtab %}

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

```json
{
    "status" : "failed",
    "message" : "Bad Request"
}
```

{% endtab %}
{% endtabs %}
