For banks, brokers and fintech apps
Amtaar Partner API
Offer your customers fractional ownership of rented commercial property in Egypt, inside your own product. Register them, sell them shares, show their rental income, and follow every order and commission with signed webhooks.
- REST + JSON · OpenAPI 3.1
- Signed webhooks
- Sandbox with simulators
- Idempotent writes
- FRA-licensed platform
Three ways to integrate
Start with one, add others later. Each is switched on for your partner account under your agreement.
Referral
Register your customer with one API call and send them to the Amtaar app. They invest there; you follow their orders and earn your commission.
Embedded, partner-settled
Your customers browse and buy Amtaar units inside your app. You debit their account and settle to Amtaar; we confirm the money and issue the shares.
Embedded, card checkout
Your customers buy inside your app and pay on an Amtaar card checkout page that you open in a web view.
What the API covers
Catalogue and pricing
Published properties with shares left, price per share, fees and projections; exact quotes for any number of shares.
Customers and consent
Open an Amtaar account for a new customer, or link an existing investor once they confirm the code we text them.
Orders and settlement
Reserve shares at today’s price, settle the payment or hand over a card checkout, and follow the order to completion.
Portfolio and rental income
Holdings per property, invested amount, quarterly rental payouts, contracts and wallet balance, with permission.
Commissions
Every signup fee, purchase commission, bonus and payout on your partner ledger, with totals and balance.
Events and webhooks
Signed, retried webhooks for every change, plus an event log to catch up after downtime.
Documentation
Everything your product and engineering teams need. The documents are in English.
Web page · 12 sections
Integration guide
Integration models, flows, settlement, webhooks with code samples, errors, sandbox testing and the go-live checklist.
Read online →PDF · 0.5 MB
Integration guide (PDF)
The same guide as a PDF to share with your team or attach to an RFP.
Download PDF →Interactive · 35 endpoints · 14 events
API reference
Every endpoint, field, error code and webhook event, with request and response examples.
Open the reference →JSON · OpenAPI 3.1
OpenAPI 3.1 contract
The machine-readable contract. Import it into Postman or generate a client library in your language.
Download openapi.json →What a call looks like
Register a customer. The Idempotency-Key makes a retry return the same customer instead of creating a second one.
curl -X POST https://api.amtaar.co/open/v1/customers \
-H "Authorization: Bearer amtk_live_…" \
-H "Idempotency-Key: 4f0c6a5e-2a3b-4f7e-9f1e-0c1d2e3f4a5b" \
-H "Content-Type: application/json" \
-d '{ "phone": "+201001234567", "externalId": "your-user-88213" }'
{
"object": "customer",
"id": "cus_6712c0ffee0123456789abcd",
"status": "onboarding",
"kyc": { "status": "pending", "missingSteps": ["identity_verification"] },
"canInvest": false,
"links": { "app": "https://api.amtaar.co/p/your_partner_code" }
}From agreement to live
- 1
Agreement
We agree the integration model, commission terms and, for partner-settled orders, the settlement account and KYC reliance.
- 2
Sandbox keys
Your team gets sandbox keys for a full test copy of the platform. Simulators move orders and KYC along. No real money moves.
- 3
Build and test
Integrate against the sandbox using the guide and the reference, and register your webhook endpoint.
- 4
Certification
We walk through the go-live checklist with your team.
- 5
Live
We issue live keys, optionally limited to your server IP addresses, and switch on the agreed capabilities.
Built for regulated partners
Amtaar Capital is licensed by Egypt’s Financial Regulatory Authority (FRA). The API is built to the same standard.
- Per-partner API keys with scopes, shown once and stored hashed, optional IP allow-list, revocable at any time
- Every capability is off until it is agreed: opening accounts, linking investors, partner KYC reliance, settled orders, card orders, portfolio, wallet
- Existing investors are shared only after they confirm a one-time SMS code; you only ever see customers linked to you
- Orders are priced and checked by Amtaar, and only Amtaar Finance or the card processor can mark them paid
- Webhooks signed with HMAC-SHA256 and retried for two days; idempotency keys make every retry safe
- Per-key rate limits, per-order and daily amount limits, and a full request log on our side
Questions partners ask
Who can use the Amtaar Partner API?+
Banks, brokers, fintech apps and other companies with a partnership agreement with Amtaar. Access is granted per partner; write to us to start.
Do our customers need the Amtaar app?+
In the referral model, yes. In the embedded models they can invest entirely inside your app once their KYC is done, either Amtaar KYC in the app or your own KYC under a reliance agreement. They can always open the Amtaar app with the same mobile number to see their investment and contracts.
How is the money handled?+
Either the customer pays Amtaar directly (in the Amtaar app or on a card checkout page), or you collect the money and settle it to Amtaar with a reference that Amtaar Finance confirms. Shares are issued when the unit is fully funded.
How do we test before going live?+
You get sandbox keys for a full test copy of the platform. Sandbox endpoints simulate KYC, payment confirmation, rejection and share issuance, so you can test every webhook end to end without moving money.
How do partners earn?+
Under your agreement: for example a fee per customer who signs up and a commission on every purchase they make, in your app or in the Amtaar app. Your commission ledger is available through the API.
Ready to offer real estate investing to your customers?
Tell us about your product and customers. We will reply with the next steps and sandbox access.
Email the partnerships teamhi@amtaar.dev
Amtaar Capital is licensed by Egypt’s Financial Regulatory Authority (FRA). Projections are not guarantees.