Overview & Getting Started

Use the DigetPay Developer Portal to register your company, complete verification, publish a marketplace service, and manage its integration.

:::info
This documentation uses the staging environment: https://fin-api.digetpay.com/v1. See Environments and base URLs for the production URL.
:::

1. What is the DigetPay Developer Portal?

A self-serve onboarding flow — register, complete KYC, and publish a listing.
A credential manager for sandbox API keys and webhook secrets.
An integration toolkit for listings, offers, panels, orders, and outbound webhooks.
A team workspace with one OWNER account and invited DEVELOPER members. See Team management & roles.

1.1 Who is this for?

Marketplace service developers building services for the Super App, such as top-ups, tickets, gift cards, billers, and merchants.
Partner engineering leads responsible for technical review.

:::tip
These guides cover marketplace service development. Merchant acquiring and the customer payment API are documented separately.
:::

For payment gateway integration, see the payments documentation.

2. Environments & base URLs

All endpoints are prefixed globally with /v1.

Environment	Base URL	Purpose
Staging	`https://fin-api.digetpay.com/v1`	Build and test. OTP is dev-visible
Production	`https://api.digetpay.com/v1`	Live traffic

3. Integration models

Every application is created with the EMBEDDED integration model, which
decides how a customer launches your service from the Super App.

:::highlight yellow 📌
All new applications use the EMBEDDED flow. It is the only integration model currently available.
:::

4. Quick start

Prepare your company details and documents before you register. The company representative is also the initial OWNER account holder.

Prerequisites

Gather your company’s legal name.
Provide the representative’s Saudi phone number in the +9665… format.
Provide the representative’s email address.
Prepare scans of the commercial registration, tax certificate, and representative ID.

Onboarding checklist

#	Step	API	Result
1	Register company + owner	`POST /developer-portal/register`	org `ONBOARDING`
2	Verify phone with OTP	`POST .../register/verify-otp`	phone verified
3	Upload documents (`COMMERCIAL_REGISTRATION`, `TAX_CERTIFICATE`, `REP_ID`)	`POST .../company/documents`	docs attached
4	Check readiness	`GET .../company/readiness`	`canSubmitVerification: true`
5	Submit for review	`POST .../company/submit`	verification `SUBMITTED`
6	Admin review	—	org `APPROVED` (1–2 business days)

:::check
After your organization reaches APPROVED, build your service.
:::

For registration, login, OTP, tokens, and roles, see Authentication & Team.

5. Using this Documentation

Use the documentation directly in your development workflow or export it for your preferred tools.

Using an LLM

Select Copy Page at the top of a page to copy its Markdown or OpenAPI content for an LLM.
Select MCP at the top of an API endpoint to view instructions for connecting the documentation to your IDE.
Open LLMS.txt at the bottom of the page to access an LLM-readable documentation sitemap.

Using API clients like Postman

Send supported requests from the documentation in your browser.
Select Export at the bottom of the page to download the OpenAPI specification, then import it into Postman, Bruno, Insomnia, or another API client.