PUT
/
payouts
/
{id}
NodeJs
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');
/* Update a payout */
const payout = await Payout.update(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.

Path Parameters

id
integer
required

Payout ID.

Body

application/json
status
string

Payout status (e.g., 'pending', 'scheduled', 'sent', 'failed').

scheduled_at
string<date-time>

Date and time the payout is scheduled to be sent.

Response

Payout updated successfully.

id
integer

Payout ID.

reference
string

Payout reference.

amount
integer

Payout amount.

status
string

Payout status (e.g., 'pending', 'scheduled', 'sent', 'failed').

customer_id
integer

Customer ID associated with the payout.

currency_id
integer

Currency ID associated with the payout.

mode
string

Payout mode.

last_error_code
string

Last error code encountered during the payout.

commission
integer

Payout commission.

fees
integer

Payout fees.

fixed_commission
integer

Fixed commission applied to the payout.

amount_transferred
integer

Amount transferred to the beneficiary.

amount_debited
integer

Amount debited from the payer.

created_at
string<date-time>

Date and time of payout creation.

updated_at
string<date-time>

Date and time of last payout update.

scheduled_at
string<date-time>

Date and time the payout is scheduled to be sent.

sent_at
string<date-time>

Date and time the payout was sent.

failed_at
string<date-time>

Date and time the payout failed.

deleted_at
string<date-time>

Date and time of payout deletion.

metadata
object

Additional metadata related to the payout.

custom_metadata
object

Custom metadata associated with the payout.

payment_method_id
integer

Payment method ID used for the payout.

transaction_key
string

Unique key associated with the payout.

merchant_reference
string

Merchant reference provided for the payout.

account_id
integer

Account ID associated with the payout.

balance_id
integer

Balance ID associated with the payout.