Payout Provider

Retrieve a list of supported payout service providers.

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

POST

https://api.payright.my/api/v1/merchant/list-payout-providers

Usage Examples

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

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()

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}"

Authentication

string header required

To authenticate requests, include an Authorization header with the value

Key

Value

auth-token

You can retrieve your token by visiting your Payright dashboard and clicking Accounts > API Keys > View API Keys (magnify icon) > Auth Token

Response

application/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
}

Response Attributes

status ^_string

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

code ^_number

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

data ^{_{object | null}}

Main data container. Contains list of paginated data.

data.list ^_object

Field

Type

Description

draw

number

A sequence or page counter, typically used for paginated requests.

record_filtered

number

Total number of records matching current filters.

record_total

number

Total number of records available overall.

data

array

List of available payout service providers.

data.list.data ^_array

Field

Type

Description

payout_provider_id

number

Internal identifier for the payout provider.

name

string

Display name of the provider (e.g., bank name).

uuid ^{_{string | null}}

Unique request identifier useful for debugging or tracing logs.

message ^{_{string | null}}

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

error ^{_{string | null}}

Optional error description if something went wrong.

Last updated 3 months ago