Clapay is the most secure electronic wallet that allows you to better see and manage your finances for free. Transfers between wallets, also make your Mobile Money transactions, but also pay on partner merchant sites.

Present in more than ten (10) countries in the sub-region, INTER CLAP GROUP is a fintech that is establishing itself

An undisputed payment gateway, through ClaPay we offer you the best offers on our payment methods. Integrate us on your different platforms (e-commerce, trading, sports betting, etc.). We have simple and adapted solutions to satisfy all your operations.

-

For all transactions we will send a callback with these items to your callback_url:

Method : POST

{
    "status": "SUCCESSFUL",
    "transaction_id": "abdoul100KWAVE",
    "additional_infos": {
        "customer_email": "test@gmail.com",
        "customer_lastname": "App",
        "customer_firstname": "Test"
    },
    "amount": 10000,
    "currency": "XOF",
    "fee_percent": 1,
    "fee_value": 100,
    "balance": 9900,
    "balance_before": 0,
    "balance_after": 0,
    "transaction_method": "MERCHANT",
    "transaction_phone_number": "XXXXXXXXX",
    "transaction_dialcode": "+225",
    "signature": "TEST-ba325fc6-ca09eb7b4dce",
    "transaction_date": 2023-11-27 03:24:31.839,
    "transaction_country_code": "CI",
    "transaction_service_name": "ORANGE MONEY",
    "transaction_observation": ""
}

API Error Documentation

Introduction

This documentation describes the error codes you may encounter when using our API. Each error is associated with an HTTP status code and a specific error code to facilitate debugging and error management.

HTTP Status Codes and Errors

400 - Bad Request

1. Country is not defined

• Status Code: 404

• Error Code: COUNTRY_NOT_FOUND

• Message: Country is not defined

• Description: The country is not defined in the request.

2. This country is unknown

• Status Code: 400

• Error Code: COUNTRY_UNKNOWN

• Message: This country is unknown

• Description: The specified country is unknown or not yet covered.

3. Fees is not defined

• Status Code: 404

• Error Code: FEES_NOT_FOUND

• Message: Fees is not defined

• Description: Fees are not yet defined for your merchant ID.

4. API tunnel is allowed only if there are customer_phone

• Status Code: 400

• Error Code: NOT_ALLOWED_TUNNEL_WITHOUT_PHONENUMBER

• Message: API tunnel is allowed only if there are customer_phone

• Description: The API tunnel is allowed only if a customer phone number is provided.

5. API tunnel is allowed for single operators_code ex: ['OM']

• Status Code: 400

• Error Code: NOT_ALLOWED_TUNNEL_MULTIPLE_OPERATORS_CODE

• Message: API tunnel is allowed for single operators_code ex: ['OM']

• Description: The API tunnel is allowed only for a single operator code. Examples of allowed codes: ['OM'].

6. An error has occurred, the transaction signature could not be generated. Please try again or contact support.

• Status Code: 400

• Error Code: ERROR_GENERATE_SIGNATURE

• Message: An error has occurred, the transaction signature could not be generated. Please try again or contact support.

• Description: An error occurred while generating the transaction signature. Please try again or contact support.

7. An error has occurred, the transaction signature could not be generated. Your balance is deficit.

• Status Code: 400

• Error Code: ERROR_BALANCE_DEFICIT

• Message: An error has occurred, the transaction signature could not be generated. Your balance is deficit.

• Description: An error occurred while generating the transaction signature due to an insufficient balance.

8. You cannot generate a signature, please contact administrator to get help.

• Status Code: 400

• Error Code: LIMITATION_AMOUNT_NOT_FOUND_ERROR

• Message: You cannot generate a signature, please contact administrator to get help.

• Description: You cannot generate a signature because payment limits are not yet defined. Contact an administrator for assistance.

9. You cannot generate a signature, the amount must be between {min_amount} and {max_amount} for this kind of transaction

• Status Code: 400

• Error Code: LIMITATION_AMOUNT_ERROR

• Message: You cannot generate a signature, the amount must be between {min_amount} and {max_amount} for this kind of transaction

• Description: You cannot generate a signature. The amount must be between {min_amount} and {max_amount} for this type of transaction.

10. Operator {element} does not exist

• Status Code: 400

• Error Code: OPERATOR_NOT_EXIST

• Message: Operator {element} does not exist

• Description: The specified operator does not exist.

11. This method is not available now for {element}, technical issues with operator, sorry for inconvenience. You will be advised once resolved.

• Status Code: 400

• Error Code: TECHNICAL_ISSUES_OPERATOR_ENCOUNTERED

• Message: This method is not available now for {operator_code}, technical issues with operator, sorry for inconvenience. You will be advised once resolved.

• Description: This method is not available for {operator_code} due to technical issues with the operator. You will be informed when the issue is resolved.

• operator_code: OM, MOOV, MTN, etc.

12. Any methods are not available for now sorry for inconveniences

• Status Code: 400

• Error Code: TECHNICAL_ISSUES_OPERATOR_ENCOUNTERED

• Message: Any methods are not available for now sorry for inconveniences

• Description: No methods are available at the moment. We apologize for the inconvenience.

401 - Unauthorized

13. Token provided not allowed, operation closed

• Status Code: 401

• Error Code: TOKEN_ERROR_EXCEPTION

• Message: Token provided not allowed, operation closed

• Description: The provided token is not allowed; the operation is closed.

14. Token lifetime reached, operation closed

• Status Code: 401

• Error Code: TOKEN_ERROR_EXCEPTION

• Message: Token lifetime reached, operation closed

• Description: The token lifetime has expired; the operation is closed.

15. This country is not authorized in the specification of this token

• Status Code: 401

• Error Code: TOKEN_SPECIFICATION_ERROR

• Message: This country is not authorized in the specification of this token

• Description: This country is not authorized according to the token specification.

16. {element} is not authorized in the specification of this token

• Status Code: 401

• Error Code: TOKEN_SPECIFICATION_ERROR

• Message: {operator_code} is not authorized in the specification of this token

• Description: {operator_code} is not authorized according to the token specification.

• operator_code: OM, MOOV, MTN, etc.

17. This method is not authorized in the specification of this token

• Status Code: 401

• Error Code: TOKEN_SPECIFICATION_ERROR

• Message: This method is not authorized in the specification of this token

• Description: This method is not authorized according to the token specification.

18. Token lifetime reached or invalid token provided, operation closed

• Status Code: 401

• Error Code: TOKEN_ERROR_EXCEPTION

• Message: Token lifetime reached or invalid token provided, operation closed

• Description: The token lifetime has expired or an invalid token was provided; the operation is closed.

19. Missing authorization in header

• Status Code: 401

• Error Code: TOKEN_ERROR_EXCEPTION

• Message: Missing authorization in header

• Description: Missing authorization in the header.

20. Missing authorization bearer type in header

• Status Code: 401

• Error Code: TOKEN_ERROR_EXCEPTION

• Message: Missing authorization bearer type in header

• Description: Missing authorization bearer type in the header.

403 - Forbidden

21. You are forbidden

• Status Code: 403

• Error Code: FORBIDDEN_ACCESS

• Message: You are forbidden

• Description: You are forbidden from accessing this resource.

Example Error Response

Here is an example of the structure of an error response:

{
  "status_code": 400,
  "message": "An error has occurred, the transaction signature could not be generated. Please try again or contact support.",
  "status_payment": "ERROR_GENERATE_SIGNATURE"
}

Contact Support

For any questions or unresolved issues, please contact our technical support at support@mpayment.africa