LogoLogo
  • Overview
  • Authentication
  • Status Webhooks
  • Error Codes
  • Payout API
    • Receiver
      • Create New Receiver
      • Bank Accounts
        • Add AU Bank Account
      • Get Receiver
      • Get Receiver Bank Account
    • Payout
      • Create a Payout Transaction
      • Get Payout
    • Balance
      • Get Account Balance
    • Account
      • Get Current Account
Powered by GitBook
On this page
  1. Payout API
  2. Payout

Create a Payout Transaction

Create a Payout

Create a Payout

POST /api/payout/single

Headers

Name
Value

x-api-key

<token>

signature

<token>

Body

Name
Type
Description

receiver_id*

string

Receiver ID to make payout.

account_id*

string

Account ID to make payout.

amount*

string

Amount ID to make payout in Cent.

currency*

string

Currency ID to make payout.

reference

string

Referance of payout.

note

string

Note of payout.

* is mandatory parameter

Example body request

{
    "receiver_id": "f85cbb74-6af7-43cb-b0a2-b5e5b9838de6",
    "account_id": "ad5ac900-ac63-4e60-894b-1de10f04f876",
    "amount": 2000, // cent
    "currency": "AUD",
    "reference": "ref-16aud",
    "note": "Payout for Frank"
}

Response

{
    "message": "Payout created successfully",
    "payload": {
        "payout_id": "44389fbd-5931-431a-bcac-cfb73ccc6494"
    }
}
{
    "message": "There was an error while creating a payout",
    "error": [
        {
            "code": "PAYO201",
            "message": "Receiver not found"
        }
    ]
}
PreviousPayoutNextGet Payout