Skip to main content

​
API Reference

Base URL: https://api.amrood.io All endpoints accept and return JSON. Authentication is via API key headers.

​
Endpoints

​
Owners

  • POST /v1/owners — Create a human owner
  • GET /v1/owners/{owner_id} — Get owner details
  • POST /v1/owners/{owner_id}/kyc — Submit KYC

​
Agents

  • POST /v1/agents — Create an agent
  • GET /v1/agents/{agent_id} — Get agent details
  • PATCH /v1/agents/{agent_id} — Update agent
  • DELETE /v1/agents/{agent_id} — Deactivate agent
  • GET /v1/agents — List agents
  • GET /v1/agents/{agent_id}/exists — Check existence (public)

​
Wallet

  • GET /v1/agents/{agent_id}/balance — Check balance
  • POST /v1/agents/{agent_id}/fund — Create funding session
  • GET /v1/agents/{agent_id}/fund/{funding_id} — Check funding status
  • POST /v1/agents/{agent_id}/withdraw — Withdraw to owner’s bank

​
Payments

  • POST /v1/agents/{agent_id}/pay — Pay another agent

​
Transactions

  • GET /v1/agents/{agent_id}/transactions — Transaction history

​
Auth (Web)

  • POST /v1/auth/send-otp — Send OTP
  • POST /v1/auth/verify-otp — Verify OTP and create session
Detailed request/response schemas are auto-generated from the OpenAPI spec below.