Get Payout

At any given time, you can request a payout to check on the status. It will return the payout object.

Please ensure that the correct ID is provided to prevent any errors in the API response.

HTTP Method: GET

https://api.payright.my/api/v1/merchant/payout/{invoice_no}

or as alternative, you may also supply your external invoice reference

https://api.payright.my/api/v1/merchant/payout/{external_invoice_ref}

Query Parameters

Property	Type	Description
invoice_no*	string	Transaction invoice number that you want to get the status
external_invoice_ref	string	Transaction external invoice reference that you included during create a payout to get the status

Response

{
    "status": "ok",
    "code": 2000,
    "data": {
        "is_recon": false,
        "payout_invoice_no": "po-6DC1:125037-pyt",
        "record_status": 1,
        "payout_account_number": "12345678901",
        "account_id": 8,
        "created_at": "2025-02-26T12:50:37.852852",
        "transaction_status": "SUCCESS",
        "updated_at": "2025-02-26T12:52:08.026676",
        "id": 25,
        "recipient_name": null,
        "processed_at": null,
        "switch_invoice_id": "VP1734515432R6Yt1",
        "recipient_reference": null,
        "api_key": "408ed601-0cf9-4835-9bef-f734410741dc",
        "merchant_invoice_id": "VA-AE81DE-120345369538-PAYOUT",
        "name_confident_level": null,
        "external_invoice_ref": "Payright03",
        "value": 13.0,
        "error_message": {
            "response_code": 2100,
            "error_code": null,
            "error_message": null,
            "description": "",
            "data": null
        }
    },
    "uuid": "408ed601-0cf9-4835-9bef-f734410741dc",
    "message": null,
    "error": null
}