Skip to main content

Objective

This guide helps you quickly integrate the essential Cartevo services.

Step 1 — Wallets

Create a wallet
POST /wallets
Content-Type: application/json
Authorization: Bearer <token>

{
  "currency": "USD",
  "country_iso_code": "US"
}

List Wallets
GET /wallets
Authorization: Bearer <token>
cURL Example
curl -X GET "$BASE_URL/wallets" -H "Authorization: Bearer $API_KEY"
Réponse (200)
[
  {
    "id": "wlt_123",
    "currency": "USD",
    "balance": 150.25,
    "created_at": "2025-10-01T12:00:00Z"
  }
]

Step 2 — Funding & Deposit

Local funding
POST /wallets/fund
Content-Type: application/json
Authorization: Bearer <token>

{
  "userId": "<userId>",
  "walletId": "<walletId>",
  "amount": 10000,
  "phone": "+2376xxxxxxx",
  "operator": "ORANGE",
  "currency": "XAF"
}
Deposit with exchange
POST /wallets/deposit
Content-Type: application/json
Authorization: Bearer <token>

{
  "sourceWallet": {
    "id": "<walletIdXAF>",
    "currency": "XAF",
    "amount": 10000,
    "feeAmount": 0,
    "totalAmount": 10000
  },
  "destinationWallet": {
    "id": "<walletIdUSD>",
    "currency": "USD",
    "amount": 15
  },
  "exchangeRate": {
    "rate": 650,
    "fromCurrency": "XAF",
    "toCurrency": "USD"
  }
}
cURL example
curl -X POST "$BASE_URL/wallets/deposit" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d @payload.json

Step 3 — Transactions

List wallet transactions
GET /wallet/transactions/wallet/<walletId>
Authorization: Bearer <token>
Useful filters
  • status: SUCCESS, PENDING, FAILED
  • type: FUND, DEPOSIT, TRANSFER
  • page, limit: pagination

Step 4 — Clients

Step 4 — Customers
POST /customers
Content-Type: application/json
Authorization: Bearer <token>

{
  "first_name": "Jane",
  "last_name": "Doe",
  "email": "[email protected]",
  "phone_number": "+2376xxxxxxx",
  "country_iso_code": "CM"
}
Tips
  • Validate emails and country codes on the client side
  • Reconcile customer transactions GET /customers/:id/transactions