Payout
Payout Object Properties and Data Types
id
Description
Munify’s Payout Identifier.Type
UUIDcustomer_reference
Description
Customer Payout Reference (Sent on initiating the payout).Type
Stringcreated
Description
Payout Timestamp.Type
DateTime (Iso Format)bank
Description
Payout Receiver BankType
Objectbank.name
Description
Payout Receiver Bank Name.Type
Stringbank.code
receiver_name
Description
Payout Receiver Name.Type
Stringreceiver_phone
Description
Payout Receiver Phone.Type
Stringreceiver_identifier
Description
Payout Receiver Identifier. (Wallet Phone Number, Bank Account Number, Card Number)Type
Stringamount
Description
Payout Actual Amount.Type
Decimalfixed_fee_amount
Description
Payout Fixed Fee Amount (If any)Type
Decimalvariable_fee_amount
Description
Payout Variable Fee Amount (If any)Type
Decimaltotal_amount
Description
Payout Total Amount (amount + fixed_fee_amount + variable_fee_amount).Type
Decimalcurrency
status
type
description
Description
Payout description.Type
Stringtimeline
Description
List of payout status change history.Type : object
| Key | Type |
|---|---|
on | Date (Iso Format) |
status | Enum Payout Statuses |
failure_reason
Description
The reason behind failure if any.Type
Stringinitiated_from
Payout JSON Object
"payout": {
"id": "37c23ed0-5001-11ef-9454-0242ac120002",
"customer_reference": "123456",
"created": "2024-08-03T12:07:22.714321",
"bank": {
"name": "Commercial International Bank - Egypt S.A.E",
"code": "CIB"
},
"receiver_name": "Ali Ahmed Mohamed Ahmed",
"receiver_phone": "+201XXXXXXXXX",
"receiver_identifier": "12345678901234",
"amount": 1576.85,
"fixed_fee": 10,
"variable_fee": 15.77,
"total_amount": 1551.08,
"currency": "EGP",
"status": "REJECTED",
"payout_type": "BANK_ACCOUNT",
"description": "Subscription Fees",
"timeline": [
{
on: "2024-08-05T12:39:24.940517Z",
status: "INITIATED",
},
{
on: "2024-08-07T16:25:32.495071Z",
status: "REJECTED",
},
],
"failure_reason" : "Unregistered receiver wallet"
}