DigetPay Developer Portal

Build, test, and launch a DigetPay payment integration by choosing the path that matches your checkout and PCI requirements.

Start with Hosted Checkout
For most online payment integrations, create a payment link on your server and redirect the customer to DigetPay’s hosted checkout page. Your systems do not collect card numbers, CVV, or Apple Pay tokens.
Run the Quick Start →

Choose your integration

Select the product you are building. You can change paths later, but begin with the integration that matches where payment details are collected.

Hosted Checkout

Create a checkout session and redirect the customer to a DigetPay-hosted payment page. Choose this path for the lowest PCI scope.

Embedded Integration

Build payment collection into your own checkout. Use this path only when your compliance team approves server-to-server card handling.

Apple Pay

Enable Apple Pay with hosted checkout or select an embedded implementation for your supported platform.

SDKs and Plugins

Review mobile SDKs, SoftPOS and SmartPOS options, or connect an e-commerce platform with a supported plugin.

Recommended path: Hosted Checkout

Hosted Checkout keeps payment entry on DigetPay pages. Your server creates a checkout session, your customer completes payment, and your server confirms the final status using webhooks or the status API.

sequenceDiagram
    autonumber
    participant Merchant as Your server
    participant API as DigetPay API
    participant Customer as Customer
    participant Checkout as DigetPay Checkout

    Merchant->>API: POST /payment/checkout/intiate
    API-->>Merchant: id, redirectUrl
    Merchant->>Customer: Redirect to redirectUrl
    Customer->>Checkout: Complete payment
    Checkout-->>Customer: Redirect to successUrl or failureUrl
    API-->>Merchant: Webhook notification or status response
    Merchant->>Merchant: Confirm payment before fulfillment

Confirm payments on your server
A redirect to successUrl is not proof of payment. Use Handle Webhooks or Query Transaction Status before you fulfill an order.

Build your first payment

Complete these steps in order on the Fin staging environment.

1. Get API Key

Generate and securely store your API credentials.

2. Configure Fin

Configure your application to use the Fin staging environment.

3. Create Payment Link

Create a hosted checkout session and receive the checkout URL.

4. Redirect Customer

Redirect the customer to the returned redirectUrl.

5. Verify Payment

Handle webhooks or query the transaction status before fulfilling the order.

6. Go Live

Test your integration and complete the Go-Live Checklist before production.

Core payment APIs

Operation	Method and path	Use it to
Create Payment Link	`POST /payment/checkout/intiate`	Create a hosted checkout session and obtain `redirectUrl`.
Query Transaction Status	`GET /payment/checkout/status`	Confirm a payment and review its refund state.
Process Refund	`POST /payment/refund`	Submit a full or partial refund for a successful payment.

Use the right identifier
The payment-link response returns a checkout session ID. Store it for reconciliation, but use the gateway transaction ID—not the session ID—to query status or create a refund. See Transaction Identifiers.

Plan your implementation

For Developers

Integrate payment APIs, handle webhooks, verify payment states, and manage refunds.

For Business & Operations

Complete onboarding, manage credentials, review transactions, and reconcile payouts.

Security and compliance

Keep API keys on your server and load them from a secrets manager or protected environment variable.
Never commit API keys to source control.
Never expose API keys in browser or mobile applications.
Hosted Checkout keeps payment details outside your PCI scope.
Test on Fin staging before requesting production credentials.

Regulatory communications
DigetPay has not yet obtained central bank authorization. Do not reference SAMA or regulatory approval in customer-facing communications unless DigetPay explicitly authorizes it.

Continue building

Hosted Checkout Overview

Review the complete Hosted Checkout payment flow.

Choose Integration Path

Compare hosted, embedded, Apple Pay and in-store payment options.

API Reference

Browse every endpoint, request schema and response.

FAQs

Find answers to common integration questions.