Version: 1.0
Contract Management API Documentation
The Contract Management API provides operations to manage contracts efficiently. Key features include:
- Create or Update Contracts: Add or modify contract details.
- List Contracts: Retrieve a comprehensive list of all contracts.
- Get Contract Details: Access detailed information about specific contracts.
The OTP Management API provides operations to send and verify One-Time Passwords (OTPs). Key features include:
- Send OTP: Send a one-time password to a specified user for verification.
- Verify OTP: Verify the provided OTP to ensure it's valid and matches the sent one.
Error Codes:
Below is a table listing the possible error codes and their descriptions:
System Errors
| Error Code | Description |
|---|---|
ERR_GENERAL_0001 | An internal service error occurred. |
ERR_GENERAL_0002 | Invalid data format. |
ERR_GENERAL_0003 | Argument type mismatch. |
ERR_GENERAL_0004 | The requested resource was not found. |
ERR_GENERAL_0005 | An unexpected error occurred. Please try again later. |
ERR_GENERAL_0006 | One or more fields contain invalid data. |
ERR_GENERAL_0007 | Missing required attribute(s) : %s |
ERR_GENERAL_0008 | Validation failed for one or more fields. |
ERR_GENERAL_0009 | User with profile '%s' is not authorized to access this endpoint |
Contract Errors
| Error Code | Description |
|---|---|
ERR_CTR_0001 | An error occurred while creating the contract. Please try again later. |
ERR_CTR_0002 | The chosen segment is invalid. Please select a valid segment. |
ERR_CTR_0003 | The radical already exists. Please choose a different one. |
ERR_CTR_0004 | The accounts provided are invalid. Please check the account details. |
ERR_CTR_0005 | The currency specified for the account is invalid. Please select a valid currency. |
ERR_CTR_0006 | One or more cards are invalid. Please check the card details. |
ERR_CTR_0007 | The client does not exist. Please check the client ID or create a new client. |
ERR_CTR_0008 | The account list is empty. |
ERR_CTR_0009 | The billing account provided is incorrect. |
ERR_CTR_0010 | The subscriber has the same ID card. |
ERR_CTR_0011 | The subscriber has the same phone number. |
ERR_CTR_0012 | The contract was not created successfully. |
ERR_CTR_0013 | Unable to attach subscriber to the contract. |
ERR_CTR_0014 | An error occurred while updating the contract. Please try again later. |
ERR_CTR_0015 | The contract is currently under validation and cannot be modified. |
ERR_CTR_0016 | The specified contract could not be found. |
ERR_CTR_0017 | The form submitted is invalid. Please check the input values and try again. |
ERR_CTR_0018 | This user with this profile is not authorized to access this endpoint |
ERR_CTR_0019 | Unauthorized to view the contract. |
ERR_CTR_0020 | You must select a valid Commercial Offer. The following product codes are invalid: %s . |
ERR_CTR_0021 | Invalid RIB(s) found: %s. You should provide valid RIBs for these beneficiaries. |
ERR_CTR_0022 | No subscribers found for the given contract. |
ERR_CTR_0023 | Request context not found. |
ERR_CTR_0024 | Failed to activate the subscriber. Please try again. |
ERR_CTR_0025 | The default account manager is either not specified or incorrect. Please try again. |
OTP Errors
| Error Code | Description |
|---|---|
ERR_OTP_0001 | Failed to send OTP. Please try again. |
ERR_OTP_0002 | OTP verification failed. Please check the OTP and try again. |
ERR_OTP_0003 | The OTP has expired. Please request a new one. |
ERR_OTP_0004 | The OTP is invalid. Please enter the correct OTP. |
Authentication
- HTTP: Bearer Auth
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | bearer |
Bearer format: | JWT |