Payout Reference
The payout object is simple by design to make it easy to deal with and understand. Here is the field reference of the object.
Field | Type | Description |
|---|---|---|
id | string | A universally unique identifier (UUID). |
status | string | Status of the payout. See below. |
amount | integer | The amount to send is specified in the minor currency unit (e.g. Halalah). 15 SAR = 1500 Halalah 15 KWD = 15000 Fils |
currency | string | Currency of the payout. |
purpose | string | Purpose of the Payout |
comment | string | A description of the payout. |
destination | object | Beneficiary information. |
message | string | The message contains a human-readable text of the current status. |
created_at | string | Timestamp of the creation time formatted in ISO8601. |
updated_at | string | Timestamp of the update time formatted in ISO8601. |
source_id | string | UUID of the source Payout Account. |
Field | Type | Description |
|---|---|---|
type | string | Type of the destination. Only the value bank is supported for now. |
mobile | string | Phone or mobile number of the beneficiary. |
iban | string | IBAN of the beneficiary. |
name | string | Name of the beneficiary. |
country | string | Country of the beneficiary. |
city | string | City of the beneficiary. |
Field | Type | Description |
|---|---|---|
type | string | Type of the destination. Only the value wallet is supported for now. |
mobile | string | Phone or mobile number of the beneficiary. |
Status | Description |
|---|---|
queued | The payout is saved by the system and scheduled for processing. |
initiated | The payout has been dispatched to the bank or wallet system and is being processed there. |
paid | The payout has been processed successfully. |
failed | The payout has failed. Check message for more info. |
canceled | The payout has been canceled. |
returned | The payout has returned from destination bank. |
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 dividend_payment government_payment investment_house payment_to_merchant own_account_transfer |