Payment Transaction Status

Overview

Use this endpoint to check the status of a payment transaction in real time. This is useful for confirming whether a payment was successful, failed, or is still pending.

  • Purpose: Retrieve the current status and details of a payment transaction.
  • Target Audience: All developers and businesses integrating with BobPlus Africa APIs.

Quickstart: Check Transaction Status
  1. Obtain your Bearer Token and generate the required signature.
  2. Send a POST request to the status endpoint with the required parameters.
  3. Parse the response to get the transaction status and details.

Endpoint Reference
HTTP MethodPOST
Endpoint URL/api/v2/payment/status-query
Base URLhttps://here-prod-api-url.com
DescriptionCheck the status of a payment transaction.
Request Body
FieldTypeDescriptionRequired
wallet_nostring Business wallet number assignedYes
referencestring Reference passed during payment/payoutYes
Request Headers
HeaderTypeDescriptionRequired
AuthorizationstringBearer token used to access the APIYes
SignaturestringSHA-256 signature. Concatenate wallet_no+reference, sign with your private key, and Base64 encode.Yes

Example Request
curl --location 'https://here-prod-api-url.com/api/v2/payment/status-query' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>' \
--header 'Signature: 23454321' \
--header 'Content-Type: application/json' \
--data '{
  "wallet_no": "234xxx2343",
  "reference": "052423213417"
}'

Success Response
FieldTypeDescription
successbooleanIndicates if the request was successful
messagestringResponse message
dataobjectTransaction details (see below)
{
    "success": true,
    "message": "Successfully fetched",
    "data": {
        "acc_name": "John Doe",
        "acc_no": "2547xxxxxxxxxx",
        "description": "Deposit to wallet",
        "transaction_id": "052423213417",
        "reference": "K902101",
        "status": "SUCCESS",
        "status_description": "Unable to lock subscriber, a transaction is already in process for the current subscriber",
        "date": "2024-02-17 16:06:45 PM"
    }
}
{
    "success": true,
    "message": "Successfully fetched",
    "data": {
        "acc_name": "John Doe",
        "acc_no": "2547xxxxxxxxxx",
        "description": "Deposit to wallet",
        "transaction_id": "",
        "reference": "K902001",
        "status": "FAILED",
        "status_description": "Unable to lock subscriber, a transaction is already in process for the current subscriber",
        "date": "2024-02-17 16:06:45 PM"
    }
}

Security Best Practices
  • Always use HTTPS for all API requests.
  • Keep your private key secure and never share it.
  • Verify the signature on the server side for every request.

Support & Feedback

For help, contact support@bobplus.africa.
Feedback on this documentation? Let us know.


Terms of Use & Legal

By using this API, you agree to our Terms of Service and Privacy Policy. Do not share sensitive data or credentials.