POST
/
api
/
v1
/
transactions
/
wallet
/
payout
/
Stripe Payout
curl --request POST \
  --url https://hpay-api.host-sl.com/api/v1/transactions/wallet/payout/ \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "wallet_id": "<string>",
  "amount": 123,
  "currency": "<string>",
  "description": "<string>"
}
'
{
  "id": "trans_456def...",
  "wallet_id": "wall_789xyz...",
  "amount": 100.0,
  "currency": "USD",
  "transaction_type": "withdrawal",
  "payment_method": "bank",
  "status": "pending",
  "stripe_fee": 2.5,
  "application_fee": 1.0,
  "description": "Stripe Payout (100.0 USD)",
  "created_at": "2025-01-16T11:00:00Z"
}
This endpoint allows users to withdraw funds from their wallet to their linked bank account or debit card. This process uses Stripe Connect to securely transfer funds.

Request Body

wallet_id
string
required
The unique identifier of the wallet to withdraw funds from.
amount
number
required
The amount to withdraw.
currency
string
default:"usd"
The currency code for the payout. Optional; defaults to usd.
description
string
default:"Wallet withdrawal"
An optional description for the payout.

Response

id
string
The unique identifier for the transaction.
status
string
The current status of the transaction (e.g., “pending”, “completed”, “failed”).
amount
number
The amount being withdrawn.
currency
string
The currency of the withdrawal.
stripe_fee
number
The fee charged by Stripe for the payout.
application_fee
number
The platform fee collected for this withdrawal.
{
  "id": "trans_456def...",
  "wallet_id": "wall_789xyz...",
  "amount": 100.0,
  "currency": "USD",
  "transaction_type": "withdrawal",
  "payment_method": "bank",
  "status": "pending",
  "stripe_fee": 2.5,
  "application_fee": 1.0,
  "description": "Stripe Payout (100.0 USD)",
  "created_at": "2025-01-16T11:00:00Z"
}
curl --request POST \
  --url https://hpay-api.host-sl.com/api/v1/transactions/wallet/payout/ \
  --header 'api-key: YOUR_API_KEY' \
  --header 'secret-key: YOUR_SECRET_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "wallet_id": "wall_789xyz...",
    "amount": 100.00,
    "currency": "USD"
  }'