MyTPE developer documentation
Connect your server to one MyTPE account, then manage KYC, payment instances, forms, payment links and webhooks through a REST API.
The MyTPE API is for server-to-server integrations. Your server gets a short-lived access token for one MyTPE account and calls the API with it. Never put the credentials in a browser or a mobile app.
| You want to | Go to |
|---|---|
| Make your first successful call | Build your first integration |
| Complete a specific task | How-to guides |
| Look up an endpoint, scope, error or limit | Reference |
| Understand how access works | Explanation |
How an integration is shaped
Core concepts
| Concept | What it is |
|---|---|
| Account | Also called a workspace. Every resource belongs to one. |
| Integration | A program installed on one account, with its own credentials, scopes and optional IP ranges. |
| Identification | The legal entity MyTPE verifies. |
| Brand | The name and logo customers see on payment pages. |
| Bank account | The 20-digit RIB that settlements are paid into. |
| Payment instance | A virtual TPE. Payment links are created under an instance. |
| Payment link | A shareable URL that charges customers. |
| Form | Fields collected from the payer at checkout. |
| Webhook | An HTTPS endpoint of yours that MyTPE calls when events happen. |
Base URL
https://api.mytpe.app/api/extAmounts are in Algerian dinars (DZD) unless stated otherwise.
Postman collection