Verify Wallet


This endpoint allows you to verify the validity of a destination account (Mobile Money or Bank) before initiating a payment. This step is highly recommended to reduce transaction failures.

Overview

The wallet verification endpoint ensures that the recipient's account is active and belongs to the expected operator.

Key Benefits:

  • Prevent transfers to non-existent numbers.
  • Confirm the identity of the account holder (where supported).
  • Ensure the account is capable of receiving funds.

Request

Method: POST

URL: {{base_url}}clients/verify-wallet

Headers:

  • SECRETKEY: Your API secret key
  • Content-Type: application/json

Body Parameters:

  • countryCode: (Required) ISO Country code (e.g., "CM", "GA").
  • accountNumber: (Required) The phone number or account identifier to verify.

cURL Request

curl -X POST \
  https://sandbox.peexit.com/api/v1/clients/verify-wallet \
  -H 'SECRETKEY: ########-####-####-####-############' \
  -H 'Content-Type: application/json' \
  -d '{
    "countryCode": "CM",
    "accountNumber": "690123456"
  }'

After verifying the wallet status:

Response

Status 200 - Success

The response confirms the account status and provides available details:

  • isValid: Boolean indicating if the account can receive transactions.
  • accountName: Registered name of the account holder (if available).
  • operator: The detected network operator (e.g., "ORANGE", "MTN").
  • status: Current account status (e.g., "ACTIVE").

Success Response

{
  "isValid": true,
  "accountName": "JOHN DOE",
  "operator": "ORANGE",
  "status": "ACTIVE"
}

Error Handling

Status 404 - Not Found

The account could not be found or the provider service is currently unavailable for this specific number.

Status 422 - Unprocessable Entity

The request was well-formed but contains invalid parameters (e.g., unsupported country code).

Error Response

{
  "error": {
    "statusCode": 404,
    "message": "Account not found on the provider network"
  }
}

Was this page helpful?