View Categories

Transaction status

1 min read

the partner has the ability to check the status of the transaction by making a POST request to the fomowing URL, with the external transaction ID in the body of the request.

{{base_url}}/api-services/v2/transaction/get-transaction-status

Note: If you call this resource more than 3 times per minute for the same transaction, your IP address may be blocked.

Headers

Parameter NameValueMandatoryDescription
apikeyStringYesyour API key (provided by RichattPay)

Body

{ 
    "externalTransactionId": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" 
}

Example of successful response

{ 
    "code": 200, 
    "msg": "Successfully operation", 
    "error": false, 
    "data": { 
        "transactionId": "P2407251803418300000030", 
        "createdAt": "2024-07-25T18:03:41.811848Z", 
        "updatedAt": "2024-07-25T18:03:43.724349Z", 
        "externalTransactionId": "C89sdjz8zvslljzsse0eek1sfm9lkmdsddkssklkkkjllded8lfdkd", 
        "status": "Succes", 
        "errorType": { 
            "code": null, 
            "message": null 
        } 
    } 
}

Examples of error response

Status(403)

{"error":" The API key is missing or expired"}

Status(404)

{"error":"The transaction reference is not found "}

Status(500)

{"error":"An error occurred. Please try again later "}

The different transaction statuses:

  • Refunded : When the transaction is refunded.
  • Canceled : When the transaction goes into error and cannot be completed. In this case, the refund is automatically made after 15 minutes. 
  • Error : When the transaction goes into error and it is possible to restart it (case of timeout for example). In this case the transaction is refunded after 3 failed attempts. 
  • Pending : When the transaction is being processed. 
  • Succes : When the transaction is processed.