Class FawryProvider

constructor

• new FawryProvider(
      options: {
          baseUrl?: string;
          confirmWithStatusQuery?: boolean;
          environment?: "staging" | "production";
          language?: "en-gb" | "ar-eg";
          merchantCode: string;
          secureKey: string;
      },
  ): FawryProvider

  Parameters

  • options: {
        baseUrl?: string;
        confirmWithStatusQuery?: boolean;
        environment?: "staging" | "production";
        language?: "en-gb" | "ar-eg";
        merchantCode: string;
        secureKey: string;
    }

    • OptionalbaseUrl?: string

    • OptionalconfirmWithStatusQuery?: boolean

      After a valid notification signature, re-query the payment status before trusting it. Default true until the V2 signature recipe is verified against real notifications.

    • Optionalenvironment?: "staging" | "production"

    • Optionallanguage?: "en-gb" | "ar-eg"

      Language for APIs that take one.

    • merchantCode: string

    • secureKey: string

      Secret appended to every signature (plain SHA-256, not HMAC).

  Returns FawryProvider

Readonlycapabilities

Readonlyconfig

Readonlyid

cancel

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

  ⚠️ Beta. Cancel an unpaid reference code.

  Parameters

  • lookup: PaymentLookup
  • ctx: Ctx

  Returns Promise<Payment>

createCheckout

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

  Parameters

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

  Returns Promise<Checkout>

getPayment

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

  Status v2 looks up by merchant reference.

  Parameters

  • lookup: PaymentLookup
  • ctx: Ctx

  Returns Promise<Payment>

inspectWebhook

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

  Parameters

  • req: RawWebhookRequest

  Returns Promise<WebhookInspection>

parseWebhook

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

  Parameters

  • verified: VerifiedWebhook
  • ctx: Ctx

  Returns Promise<SarrafEvent>

refund

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

  ⚠️ Beta. providerPaymentId is the Fawry reference number.

  Parameters

  • input: RefundInput
  • ctx: Ctx

  Returns Promise<Refund>

verifyWebhook

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

  Throws WEBHOOK_SIGNATURE_INVALID when the signature does not match.

  Parameters

  • req: RawWebhookRequest

  Returns Promise<VerifiedWebhook>