Skip to main content
GET
/
payment-status
/
{transId}
Get Payment Transaction Status
curl --request GET \
  --url https://sandbox.fapshi.com/payment-status/{transId} \
  --header 'apikey: <api-key>' \
  --header 'apiuser: <api-key>'
[
  {
    "transId": "<string>",
    "status": "CREATED",
    "medium": "mobile money",
    "serviceName": "<string>",
    "amount": 123,
    "revenue": 123,
    "payerName": "<string>",
    "email": "jsmith@example.com",
    "redirectUrl": "<string>",
    "externalId": "<string>",
    "userId": "<string>",
    "webhook": "<string>",
    "financialTransId": "<string>",
    "dateInitiated": "2023-12-25",
    "dateConfirmed": "2023-12-25"
  }
]

​
Endpoint

GET /payment-status/:transId Check the status of a payment by transaction ID.

​
Status Values

StatusMeaning
CREATEDPayment not yet attempted.
PENDINGUser is in process of payment.
SUCCESSFULPayment completed successfully.
FAILEDPayment failed.
EXPIREDThis means 24 hours have passed since the payment link was generated and no successful payment attempt was made in that time interval OR the link got manually expired to prevent payment.
No payments can be made after the status is SUCCESSFUL or EXPIRED.

Authorizations

​
apiuser
string
header
required
​
apikey
string
header
required

Path Parameters

​
transId
string
required

Transaction ID of the payment.

Response

Payment status retrieved successfully

​
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

⌘I