How to Use Beeceptor to Test Pay Hero Kenya API Callback Responses

Testing API callback responses is a crucial step in ensuring your application works seamlessly with third-party services. Beeceptor is a powerful tool that can help you mock and inspect these callbacks without the need for the actual endpoint to be available. In this blog post, we will walk you through the steps to use Beeceptor for testing the Payherokenya.com API callback responses.

Step 1: Sign Up and Create a New Endpoint on Beeceptor

1. Sign Up for Beeceptor:
   • Visit Beeceptor and sign up for a free account if you don’t already have one.
   • After signing up, log in to your Beeceptor dashboard.
2. Create a New Endpoint:
   • On your dashboard, go to the section for “Launch a mock server now!”
   • Enter a name for your endpoint or project. This name will be part of the URL that Beeceptor provides. For instance, if you name it payhero-test, your endpoint will be https://payhero-test.free.beeceptor.com.
   • Click on “Create Mock Server” to generate the new endpoint.

Step 2: Configure Your Beeceptor Endpoint

1. Set Up Rules (Optional):
   • You can configure rules to customize the responses Beeceptor will send back. This can help simulate various scenarios and test how your application handles different types of responses.
   • To add a rule, go to the “Rules” tab on your endpoint page, click on “Add Rule”, and define the conditions and response for the rule.
2. Inspect Requests:
   • Under the “Requests” tab, Beeceptor will list all incoming requests to your endpoint. This feature allows you to inspect the headers, payload, and other details of the requests sent by Payherokenya.com.

Step 3: Update Pay Hero to Use Beeceptor Endpoint

1. Configure API Request Callback URL:
   • On your API request body, there is a parameter for callback_url
   • Set callback URL to the Beeceptor endpoint URL you created earlier (e.g., https://payhero-test.free.beeceptor.com).
2. Configure Account Callback URL:
   • On pay hero there is an option to also set a universal account callback URL, this will be used to send callbacks to the set URL incase you do not wish to use API request callback_urls
   • This is optional and only do it if necessary.
   • Go to your dashboard at app.payhero.co.ke
   • Go to Account menu > Update Account
   • Enter the Callback URL you created earlier (e.g., https://payhero-test.free.beeceptor.com).
   • Save changes

Step 4: Test API Callback Responses

1. Trigger API Callbacks:
   • Perform the API calls on Pay Hero that would trigger the API callbacks. This could be making a payment, initiating a transaction, or any other action depending on what you are testing. Check our developer docs for more details about our APIs
2. Inspect the Requests:
   • Go back to the “Requests” tab on your Beeceptor endpoint dashboard.
   • Here, you will see the list of incoming requests from Pay Hero. Click on any request to view its details, including the payload, headers, and other relevant information.
3. Verify the Data:
   • Compare the incoming request data with the expected format and content. This will help you ensure that your application correctly handles the API callbacks.

Step 5: Modify Responses (Optional)

1. Simulate Different Responses:
   • To simulate different responses and test how your application handles them, go to the “Rules” tab on your Beeceptor endpoint page.
   • Add or modify rules to change the response that Beeceptor sends back to Pay Hero. You can simulate various HTTP status codes, response bodies, and headers.
2. Re-Test the Scenarios:
   • Perform the actions on Payherokenya.com again to trigger the callbacks and see how your application handles the simulated responses.

Conclusion

Beeceptor is an excellent tool for developers looking to test API callback responses without relying on the actual endpoints. By following these steps, you can efficiently test how your application interacts with the Pay Hero API callbacks, ensuring robust and reliable integrations.

Happy testing!

Feel free to share this blog post with your fellow developers and teams to help them streamline their API testing processes using Beeceptor. If you have any questions or need further assistance, leave a comment below or reach out to the Pay Hero support team.