Skip to main content
GET
Get Payment Transaction Status

Endpoint

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

Status Values

No payments can be made after the status is SUCCESSFUL or EXPIRED.
Fapshi does not collect partial payments. It always collects the full amount you passed to the API, so a SUCCESSFUL status means that exact amount was collected. The revenue field is the amount you receive after Fapshi’s 3% fee. See Amounts and Fees.
A FAILED status does not indicate why the payment failed. Fapshi does not distinguish between insufficient funds, a declined or cancelled payment, or a prompt the customer did not respond to, because operator messages are usually too vague to tell with certainty. See Failed Transactions.

Error Responses

The response body always contains a message field explaining the error. Never treat a 400 or 404 response as a payment failure: it means the transaction does not exist.
For a given transaction ID, you can make at most 6 requests per minute. Exceeding this limit returns a 429 response.It is generally better to rely on webhook notifications to know when a payment status changes, rather than polling this endpoint.

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,
fapshi
serviceName
string

Name of the service in use

transType
enum<string>

Type of transaction

Available options:
Collection,
Payout
amount
integer

Transaction amount

revenue
integer

Amount received when Fapshi fees (3% of amount) 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

reason
string

Typically appears when a payout via fapshi fails

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