Create Payout

4min
Before using Payout, you need to update address information from the Moyasar Dashboard.
If you haven't done that yet, go over the Payout Introduction﻿ in order to understand how it works and what is required to create a Payout Account.
Most banking systems will require a lot of information to complete a single payout like sender basic information, sender address, beneficiary information and address.
Moyasar Payout APIs simplify the common payout pattern by requiring the user first to enter their information through the settings page in the Dashboard.﻿
The payout API will require the bare minimum of information from you to complete a payout.
Bank Payout
Create a Payout
POST
Request
Body Parameters
source_id
required
String
ID of the source bank Payout Account.
amount
required
Integer
The amount to send specified in the minor currency unit (e.g. Halalah).

15 SAR = 1500 Halalah
15 KWD = 15000 Fils
currency
optional
String
The currency of the payout. Default: SAR
comment
required
String
A breif description of the payout.
purpose
required
String
Purpose of the payout operation. See the table below for a list.
destination
required
Object
Destination or beneficiary information.
JSON
{
    "source_id": "8292cb17-0ca4-42ce-b8b3-a7eba3af038f",
    "amount": 20000,
    "currency": "SAR",
    "purpose": "personal",
    "comment": "Test payout",
    "destination": {
        "name": "Abdulaziz",
        "mobile": "0544424173",
        "type": "bank",
        "iban": "SA0380000000608010167519",
        "country": "KSA",
        "city": "Riyadh"
    }
}
{
    "source_id": "8292cb17-0ca4-42ce-b8b3-a7eba3af038f",
    "amount": 20000,
    "currency": "SAR",
    "purpose": "personal",
    "comment": "Test payout",
    "destination": {
        "name": "Abdulaziz",
        "mobile": "0544424173",
        "type": "bank",
        "iban": "SA0380000000608010167519",
        "country": "KSA",
        "city": "Riyadh"
    }
}
Responses
200
{
    "id": "6da068c2-6cbe-4ad3-ab11-2deb61ec2ac9",
    "status": "initiated",
    "amount": 20000,
    "currency": "SAR",
    "purpose": "personal",
    "comment": "Test payout",
    "destination": {
        "type": "bank",
        "mobile": "0544424173",
        "iban": "SA0380000000608010167519",
        "name": "Abdulaziz",
        "country": "KSA",
        "city": "Riyadh"
    },
    "message": null,
    "created_at": "2023-08-16T13:45:30.067Z",
    "updated_at": "2023-08-16T13:45:32.832Z",
    "source_id": "8292cb17-0ca4-42ce-b8b3-a7eba3af038f"
}
{
    "id": "6da068c2-6cbe-4ad3-ab11-2deb61ec2ac9",
    "status": "initiated",
    "amount": 20000,
    "currency": "SAR",
    "purpose": "personal",
    "comment": "Test payout",
    "destination": {
        "type": "bank",
        "mobile": "0544424173",
        "iban": "SA0380000000608010167519",
        "name": "Abdulaziz",
        "country": "KSA",
        "city": "Riyadh"
    },
    "message": null,
    "created_at": "2023-08-16T13:45:30.067Z",
    "updated_at": "2023-08-16T13:45:32.832Z",
    "source_id": "8292cb17-0ca4-42ce-b8b3-a7eba3af038f"
}
﻿
﻿
Wallet Payout
Create a Payout
POST
Request
Body Parameters
source_id
required
String
ID of the source wallet Payout Account.
amount
required
Integer
The amount to send specified in the minor currency unit (e.g. Halalah).

15 SAR = 1500 Halalah
15 KWD = 15000 Fils
currency
optional
String
The currency of the payout. Default: SAR
comment
required
String
A breif description of the payout.
purpose
required
String
Purpose of the payout operation. See the table below for a list.
destination
required
Object
Destination or beneficiary information.
JSON
{
    "source_id": "8292cb17-0ca4-42ce-b8b3-a7eba3af038f",
    "amount": 20000,
    "currency": "SAR",
    "purpose": "personal",
    "comment": "Test payout",
    "destination": {
        "type": "wallet",
        "mobile": "0544424173"
    }
}
{
    "source_id": "8292cb17-0ca4-42ce-b8b3-a7eba3af038f",
    "amount": 20000,
    "currency": "SAR",
    "purpose": "personal",
    "comment": "Test payout",
    "destination": {
        "type": "wallet",
        "mobile": "0544424173"
    }
}
Responses
200
{
    "id": "6da068c2-6cbe-4ad3-ab11-2deb61ec2ac9",
    "status": "initiated",
    "amount": 20000,
    "currency": "SAR",
    "purpose": "personal",
    "comment": "Test payout",
    "destination": {
        "type": "wallet",
        "mobile": "0544424173"
    },
    "message": null,
    "created_at": "2023-08-16T13:45:30.067Z",
    "updated_at": "2023-08-16T13:45:32.832Z",
    "source_id": "8292cb17-0ca4-42ce-b8b3-a7eba3af038f"
}
{
    "id": "6da068c2-6cbe-4ad3-ab11-2deb61ec2ac9",
    "status": "initiated",
    "amount": 20000,
    "currency": "SAR",
    "purpose": "personal",
    "comment": "Test payout",
    "destination": {
        "type": "wallet",
        "mobile": "0544424173"
    },
    "message": null,
    "created_at": "2023-08-16T13:45:30.067Z",
    "updated_at": "2023-08-16T13:45:32.832Z",
    "source_id": "8292cb17-0ca4-42ce-b8b3-a7eba3af038f"
}
﻿
﻿
Payout Purpose List
Purpose
bills_or_rent
expenses_services
purchase_assets
saving_investment
government_dues
money_exchange
credit_card_loan
gift_or_reward
personal
investment_transaction
family_assistance
donation
payroll_benefits
online_purchase
hajj_and_umra
divident_payment
government_payment
investment_house
payment_to_merchant
own_account_transfer
﻿
Purpose
bills_or_rent expenses_services purchase_assets saving_investment government_dues money_exchange credit_card_loan gift_or_reward personal investment_transaction family_assistance donation payroll_benefits online_purchase hajj_and_umra divident_payment government_payment investment_house payment_to_merchant own_account_transfer
Updated 04 Aug 2024
Did this page help you?
List Accounts
Create Bulk Payout