Skip to main content
Base URL: https://your-domain.com/api
All endpoints on this page require Authorization: Bearer {token}.

Flow overview

1

Validate the recipient

Call POST /send-money-email-check or POST /send-money-phone-check to confirm the recipient exists and is active.
2

Select currency

Call GET /get-send-money-currencies to list the sender’s eligible wallets.
3

Check fees and limits

Call POST /check-send-money-amount-limit with the chosen currency and amount to get fee details.
4

Execute the transfer

Call POST /send-money-pay with the confirmed values.

POST /send-money-email-check

Validates that a recipient email is eligible to receive a transfer.

Request parameters

user_id
number
required
The authenticated sender’s ID.
receiverEmail
string
required
The recipient’s email address.

Response fields

success
object
curl --request POST \
  --url https://your-domain.com/api/send-money-email-check \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json' \
  --data '{"user_id": 42, "receiverEmail": "[email protected]"}'

POST /send-money-phone-check

Validates that a recipient phone number is eligible to receive a transfer.

Request parameters

user_id
number
required
The authenticated sender’s ID. The sender must have a phone number set.
receiverPhone
string
required
The recipient’s formatted phone number (international format).

Response fields

success
object
curl --request POST \
  --url https://your-domain.com/api/send-money-phone-check \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json' \
  --data '{"user_id": 42, "receiverPhone": "+11234567890"}'

GET /get-send-money-currencies

Returns the currencies available for the sender to use, filtered to wallets that have active fee/limit rules.

Request parameters

user_id
number
required
The authenticated user’s ID.

Response fields

success
object
curl --request GET \
  --url 'https://your-domain.com/api/get-send-money-currencies?user_id=42' \
  --header 'Authorization: Bearer {token}'

POST /check-send-money-amount-limit

Validates the transfer amount against fees and limits, and returns the fee breakdown.

Request parameters

user_id
number
required
The authenticated sender’s ID.
sendCurrency
number
required
The currency ID to send in.
sendAmount
number
required
The amount to send.

Response fields

success
object
curl --request POST \
  --url https://your-domain.com/api/check-send-money-amount-limit \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json' \
  --data '{"user_id": 42, "sendCurrency": 1, "sendAmount": 100}'

POST /send-money-pay

Executes the transfer. Both registered and unregistered recipients (by email or phone) are supported.

Request parameters

user_id
number
required
The authenticated sender’s ID.
emailOrPhone
string
required
Recipient’s email address or phone number.
currency_id
number
required
Currency ID for the transfer.
amount
number
required
Transfer amount (before fees).
totalFees
number
required
Total fees from /check-send-money-amount-limit.
note
string
Optional note to the recipient.

Response fields

status
boolean
true if the transaction was created, false on hard failure.
tr_ref_id
number
The transaction or transfer record ID. Use with /get-user-specific-details to display recipient info.
sendMoneyValidationErrorMessage
string
Validation error message when status is false.
sendMoneyMailErrorMessage
string
Email notification error message when status is true but notification failed.
curl --request POST \
  --url https://your-domain.com/api/send-money-pay \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "user_id": 42,
    "emailOrPhone": "[email protected]",
    "currency_id": 1,
    "amount": 100,
    "totalFees": 1.50,
    "note": "Lunch"
  }'

Build docs developers (and LLMs) love