POST
/
direct-pay
Initiate a Direct Payment Request
curl --request POST \
  --url https://sandbox.fapshi.com/direct-pay \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --header 'apiuser: <api-key>' \
  --data '{
  "amount": 101,
  "phone": "<string>",
  "medium": "mobile money",
  "name": "<string>",
  "email": "jsmith@example.com",
  "userId": "<string>",
  "externalId": "<string>",
  "message": "<string>"
}'
{
  "message": "<string>",
  "transId": "<string>",
  "dateInitiated": "2023-12-25"
}

​
Endpoint

POST /direct-pay

Send a payment request directly to a user’s mobile device. You are responsible for building your own checkout and verifying payment status.

​
Parameters

NameRequiredTypeDescription
amountYesintegerAmount to be paid (minimum 100 XAF).
phoneYesstringPhone number to request payment from (e.g., 67XXXXXXX).
mediumNostring"mobile money" or "orange money". Omit to auto-detect.
nameNostringPayer’s name.
emailNostringPayer’s email to receive receipt.
userIdNostringYour system’s user ID (1–100 chars; a–z, A–Z, 0–9, -, _).
externalIdNostringTransaction/order ID for reconciliation (1–100 chars; a–z, A–Z, 0–9, -, _).
messageNostringReason for payment.

​
Response

  • 200 OK with JSON body containing:

    • message: success message
    • transId: transaction ID to track payment status
    • dateInitiated: date when the payment was initiated

  • Errors return 4XX with failure message.

Direct payment is disabled by default on live environment; contact support to enable.
Handle this endpoint with care; misuse can result in account suspension.

Authorizations

​
apiuser
string
header
required
​
apikey
string
header
required

Body

application/json

Response

200
application/json

Accepted

The response is of type object.