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

​
Authorization
string
header
required

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

Body

application/json · object[]
​
id
integer
required

Payout ID

Example:

1

​
scheduled_at
string

Date and time the payout is scheduled to be sent.

Example:

"2024-10-23T14:30:00Z"

​
phone_number
object

Phone number details

Response

200
application/json
Payouts started successfully.
​
id
integer

Payout ID.

Example:

1

​
reference
string

Payout reference.

Example:

"PAYOUT-123456"

​
amount
integer

Payout amount.

Example:

1000

​
status
string

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

Example:

"sent"

​
customer_id
integer

Customer ID associated with the payout.

Example:

42

​
currency_id
integer

Currency ID associated with the payout.

Example:

840

​
mode
string

Payout mode.

Example:

"automatic"

​
last_error_code
string

Last error code encountered during the payout.

Example:

"NO_ERROR"

​
commission
integer

Payout commission.

Example:

50

​
fees
integer

Payout fees.

Example:

5

​
fixed_commission
integer

Fixed commission applied to the payout.

Example:

10

​
amount_transferred
integer

Amount transferred to the beneficiary.

Example:

935

​
amount_debited
integer

Amount debited from the payer.

Example:

1000

​
created_at
string

Date and time of payout creation.

Example:

"2024-10-23T14:00:00Z"

​
updated_at
string

Date and time of last payout update.

Example:

"2024-10-23T14:00:00Z"

​
scheduled_at
string

Date and time the payout is scheduled to be sent.

Example:

"2024-10-23T14:30:00Z"

​
sent_at
string

Date and time the payout was sent.

Example:

"2024-10-23T14:31:00Z"

​
failed_at
string

Date and time the payout failed.

Example:

"2024-10-23T14:32:00Z"

​
deleted_at
string

Date and time of payout deletion.

Example:

"2024-10-23T14:33:00Z"

​
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.

Example:

1

​
transaction_key
string

Unique key associated with the payout.

Example:

"TRANSACTION-XYZ"

​
merchant_reference
string

Merchant reference provided for the payout.

Example:

"MERCHANT-456"

​
account_id
integer

Account ID associated with the payout.

Example:

5

​
balance_id
integer

Balance ID associated with the payout.

Example:

10

Search your payoutsGet a event