User Wallet & Transactions

Manage and retrieve user wallet information, including balance, account type, and transaction status for deposits, withdrawals, and transfers.

Retrieve user's Kontigo Wallet balance

Fetch detailed information for a specific customer using their unique identifier. The response includes all customer data, such as contact details, KYC status, and any linked bank accounts. This endpoint is essential for viewing a customer’s profile and ensuring that their information is up-to-date.

Endpoint: GET /v1/customers/search?email=:email

Response Example:

{
  "email": "[email protected]",
  "balance": "2028", // $20.28 USDC in minor units
  "type": "individual", // 'individual' | 'business'
  "state": "ACTIVE", // 'REGISTERED' | 'ONBOARDING' | 'ACTIVE' | 'DELETED' | 'BLOCKED' | 'SUSPENDED'
  "wallet_address": "0x..."
}

Retrieve Transaction Status

Use this endpoint to fetch the status of a specific transaction using its unique identifier. The response includes the transaction amount, user email, payment provider, and current status. This is useful for confirming the progress or outcome of a deposit, withdrawal, or transfer.

Endpoint: GET /v1/transfers/search?partner_reference_id=:id

Response Example:

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "amount": "1000", // $10.00 USDC in minor units
  "customer_email": "[email protected]",
  "type": "withdraw", // 'deposit' | 'transfer' | 'withdraw'
  "status": "completed" // 'pending' | 'completed' | 'failed' | 'processing'
}