Skip to main content
POST
/
webhook
/
payment-status
[
  {
    "transId": "<string>",
    "status": "CREATED",
    "medium": "mobile money",
    "serviceName": "<string>",
    "amount": 123,
    "revenue": 123,
    "payerName": "<string>",
    "email": "[email protected]",
    "redirectUrl": "<string>",
    "externalId": "<string>",
    "userId": "<string>",
    "webhook": "<string>",
    "financialTransId": "<string>",
    "dateInitiated": "2023-12-25",
    "dateConfirmed": "2023-12-25"
  }
]
A webhook is an API endpoint made available to external applications that can be called to notify your application whenever a significant event occurs. This allows your app to react or respond immediately to these events. You can set a webhook URL per service on your Fapshi dashboard. When set, a POST request will be sent to this webhook URL whenever the status of a payment changes to:
  • SUCCESSFUL — when a payment attempt completes successfully
  • FAILED — when a payment attempt fails (usually on operator networks like MTN Mobile Money or Orange Money)
  • EXPIRED — when a payment link expires after 24 hours without successful payment
The body of the webhook request will be the same as the response body returned when querying a payment status.
Your server should respond quickly to webhook requests to avoid timeouts. Fapshi sends only one webhook request per event, regardless of whether your server responds or not.

Authorizations

​
apiuser
string
header
required
​
apikey
string
header
required

Response

Acknowledgement of webhook receipt

​
transId
string

Transaction ID of the payment.

​
status
enum<string>

Transaction status

Available options:
CREATED,
PENDING,
SUCCESSFUL,
FAILED,
EXPIRED
​
medium
enum<string>

Payment method

Available options:
mobile money,
orange money
​
serviceName
string

Name of the service in use

​
amount
integer

Transaction amount

​
revenue
integer

Amount received when Fapshi fees have been deducted

​
payerName
string

Client name

​
email
string<email>

Client email

​
redirectUrl
string<uri>

URL to redirect after payment

​
externalId
string

The transaction ID on your application

​
userId
string

ID of the client on your application

​
webhook
string<uri>

The webhook you defined for your service

​
financialTransId
string

Transaction ID with the payment operator

​
dateInitiated
string<date>

Date when the payment was initiated

​
dateConfirmed
string<date>

Date when the payment was made