Skip to main content

Payment API Error Reference

This document outlines the possible error responses returned by our payment APIs. Each error is designed to indicate a specific failure condition, helping clients to debug issues effectively and take appropriate actions.

All errors will return a JSON object with the following structure:

{
  "gateway_status": "rejected",
  "message": "<description of the error>"
}

Error List and Explanations​

1. Unauthorized​

  • Cause: API request is not authenticated.
  • Action: Ensure your currect IP is whitelisted.

2. Payin is disabled for the user. Please Contact Administrator.​

  • Cause: The user account is not permitted to initiate pay-in transactions.
  • Action: Contact your administrator to enable pay-in access.

3. Invalid Signature​

  • Cause: The request signature verification failed.
  • Action: Recalculate the signature as per documentation. Ensure correct encoding and key.

4. Payment Method Not Available For Merchant​

  • Cause: The payment method is not assigned or enabled for the merchant.
  • Action: Contact support.

5. No Account Available. Please Try again later!​

  • Cause: The upstream PSP has no available account to process the transaction.
  • Action: You may want to check account status or quota.

6. Invalid Payer Phone Number for H2H Mode​

  • Cause: Phone number format is incorrect for H2H-based providers.
  • Action: Ensure the phone number is in the correct and expected format for the gateway.

7. Server Error!​

  • Cause: Unexpected failure in the upstream service or internal server.
  • Severity: Critical.
  • Action: Contact support if persistent.

8. Bank Account Not Found​

  • Cause: Selected payment method may be down for maintanance.
  • Action: Contact support if persistent.

9. Bank Account Not Available For Merchant​

  • Cause: The requested bank account is not assigned to the current merchant.
  • Action: Contact support if persistent.

10. Invalid type, <fieldName> (<expectedType>) <message>.​

  • Cause: One or more fields do not match expected data types.

  • Example:

    {
      "gateway_status": "rejected",
      "message": "Invalid type, amount (number) must be positive."
    }

  • Action: Review field type expectations as defined in the API schema. Validate input prior to API call.

11. Unknown error occurred.​

  • Cause: An unhandled or uncategorized error state.
  • Severity: Medium to high.
  • Action: Log entire response. Report issue to the API team if reproducible.

🔁 Query Policy​

  • For server-related errors (e.g., Server Error!, Unknown error occurred.), clients may query the order status using Query by Merchant Payment ID.
  • For validation errors (e.g., invalid phone numbers, missing fields), do not retry. Fix the client request first.

📞 Need Help?​

If you're unable to resolve an error using this guide, please contact the Creedo Technical Team.