Skip to main content

Error codes

The following are the common error codes returned by the Subscription APIs:

Transaction failure reasons

The following are the detailed failure reasons categorised by their nature:

Account issues

The following are the account-related error codes:

Balance and limit issues

The following are the balance and limit-related error codes:

Mandate issues

The following are the mandate-related error codes:

Fraud and security

The following are the fraud and security-related error codes:

Technical issues

The following are the technical error codes:

Customer action required

The following are the error codes that require customer action:

Invalid data and validation

The following are the data validation error codes:

Know your customer and documentation

The following are the KYC and documentation-related error codes:

System and processing status

The following are the system and processing status error codes:

Notification issues

The following are the notification-related error codes:

Error response structure

Subscription API errors follow this structure:

Best practices for error handling

The following are the recommended practices for handling subscription errors: Implement retry logic:
  • For timeout and temporary errors, implement exponential backoff retry logic.
  • Start with a 1-second delay, double the delay for each subsequent retry.
  • Use a maximum of 3-5 retry attempts.
  • Apply different retry strategies for different error types.
Customer communication:
  • Provide clear, actionable error messages to customers.
  • Include specific steps they need to take for resolution.
  • Avoid technical jargon in customer-facing messages.
Mandate management:
  • Monitor mandate status.
  • Proactively create new mandates when existing ones are cancelled or expired.
  • Implement mandate renewal work flows before expiration.
Balance monitoring:
  • Advise customers to maintain sufficient balance before scheduled debits.
  • Send pre-debit notifications to remind customers.
  • Implement balance check APIs where available.
Error logging and monitoring:
  • Log all errors with timestamps and request details.
  • Set up alerts for critical error patterns.
  • Analyse error trends to identify systemic issues.
Graceful degradation:
  • Provide alternative payment methods when subscription payment fails.
  • Implement fallback mechanisms for critical payment flows.
  • Maintain service availability despite individual payment failures.
Security considerations:
  • Handle fraud-related errors with additional verification steps.
  • Implement risk scoring for suspicious transaction patterns.
  • Maintain compliance with regulatory requirements.
For additional API error codes and web hook error structures, refer to the Payment Errors documentation.