Generate a Payment Link
Endpoints
Generate a Payment Link
Create a payment link to redirect users to a Fapshi-hosted checkout page.
POST
Generate a Payment Link
Endpoint
POST /initiate-pay
Generate a payment link where users complete payment on a prebuilt Fapshi checkout page.
Parameters
Response
-
200 OKwith JSON body containing:message: success messagelink: URL for user paymenttransId: transaction ID to track payment statusdateInitiated: date when the payment was initiated
- Errors return 4XX with a message explaining the failure.
Payment links expire after 24 hours and cannot be used afterward.
Body
application/json
Amount to be paid (minimum 100 XAF).
Required range:
x >= 100Optional user email to skip during payment.
URL to redirect after payment.
Internal user ID (1-100 chars; a-z, A-Z, 0-9, -, _).
Pattern:
^[a-zA-Z0-9\-_]{1,100}$Transaction/order ID for reconciliation (1-100 chars; a-z, A-Z, 0-9, -, _).
Pattern:
^[a-zA-Z0-9\-_]{1,100}$Reason for payment.