DigetPay Developer Integration API
  1. Applications
  • Overview & Getting Started
  • Integration Flow
    • 01 - Authentication & Team
    • 02 - End-to-End Integration Flow
    • 03 - Customizing your Marketplace Listing
  • API Reference
    • Auth
      • Refresh access token using a refresh token
      • Logout — revoke the refresh token
      • Get current profile
      • Activate an invited `DEVELOPER` account (set password from invite link)
    • Login
      • Login with email + password (sends OTP via email and SMS)
      • Verify the login OTP and issue access + refresh tokens
      • Resend login OTP via email and SMS
    • Register
      • Self-register a developer company + owner account
      • Verify registration OTP (email + phone)
      • Resend registration OTP
    • Forgot Password
      • Forgot password — send a reset OTP to the email
      • Verify the forgot-password OTP
      • Reset the password using the reset token
    • Team
      • List organization members
      • Invite a `DEVELOPER` into the organization
      • Resend the activation link for a `PENDING` member
      • Remove a member
    • Company
      • Change Requests
        • Submit a company information change request
        • Withdraw a pending change request
        • Upload a document for a company change request
        • Remove a staged document from a change request
        • Get current pending company change request
      • Company profile + verification status + documents
      • Respond to a single information request
      • Update company / verification data (DRAFT or INFO_REQUIRED only)
      • Onboarding readiness for verification submit and marketplace
      • Upload a verification document (pdf/jpeg/png, max 10MB)
      • Signed download URL for an own document
      • Submit company for verification review
      • Verification status only
      • List information requests for the current verification
    • Applications
      • List applications
        GET
      • Create application (requires APPROVED verification)
        POST
      • Active marketplace categories (for the listing form)
        GET
      • Application detail
        GET
      • Update application
        PATCH
      • Request production activation (certification must be PASSED)
        POST
      • Upload an application logo (icon)
        POST
      • Upload an application banner
        POST
      • Marketplace orders for the application
        GET
      • API request logs (masked metadata only)
        GET
      • Orders / transactions for the application
        GET
      • Advance a confirmation-required order
        POST
      • Submit application for review
        POST
    • Listings
      • Marketplace listing for the application
      • Create or partially update the marketplace listing
      • Submit listing for marketplace review
      • Unpublish a live or scheduled marketplace listing
    • Offers
      • List authored marketplace offers (cards)
      • Create a marketplace offer (card)
      • Reorder marketplace offers
      • Update a marketplace offer (card)
      • Delete a marketplace offer (card)
      • Upload a marketplace offer (card) image
      • Upload an offer (card) banner image
    • Panels
      • Upload a panel (section) banner image
      • List marketplace panels (sections)
      • Create a marketplace panel (section)
      • Reorder marketplace panels (sections)
      • Update a marketplace panel (section)
      • Delete a marketplace panel (section)
    • Credentials
      • List credentials (masked)
      • Generate credential for an environment — raw key returned once
      • Rotate API key — new raw key returned once
      • Rotate webhook signing secret — returned once
      • Revoke credential (`isActive=false`)
      • Set optional IP allowlist (IPv4 / CIDR)
    • Webhooks
      • Webhook event catalog
      • List webhook endpoints
      • Add webhook endpoint (**max 5 per environment**)
      • Update webhook endpoint
      • Delete webhook endpoint
      • Send a signed connection test to the endpoint
      • Delivery logs
    • Dashboard
      • Developer portal overview
    • Company
  • Developer Portal
    • Applications
    • Certification
      • Certification progress ("8 of 12 tests completed")
      • Re-evaluate automated certification checks
    • Auth
      • Login
        • Login with email + password (no OTP — non-production only)
  • admin
    • auth
      • Step 1: email + password → email OTP
      • Step 2: verify OTP → admin JWT
      • Resend OTP (re-runs login challenge)
      • Get current admin user profile
      • Update current admin profile (name, phone, avatar)
      • Change password for the current admin user
      • Logout admin user
      • Set password from an invite link token (no auth required)
      • Request password reset via email/SMS OTP (no auth required)
      • Verify password reset OTP and get reset token (no auth required)
      • Reset password using reset token and new password (no auth required)
  • integrity
    • Issue a one-time nonce for Play Integrity attestation
    • (DEV ONLY) Decode an integrity token and return the verdict
  • health
    • Liveness probe - basic health check
    • Readiness probe - dependency health check
    • HealthController_getMetrics
  • super-admin-portal
    • impersonate
      • Impersonate a partner or merchant OWNER by targetId + targetType
      • End an active impersonation session
  1. Applications

Create application (requires APPROVED verification)

Staging
https://fin-api.digetpay.com
Staging
https://fin-api.digetpay.com
POST
https://fin-api.digetpay.com
/v1/developer-portal/applications
Creates an application in status DRAFT.
Requires the developer organization verification to be APPROVED — otherwise
400. The application is created empty; configure it via PATCH.
New applications are always created with integrationModel EMBEDDED (the field
may be omitted from the body).

Request

Authorization
JWT Bearer
Add the parameter
Authorization
to Headers
Example:
Authorization: ********************
or
Body Params application/jsonRequired

Example
{
    "name": "Acme Checkout",
    "description": "Payment checkout for Acme services.",
    "integrationModel": "DIRECTORY"
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://fin-api.digetpay.com/v1/developer-portal/applications' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "name": "Acme Checkout",
    "description": "Payment checkout for Acme services.",
    "integrationModel": "DIRECTORY"
}'

Responses

🟢200OK
application/json
The created application.
Bodyapplication/json

Example
{
    "id": "7",
    "name": "Acme Checkout",
    "description": "Payment checkout for Acme services.",
    "integrationModel": "DIRECTORY",
    "status": "DRAFT",
    "logoPath": "https://storage/dgp/logo.png",
    "bannerPath": "https://storage/dgp/banner.png",
    "websiteUrl": "https://acme.sa",
    "privacyPolicyUrl": "https://acme.sa/privacy",
    "termsUrl": "https://acme.sa/terms",
    "supportContact": {
        "email": "support@acme.sa",
        "phone": "+966501234567"
    },
    "redirectUrls": [
        "https://acme.sa/oauth/callback"
    ],
    "deepLinkUrl": "acme://pay",
    "allowedWebOrigins": [
        "https://webview.acme.sa"
    ],
    "partnerApiBaseUrl": "https://api.acme.sa/v1",
    "productionRequestedAt": "2026-08-10T14:20:00.000Z",
    "productionApprovedAt": "2026-08-12T09:00:00.000Z",
    "productionReviewNotes": "Approved after certification PASSED.",
    "reviewNotesJson": {
        "branding": "2026-09-02: Logo updated per reviewer request"
    },
    "submittedAt": "2026-09-02T10:00:00.000Z",
    "createdAt": "2026-07-25T10:00:00.000Z",
    "updatedAt": "2026-08-12T09:00:00.000Z",
    "listing": {
        "id": "9",
        "applicationId": "7",
        "status": "DRAFT",
        "nameEn": "Acme Checkout",
        "nameAr": "تشيك أوت أكمة",
        "descriptionEn": "DigetPay checkout for Acme services.",
        "descriptionAr": "الدفع عبر ديجت باي لخدمات أكمة.",
        "iconPath": "https://storage/dgp/logo.png",
        "bannerPath": "https://storage/dgp/banner.png",
        "screenshots": [
            "https://storage/dgp/screen-1.png"
        ],
        "targetCountries": [
            "SA"
        ],
        "isFeatured": false,
        "publishAt": "2026-08-20T08:00:00.000Z",
        "publishedAt": "2026-08-15T12:00:00.000Z",
        "reviewNotes": {
            "branding": "2026-08-10: Logo updated per reviewer request"
        },
        "categoryId": "3"
    },
    "environments": [
        "SANDBOX"
    ]
}
🟠400Bad Request
🟠401Unauthorized
Modified at 2026-09-16 09:43:02
Previous
List applications
Next
Active marketplace categories (for the listing form)
Built with