GET
/
payouts
/
search
const { FedaPay, Payout } = require('fedapay');
/* Replace YOUR_SECRETE_API_KEY with your real API key */
FedaPay.setApiKey("YOUR_SECRETE_API_KEY");
/* Specify whether you want to run your query in test or live mode */
FedaPay.setEnvironment('sandbox'); //or setEnvironment('live');
/* Show payouts */
const payout = await Payout.all(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

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json
List of payouts.

The response is of type object[].