> For the complete documentation index, see [llms.txt](https://docs.payright.my/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.payright.my/api/payout-provider.md).

# Payout Provider

This endpoint returns the list of available banks and financial institutions that support payouts. Each provider includes the `payout_provider_id` and `name`.

Use this endpoint to populate bank selection dropdowns or validate availability before initiating a payout.

## Endpoint

<table data-header-hidden><thead><tr><th width="73.109375">Method</th><th>Endpoint</th></tr></thead><tbody><tr><td><mark style="color:orange;">POST</mark></td><td><pre><code>https://api.payright.my/api/v1/merchant/list-payout-providers
</code></pre></td></tr></tbody></table>

### Usage Examples

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

```bash
curl -X POST "https://api.payright.my/api/v1/merchant/list-payout-providers" \
  -H "auth-token: eyJhbGciO...XZI3CLi_a0BeUOJMPUK00"
```

{% endtab %}

{% tab title="Python" %}

```python
import http.client
import urllib.parse

# Define and parse the URL
url = "https://api.payright.my/api/v1/merchant/list-payout-providers"
parsed_url = urllib.parse.urlparse(url)

# Create HTTPS connection to host
conn = http.client.HTTPSConnection(parsed_url.hostname)

# Define headers
headers = {
    "auth-token": "eyJhbGciO...XZI3CLi_a0BeUOJMPUK00"
}

# Send the GET request to the endpoint
conn.request("POST", parsed_url.path, headers=headers)

# Read and print response
response = conn.getresponse()
print("Status:", response.status)
print("Response:", response.read().decode())

# Close the connection
conn.close()
```

{% endtab %}

{% tab title="Ruby" %}

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

# Parse the URL
url = URI.parse("https://api.payright.my/api/v1/merchant/list-payout-providers")

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

request = Net::HTTP::Post.new(url.path, {
  "auth-token" => "eyJhbGciO...XZI3CLi_a0BeUOJMPUK00"
})

# Execute request
response = http.request(request)

# Output result
puts "Status: #{response.code}"
puts "Response body: #{response.body}"
```

{% endtab %}
{% endtabs %}

## Authentication

`string` `header` <mark style="color:red;">`required`</mark>

To authenticate requests, include an Authorization header with the value

<table><thead><tr><th width="114.81640625">Key</th><th>Value</th></tr></thead><tbody><tr><td>auth-token</td><td>&#x3C;Your Payright auth token></td></tr></tbody></table>

{% hint style="info" %}
You can retrieve your token by visiting your [Payright dashboard](https://portal.payright.my/) and clicking `Accounts > API Keys > View API Keys (magnify icon) > Auth Token`
{% endhint %}

## Response

`application/json`

{% tabs %}
{% tab title="Success Example" %}

```json
{
    "status": "ok",
    "code": 200,
    "data": {
        "list": {
            "draw": 40,
            "record_filtered": 40,
            "record_total": 40,
            "data": [
                {
                    "payout_provider_id": 39,
                    "name": "AEON Bank (M) Berhad"
                },
                {
                    "payout_provider_id": 25,
                    "name": "Affin Bank Berhad"
                }
            ]
        }
    },
    "uuid": "408ed601-0cf9-4835-9bef-f734410741dc",
    "message": null,
    "error": null
}

```

{% endtab %}

{% tab title="Error Example" %}

```json
{
    "status": "fail",
    "code": 1234,
    "data": null,
    "uuid": "408ed601-0cf9-4835-9bef-f734410741dc",
    "message": "Something about this doesn't seem right.",
    "error": null
}
```

{% endtab %}
{% endtabs %}

### Response Attributes

<details>

<summary>status  <sup><sub><code>string</code></sub></sup> </summary>

Response status indicator (e.g., "ok" or "fail").

</details>

<details>

<summary>code  <sup><sub><code>number</code></sub></sup></summary>

HTTP-like status code representing result (200 = success).

</details>

<details>

<summary>data  <sup><sub><code>object | null</code></sub></sup></summary>

[Main data container. Contains list of paginated data.](#data.list-object)

</details>

<details>

<summary>data.list  <sup><sub><code>object</code></sub></sup> </summary>

<table><thead><tr><th width="133.26953125">Field</th><th width="87.9453125">Type</th><th>Description</th></tr></thead><tbody><tr><td>draw</td><td>number</td><td>A sequence or page counter, typically used for paginated requests.</td></tr><tr><td>record_filtered</td><td>number</td><td>Total number of records matching current filters.</td></tr><tr><td>record_total</td><td>number</td><td>Total number of records available overall.</td></tr><tr><td><a href="#data.list.data-array">data</a></td><td>array</td><td><a href="#data.list.data-array">List of available payout service providers.</a></td></tr></tbody></table>

</details>

<details>

<summary>data.list.data  <sup><sub><code>array</code></sub></sup> </summary>

<table><thead><tr><th width="167.71484375">Field</th><th width="99.9453125">Type</th><th>Description</th></tr></thead><tbody><tr><td>payout_provider_id</td><td>number</td><td>Internal identifier for the payout provider.</td></tr><tr><td>name</td><td>string</td><td>Display name of the provider (e.g., bank name).</td></tr></tbody></table>

</details>

<details>

<summary>uuid  <sup><sub><code>string | null</code></sub></sup> </summary>

Unique request identifier useful for debugging or tracing logs.

</details>

<details>

<summary>message  <sup><sub><code>string | null</code></sub></sup> </summary>

Optional human-readable message (e.g., for error or info).

</details>

<details>

<summary>error  <sup><sub><code>string | null</code></sub></sup> </summary>

Optional error description if something went wrong.

</details>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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://docs.payright.my/api/payout-provider.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.