POST
/
api
/
v1
/
transactions
/
wallet
/
transfer
/
Wallet Transfer
curl --request POST \
  --url https://hpay-api.host-sl.com/api/v1/transactions/wallet/transfer/ \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "sender_wallet_id": "<string>",
  "recipient_identifier": "<string>",
  "amount": 123,
  "description": "<string>"
}
'
{
  "id": "trans_123abc...",
  "wallet_id": "wall_sender_123...",
  "recipient_wallet_id": "wall_recipient_789...",
  "amount": 50.0,
  "currency": "USD",
  "transaction_type": "transfer",
  "payment_method": "wallet",
  "status": "completed",
  "application_fee": 1.0,
  "description": "Payment for services",
  "created_at": "2025-01-16T10:05:00Z"
}
This endpoint allows for instant transfers of funds between two wallets within your application. You can identify the recipient using their username, phone number, or email address.

Request Body

sender_wallet_id
string
required
The unique identifier of the wallet sending the funds.
recipient_identifier
string
required
The identifier of the recipient user (username, phone number, or email).
amount
number
required
The amount to transfer in the application’s base currency.
description
string
An optional description for the transfer (default: “Wallet transfer”).

Response

id
string
The unique identifier for the transaction.
wallet_id
string
The ID of the sender’s wallet.
recipient_wallet_id
string
The ID of the recipient’s wallet.
amount
number
The net amount transferred to the recipient.
currency
string
The currency code (e.g., “USD”).
status
string
The current status of the transaction (e.g., “completed”).
application_fee
number
The platform fee collected from the sender for this transfer.
{
  "id": "trans_123abc...",
  "wallet_id": "wall_sender_123...",
  "recipient_wallet_id": "wall_recipient_789...",
  "amount": 50.0,
  "currency": "USD",
  "transaction_type": "transfer",
  "payment_method": "wallet",
  "status": "completed",
  "application_fee": 1.0,
  "description": "Payment for services",
  "created_at": "2025-01-16T10:05:00Z"
}
curl --request POST \
  --url https://hpay-api.host-sl.com/api/v1/transactions/wallet/transfer/ \
  --header 'api-key: YOUR_API_KEY' \
  --header 'secret-key: YOUR_SECRET_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "sender_wallet_id": "wall_sender_123...",
    "recipient_identifier": "recipient_username",
    "amount": 50.00
  }'