Payouts
Create a payout
API Documentation
- Introduction to the FedaPay API
- Customers
- Collect
- Payouts
- Events
- Balances
- Currencies
- Logs
- Webhooks
Payouts
Create a payout
This endpoint creates a new payout.
POST
/
payouts
const { FedaPay, Payout } = require('fedapay');
FedaPay.setApiKey('YOUR_API_KEY');
FedaPay.setEnvironment('sandbox');
const payout = await Payout.create(params = {}, headers = {});
{
"id": 123,
"reference": "<string>",
"amount": 123,
"status": "<string>",
"customer_id": 123,
"currency_id": 123,
"mode": "<string>",
"last_error_code": "<string>",
"commission": 123,
"fees": 123,
"fixed_commission": 123,
"amount_transferred": 123,
"amount_debited": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"scheduled_at": "2023-11-07T05:31:56Z",
"sent_at": "2023-11-07T05:31:56Z",
"failed_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"metadata": {},
"custom_metadata": {},
"payment_method_id": 123,
"transaction_key": "<string>",
"merchant_reference": "<string>",
"account_id": 123,
"balance_id": 123
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Response
201
application/json
Payout created successfully.
The response is of type object
.
const { FedaPay, Payout } = require('fedapay');
FedaPay.setApiKey('YOUR_API_KEY');
FedaPay.setEnvironment('sandbox');
const payout = await Payout.create(params = {}, headers = {});
{
"id": 123,
"reference": "<string>",
"amount": 123,
"status": "<string>",
"customer_id": 123,
"currency_id": 123,
"mode": "<string>",
"last_error_code": "<string>",
"commission": 123,
"fees": 123,
"fixed_commission": 123,
"amount_transferred": 123,
"amount_debited": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"scheduled_at": "2023-11-07T05:31:56Z",
"sent_at": "2023-11-07T05:31:56Z",
"failed_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"metadata": {},
"custom_metadata": {},
"payment_method_id": 123,
"transaction_key": "<string>",
"merchant_reference": "<string>",
"account_id": 123,
"balance_id": 123
}