API Reference
Payouts
Send payouts to mobile money accounts.
PayoutsRepository
Access via FedaFlutter.instance.payouts.
Methods
getPayouts()
Returns a list of payouts.
final res = await repo.getPayouts();
// res.data → List<Payout>
getPayout(int id)
Returns a single payout by ID.
final res = await repo.getPayout(123);
print(res.data?.status); // 'sent'
createPayout(dynamic data)
Creates a new payout. Accepts a PayoutCreate DTO or a raw Map.
final res = await repo.createPayout(PayoutCreate(
amount: 3000,
currency: CurrencyIso(iso: 'XOF'),
customer: CustomerCreate(
firstname: 'Alice',
lastname: 'Smith',
email: 'alice@example.com',
phoneNumber: PhoneNumber(number: '97000000', country: 'BJ'),
),
mode: 'moov',
));
updatePayout(int id, dynamic data)
Updates an existing payout.
sendPayouts(List<int> ids)
Sends multiple payouts at once.
await repo.sendPayouts([1, 2, 3]);
DTOs
PayoutCreate
| Field | Type | Required |
|---|---|---|
amount | num | ✅ |
currency | CurrencyIso | ✅ |
customer | CustomerCreate | ✅ |
mode | String? | ❌ ('moov', 'mtn', etc.) |
Payout modes
| Mode | Description |
|---|---|
moov | Moov Africa mobile money |
mtn | MTN Mobile Money |
card | Card payment |