Class PaymobProvider

constructor

• new PaymobProvider(
      options: {
          apiKey?: string;
          baseUrl?: string;
          hmacSecret: string;
          integrationIds: Partial<
              Record<
                  | "card"
                  | "wallet"
                  | "cash_outlet"
                  | "installments"
                  | "bnpl"
                  | "bank_transfer"
                  | "other"
                  | "card_auth"
                  | "card_moto"
                  | "apple_pay",
                  number,
              >,
          >;
          publicKey: string;
          region?: "egypt"
          | "ksa"
          | "uae"
          | "oman";
          secretKey: string;
      },
  ): PaymobProvider

  Parameters

  • options: {
        apiKey?: string;
        baseUrl?: string;
        hmacSecret: string;
        integrationIds: Partial<
            Record<
                | "card"
                | "wallet"
                | "cash_outlet"
                | "installments"
                | "bnpl"
                | "bank_transfer"
                | "other"
                | "card_auth"
                | "card_moto"
                | "apple_pay",
                number,
            >,
        >;
        publicKey: string;
        region?: "egypt"
        | "ksa"
        | "uae"
        | "oman";
        secretKey: string;
    }

    • OptionalapiKey?: string

      Legacy API key: needed for transaction inquiry (getPayment / reconcile).

    • OptionalbaseUrl?: string

      Override the region base URL (testing / proxies).

    • hmacSecret: string

      HMAC secret from the dashboard: verifies transaction callbacks.

    • integrationIds: Partial<
          Record<
              | "card"
              | "wallet"
              | "cash_outlet"
              | "installments"
              | "bnpl"
              | "bank_transfer"
              | "other"
              | "card_auth"
              | "card_moto"
              | "apple_pay",
              number,
          >,
      >

      Integration ids, one per payment method (card, wallet, cash_outlet for kiosk, bnpl, installments, …) plus card_auth, card_moto and apple_pay. Test/live mode must match the keys.

    • publicKey: string

      Public key (pk_…): builds the Unified Checkout URL. Safe for browsers.

    • Optionalregion?: "egypt" | "ksa" | "uae" | "oman"

    • secretKey: string

      Secret key (sk_test_… / sk_live_…): creates intentions, refunds, voids.

  Returns PaymobProvider

Readonlycapabilities

Readonlyconfig

Readonlyid

extras

• get extras(): PaymobExtras

  Paymob features beyond the shared API: saved cards, subscriptions, payment links and intention updates. Available once the adapter is passed to new Sarraf(...).

  Returns PaymobExtras

publicKey

• get publicKey(): string

  The public key, for client-side Paymob Pixel. Safe to send to browsers.

  Returns string

attach

• attach(ctx: Ctx): void

  Called once by Sarraf with its context, for adapters that expose extra APIs.

  Parameters

  • ctx: Ctx

  Returns void

cancel

• cancel(lookup: PaymentLookup, ctx: Ctx): Promise<Payment>

  Void a same-day card payment (no amount). Looks the transaction up by reference when needed.

  Parameters

  • lookup: PaymentLookup
  • ctx: Ctx

  Returns Promise<Payment>

capture

• capture(input: CaptureInput, ctx: Ctx): Promise<Payment>

  Capture an authorization made with providerOptions.capture: "manual".

  Parameters

  • input: CaptureInput
  • ctx: Ctx

  Returns Promise<Payment>

createCheckout

• createCheckout(
      input: CreateCheckoutInput<"paymob">,
      ctx: Ctx,
  ): Promise<Checkout>

  Hosted Unified Checkout, or a kiosk bill reference when methods is ["cash_outlet"].

  payment.providerPaymentId is empty until Paymob creates the transaction: the id arrives with the webhook or payments.reconcile. Refunds, voids and captures need that transaction id.

  Parameters

  • input: CreateCheckoutInput<"paymob">
  • ctx: Ctx

  Returns Promise<Checkout>

getPayment

• getPayment(lookup: PaymentLookup, ctx: Ctx): Promise<Payment>

  Parameters

  • lookup: PaymentLookup
  • ctx: Ctx

  Returns Promise<Payment>

inspectWebhook

• inspectWebhook(req: RawWebhookRequest): Promise<WebhookInspection>

  Parameters

  • req: RawWebhookRequest

  Returns Promise<WebhookInspection>

integrationId

• integrationId(
      key:
          | "card"
          | "wallet"
          | "cash_outlet"
          | "installments"
          | "bnpl"
          | "bank_transfer"
          | "other"
          | "card_auth"
          | "card_moto"
          | "apple_pay",
  ): number

  Configured id for key, or CAPABILITY_NOT_SUPPORTED.

  Parameters

  • key:
        | "card"
        | "wallet"
        | "cash_outlet"
        | "installments"
        | "bnpl"
        | "bank_transfer"
        | "other"
        | "card_auth"
        | "card_moto"
        | "apple_pay"

  Returns number

parseWebhook

• parseWebhook(verified: VerifiedWebhook, ctx: Ctx): Promise<SarrafEvent>

  Parameters

  • verified: VerifiedWebhook
  • ctx: Ctx

  Returns Promise<SarrafEvent>

refund

• refund(input: RefundInput, ctx: Ctx): Promise<Refund>

  Parameters

  • input: RefundInput
  • ctx: Ctx

  Returns Promise<Refund>

verifyRedirect

• verifyRedirect(query: Record<string, string>): Promise<RedirectResult>

  Parameters

  • query: Record<string, string>

  Returns Promise<RedirectResult>

verifyWebhook

• verifyWebhook(req: RawWebhookRequest): Promise<VerifiedWebhook>

  Throws WEBHOOK_SIGNATURE_INVALID when the signature does not match.

  Parameters

  • req: RawWebhookRequest

  Returns Promise<VerifiedWebhook>