Developer Suite
Register Sandbox
Register Sandbox
    • Overview
    • API Endpoints
    • Ecommerce Checkout
      • Purchase
        POST
      • Get a transaction details
        POST
      • Close transaction
        POST
      • Check transaction
        POST
      • Refund API
        POST
      • Get transaction list
        POST
      • Exchange rate
        POST
    • Checkout Plugins
      • Prestashop
      • Woocommerce
    • Credentials on File
      • Link Account
        POST
      • Link Card
        POST
      • Purchase using token
        POST
      • Remove account token
        POST
      • Remove card token
        POST
      • Get linked account details
        POST
    • ABA QR API
      • QR API
        POST
    • Payment Link
      • Create payment link
        POST
      • Get payment link details
        POST
    • Pre-auth
      • Complete pre-auth transactions
        POST
      • Complete pre-auh transaction with payout
        POST
      • Cancel pre-purchase transaction
        POST
    • Payout
      • Payout
      • Update a beneficiary status
      • Add a beneficiary to whitelist
    • KHQR Guideline
    • Resources

    Payout

    1. Introduction#

    A payout refers to the distribution of funds from a business, platform, or payment system to a recipient, such as a vendor, freelancer, or customer. It typically occurs when a company disburses earnings, refunds, commissions, or withdrawals.
    PayWay provides two different types of payout services:
    1.
    Payout: Distribute fund from your settlement account to recipients.
    2.
    Split & Payout : Collect, split and distribute funds of a purchase transaction to recipients. Split and Payout is available for the following PayWay products:
    1.
    Checkout
    2.
    Account on File and Card on file
    3.
    Payment Link (API Integration Only)
    4.
    ABA QR API
    5.
    Pre-auth

    2. How it works#

    Beneficiary List#

    Before making a payout to a beneficiary or recipient, you must first add them to your beneficiary list. This ensures that the recipient is registered and eligible to receive payments.
    To add a beneficiary to the list, follow the Add a beneficiary to whitelist API specification. Once the beneficiary is added, it is automatically enabled and can start receiving the payments.
    When using Payout or Split & Payout, you must include the beneficiary details along with the payout amount in the payout instruction parameter. This step ensures that the payment is directed to the correct beneficiary with the specified amount.
    If you want to disable the beneficiary, follow the Update a beneficiary status API specification.
    The beneficiary must be either an ABA Account holder or ABA Merchant. For ABA account holders, you just need to have their ABA Account and for ABA Merchant, you need to have their MID.
    Payout
    Split and Payout
    To distribute funds from your settlement account to beneficiaries, please follow Payout API specification.
    Previous
    Cancel pre-purchase transaction
    Next
    Payout