Payouts
Start payout
API Documentation
- Introduction to the FedaPay API
- Customers
- Collect
- Payouts
- Events
- Balances
- Currencies
- Logs
- Webhooks
Payouts
Start payout
PUT
/
payouts
/
start
curl --request PUT \
--url https://sandbox-api.fedapay.com/v1/payouts/start \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '[
{
"id": 1,
"scheduled_at": "2024-10-23T14:30:00Z",
"phone_number": {
"number": "+22997808080",
"country": "BJ"
}
}
]'
[
{
"id": 1,
"reference": "PAYOUT-123456",
"amount": 1000,
"status": "sent",
"customer_id": 42,
"currency_id": 840,
"mode": "automatic",
"last_error_code": "NO_ERROR",
"commission": 50,
"fees": 5,
"fixed_commission": 10,
"amount_transferred": 935,
"amount_debited": 1000,
"created_at": "2024-10-23T14:00:00Z",
"updated_at": "2024-10-23T14:00:00Z",
"scheduled_at": "2024-10-23T14:30:00Z",
"sent_at": "2024-10-23T14:31:00Z",
"failed_at": "2024-10-23T14:32:00Z",
"deleted_at": "2024-10-23T14:33:00Z",
"metadata": {},
"custom_metadata": {},
"payment_method_id": 1,
"transaction_key": "TRANSACTION-XYZ",
"merchant_reference": "MERCHANT-456",
"account_id": 5,
"balance_id": 10
}
]
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json · object[]
The body is of type object[]
.
Response
200
application/json
Payouts started successfully.
The response is of type object[]
.
curl --request PUT \
--url https://sandbox-api.fedapay.com/v1/payouts/start \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '[
{
"id": 1,
"scheduled_at": "2024-10-23T14:30:00Z",
"phone_number": {
"number": "+22997808080",
"country": "BJ"
}
}
]'
[
{
"id": 1,
"reference": "PAYOUT-123456",
"amount": 1000,
"status": "sent",
"customer_id": 42,
"currency_id": 840,
"mode": "automatic",
"last_error_code": "NO_ERROR",
"commission": 50,
"fees": 5,
"fixed_commission": 10,
"amount_transferred": 935,
"amount_debited": 1000,
"created_at": "2024-10-23T14:00:00Z",
"updated_at": "2024-10-23T14:00:00Z",
"scheduled_at": "2024-10-23T14:30:00Z",
"sent_at": "2024-10-23T14:31:00Z",
"failed_at": "2024-10-23T14:32:00Z",
"deleted_at": "2024-10-23T14:33:00Z",
"metadata": {},
"custom_metadata": {},
"payment_method_id": 1,
"transaction_key": "TRANSACTION-XYZ",
"merchant_reference": "MERCHANT-456",
"account_id": 5,
"balance_id": 10
}
]