API Documentation
API Documentation
  • Introduction
  • Endpoints
  • Authentication
  • Error Codes
  • Signature Validation
  • Sandbox
  • API
    • Payment Provider
    • Payout Provider
    • Collection
      • Create Collection
      • Get Collection
      • Update Collection
      • Get All Collections
    • Bill
      • Create Bill
      • Get Bill
      • Callback
    • Payout
      • Create Payout
      • Get Payout
      • Callback
  • Postman Collection
Powered by GitBook
On this page
  1. API
  2. Payout

Create Payout

This will trigger a payout to selected beneficiary account.

HTTP Method: POST

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

Request Body

{
  "virtual_pool_reference": "VA-AE81DE-120345369538-PAYOUT",
  "payout_service_id": "14",
  "amount": "13",
  "client_redirect_url": "https://www.payright.my/ms",
  "client_callback_url": "https://webhook.site/36d8f28e-972c-4777-b574-bbd9d96e4949",
  "third_party_account_no": "12345678901",
  "recipient_reference": "test3",
  "payment_description": "test payment description3",
  "external_invoice_ref": "Payright03"
}
```

Attributes

Property
Type
Description

virtual_pool_reference*

String

Your virtual pool reference

amount*

Decimal (10,2)

Total amount to be paid in MYR

payout_service_id*

Integer

client_callback_url*

String

Your callback URL

client_redirect_url*

String

Your redirect URL

third_party_account_no*

String

Beneficiary Account No

recipient_reference*

String

Recipient Reference

payment_description*

String

Payment Description

external_invoice_ref*

String

Client's reference number

Response

{
    "status": "ok",
    "code": 2000,
    "data": {
        "status": "SUCCESS",
        "invoice_no": "po-6DC1:125037-pyt"
    },
    "uuid": "408ed601-0cf9-4835-9bef-f734410741dc",
    "message": null,
    "error": null
}

Last updated 2 months ago

Selected payout provider Id provided in API

this