API Troubleshooting Guide

If you are experiencing issues or encountering errors while using the API endpoints for on-demand pay functionality, refer to the following troubleshooting steps:

  1. Verify API Endpoint Access:

    • Ensure that you are using the correct Base URL for accessing the API endpoints. Double-check the appropriate base URL and endpoint paths:
      • Production:
      • UAT:

    For API calls made from the developer portal to the DailyPay UAT environment:

    • Ensure you have a UAT API key.
    • Scrub any data containing employee phone, email, and direct deposit information.
    • Use non-production data.
  2. Check Authentication and Authorization:

    • Confirm that you are providing the correct authentication credentials to access protected API resources.
    • Verify that the access token is valid and has the necessary permissions for the desired actions.

    Refer to the Authentication Overview guide for assistance in confirming these details.

  3. Review Endpoint Parameters:

    • Ensure that you provide the required parameters for each API endpoint. Missing or incorrect parameters can lead to unexpected behavior or errors.
    • Verify that the data formats (e.g., date, time, currency) of the parameters align with the API's expectations.
  4. Handle Response Codes and Error Messages:

    • Pay attention to the response codes returned by the API. HTTP status codes in the 2xx range generally indicate success, while codes in the 4xx or 5xx range indicate errors.
    • Refer to the API documentation for a comprehensive list of error codes and their meanings. Error messages returned by the API can provide valuable insights into the cause of the issue.

    Error codes and their meanings are included under each endpoint description.

  5. Test in the Sandbox Environment:

    • Test your integration in the sandbox environment to troubleshoot and debug without affecting live production data. Refer to the environments section for assistance.
  6. Logging and Error Tracking:

    • Implement logging mechanisms in your application to capture relevant information, such as request and response details, error messages, and stack traces.
    • Use proper error tracking tools or services to centralize and monitor error occurrences. This can help identify patterns and provide insights for resolution.
  7. Reach Out to Developer Support:

    • If you have exhausted the troubleshooting steps and are still unable to resolve the issue, reach out to the developer support team for assistance.
    • Provide detailed information about the problem, including the API endpoints, request parameters, and any error messages received.

Remember, troubleshooting steps may vary depending on the specific API endpoints and implementation details. Consult the error documentation for references.