API Documentation
Get Status

Get Payment Status API Documentation

This documentation provides information about the "Get Payment Status" API, which allows merchants to retrieve the status of a payment transaction.

Endpoint

GET https://api.secure.payment.loov-solutions.com/v1/payment/status/{reference}
  • Replace {reference} with the actual payment reference ID.

Request Headers

  • app-key: Your unique application key for authentication.
  • merchant-key: Your unique merchant key for identification.

Success Response

Upon successfully retrieving the payment status, the API will respond with a JSON object containing the payment status information.

Example success response:

{
    "error": false,
    "reference": "MOMAVzvTY7DLyiRCR38",
    "amount": "500",
    "currency": "XAF",
    "status": "initiated",
    "date": "2023-08-08 09:08:17",
    "customer": null
}
  • error: A boolean indicating whether an error occurred (false in this case).
  • reference: The reference code of the payment.
  • amount: The amount of the payment.
  • currency: The currency code of the payment amount.
  • status: The current status of the payment (e.g., "initiated").
  • date: The date and time when the payment status was retrieved.
  • customer: Customer details related to the payment (may be null if not applicable).

Example Usage

cURL

curl -X GET "https://api.secure.payment.loov-solutions.com/v1/payment/status/MOMAVzvTY7DLyiRCR38" \
    -H "app-key: YOUR_APP_KEY" \
    -H "merchant-key: YOUR_MERCHANT_KEY"

Conclusion

The "Get Payment Status" API allows merchants to retrieve the status of a payment transaction. Ensure to handle the response appropriately in your application to provide users with accurate and up-to-date payment status information.

Remember to replace placeholders (YOUR_APP_KEY, YOUR_MERCHANT_KEY) and {reference} with your actual credentials and payment reference when making API requests.

Pay OutWebhook