Get Payout

Retrieves the details and status of a specific payout transaction.

This endpoint retrieves the current status of a previously initiated payout transaction. It supports lookup by either the system-generated invoice_no or your own external_invoice_ref.

Use this endpoint to check whether a payout has been completed, is still processing, or has failed.

Endpoint

GET	https://api.payright.my/api/v1/merchant/payout/:reference

Usage Examples

cURL

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

Python

import http.client
import urllib.parse

# Parse the URL
url = "https://api.payright.my/api/v1/merchant/payout/Payright03"
parsed_url = urllib.parse.urlparse(url)

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

# Prepare headers
headers = {
    "auth-token": "eyJhbGciO...XZI3CLi_a0BeUOJMPUK00" #Insert auth-token here
}

# Send GET request
conn.request("GET", parsed_url.path, headers=headers)

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

# Close connection
conn.close()

Ruby

require 'net/http'
require 'uri'

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

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

request = Net::HTTP::Get.new(url)
request["auth-token"] = "eyJhbGciO...XZI3CLi_a0BeUOJMPUK00" #Insert auth-token here

# 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	<Your Payright auth token>

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

Request

Path Parameter

string required

Key	Value
reference	<Input either invoice_no or external_invoice_ref>

Example URLs

Invoice No

GET https://api.payright.my/api/v1/merchant/payout/po-6DC1:125037-pyt

External Invoice Ref

GET https://api.payright.my/api/v1/merchant/payout/Payright03

Response

application/json

Success Example

{
    "status": "ok",
    "code": 2000,
    "data": {
        "value": 13.0,
        "external_invoice_ref": "Payright03",
        "payout_invoice_no": "po-6DC1:125037-pyt",
        "payout_account_number": "12345678901",
        "created_at": "2025-02-26T12:50:37.852852",
        "transaction_status": "SUCCESS"
    },
    "uuid": "408ed601-0cf9-4835-9bef-f734410741dc",
    "message": null,
    "error": null
}

Error Example

{
    "status": "fail",
    "code": 1234,
    "data": null,
    "uuid": "408ed601-0cf9-4835-9bef-f734410741dc",
    "message": "Something about this doesn't seem right.",
    "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}}

Field	Type	Description
value	number	The payout amount in MYR.
external_invoice_ref	string	External reference number you assign the client for tracking the payout.
payout_invoice_no	string	Unique internal invoice number for this payout transaction.
payout_account_number	string	The destination bank account number used in the payout.
created_at	string	ISO 8601 timestamp when the payout was initiated.
transaction_status	string	Status of the payout transaction. Possible values: SUCCESS, FAILED, PENDING.

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.