Base URL: https://your-domain.com/api
All endpoints on this page require Authorization: Bearer {token}.
Flow overview
Validate the payer
Call POST /request-money-email-check or POST /request-money-phone-check.
Select a currency
Call GET /get-request-currency to list eligible currencies.
Create the request
Call POST /request-money-pay.
Payer accepts or cancels
The payer calls POST /accept-request-payment-pay to accept, or either party calls POST /cancel-request to cancel.
POST /request-money-email-check
Validates the payer’s email before creating a request.
Request parameters
The authenticated requester’s ID.
Email of the user who will pay.
Response fields
200 on success, 401 on failure.
Error reason: own-email, suspended, or inactive.
curl --request POST \
--url https://your-domain.com/api/request-money-email-check \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data '{"user_id": 42, "receiverEmail": "[email protected]"}'
POST /request-money-phone-check
Validates the payer’s phone number before creating a request.
Request parameters
The authenticated requester’s ID. Must have a phone number set.
Phone number of the user who will pay (international format).
Response fields
200 on success, 401 on failure, 404 if requester has no phone.
Error reason: own-phone, suspended, or inactive.
curl --request POST \
--url https://your-domain.com/api/request-money-phone-check \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data '{"user_id": 42, "receiverPhone": "+11234567890"}'
GET /get-request-currency
Returns currencies that can be used in a money request, filtered by active fee/limit rules.
Request parameters
The authenticated user’s ID.
Response fields
Key-value map of currency_id to currency info (id, code, symbol, type).
Currency ID of the user’s default wallet.
curl --request GET \
--url 'https://your-domain.com/api/get-request-currency?user_id=42' \
--header 'Authorization: Bearer {token}'
POST /request-money-pay
Creates a money request. The payer receives a notification by email or SMS.
Request parameters
The authenticated requester’s ID.
Email or phone number of the payer.
Currency ID for the request.
Optional note for the payer.
Response fields
true if the request was created.
ID of the created request payment record.
requestMoneyMailErrorMessage
Email error message if notification failed but the request was still created.
curl --request POST \
--url https://your-domain.com/api/request-money-pay \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data '{
"user_id": 42,
"emailOrPhone": "[email protected]",
"currencyId": 1,
"amount": 50,
"note": "Split for dinner"
}'
GET /accept-request-email-phone
Retrieves the request details (creator email/phone, amount, currency) for a given request payment. Used to populate the accept flow.
Request parameters
Response fields
Creator’s email, if applicable.
Creator’s phone, if applicable.
curl --request GET \
--url 'https://your-domain.com/api/accept-request-email-phone?tr_ref_id=77' \
--header 'Authorization: Bearer {token}'
POST /request-accept-amount-limit-check
Checks whether the payer has sufficient balance and the amount is within limits before acceptance.
Request parameters
The amount being accepted.
Currency ID of the request.
Response fields
200 on success, 401 on failure.
Failure reason: invalidCurrency, insufficientBalance, minLimit, or minMaxLimit.
Minimum limit (on limit error).
Maximum limit (on limit error).
curl --request POST \
--url https://your-domain.com/api/request-accept-amount-limit-check \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data '{"user_id": 55, "amount": 50, "currency_id": 1}'
GET /get-accept-fees-details
Returns the fee breakdown for accepting a money request.
Request parameters
Response fields
curl --request GET \
--url 'https://your-domain.com/api/get-accept-fees-details?user_id=55&amount=50¤cy_id=1' \
--header 'Authorization: Bearer {token}'
POST /accept-request-payment-pay
Confirms and executes the payment for an accepted money request.
Request parameters
Total fees from /get-accept-fees-details.
Creator’s email or phone (used for notification routing).
Response fields
true if the payment was accepted.
requestAccptValidationErrorMessage
Validation error when status is false.
curl --request POST \
--url https://your-domain.com/api/accept-request-payment-pay \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data '{
"user_id": 55,
"tr_ref_id": 77,
"amount": 50,
"currency_id": 1,
"totalFees": 0.75,
"tr_email_or_phone": "[email protected]"
}'
POST /cancel-request
Cancels an existing money request. Either the creator or the payer may call this endpoint.
Request parameters
The calling user’s ID (creator or payer).
The transaction ID associated with the request payment.
The other party’s email or phone (used for notification routing).
Response fields
200 on success, 401 on error.
Error message on failure.
curl --request POST \
--url https://your-domain.com/api/cancel-request \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data '{
"user_id": 42,
"tr_id": 1001,
"tr_email_or_phone": "[email protected]"
}'
