# @types/react-native-razorpay

> TypeScript definitions for react-native-razorpay

Latest version **2.2.6** (published 2024-10-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/react-native-razorpay
pnpm add @types/react-native-razorpay
yarn add @types/react-native-razorpay
bun add @types/react-native-razorpay
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 2.2.6 |
| Published | 2024-10-03 |
| First published | 2022-08-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51439 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/react-native-razorpay
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-native-razorpay
- npm.io page: https://npm.io/package/@types/react-native-razorpay

## Dependencies (1)

- [@types/react](https://npm.io/package/@types/react.md) *

## Recent versions

- 2.2.6 (latest) — 2024-10-03
- 2.2.5 (ts4.6) — 2023-12-21
- 2.2.4 (ts4.5) — 2023-11-07
- 2.2.1 (ts4.2) — 2022-12-06
- 2.2.0 (ts4.0) — 2022-08-12
- 2.2.3 — 2023-10-18
- 2.2.2 — 2023-09-27

## README

# Installation
> `npm install --save @types/react-native-razorpay`

# Summary
This package contains type definitions for react-native-razorpay (https://www.npmjs.com/package/react-native-razorpay).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-native-razorpay.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-native-razorpay/index.d.ts)
````ts
export interface SuccessResponse {
    razorpay_signature: string;
    razorpay_order_id: string;
    razorpay_payment_id: string;
}

// type valid for errors after successful API integration
export interface ErrorResponse {
    code: number;
    description: string;
    error: {
        field?: string;
        source: string;
        step: string;
        reason: string;
        metadata: {
            payment_id?: string;
            order_id: string;
        };
    };
}

export interface CheckoutOptions {
    key: string;
    amount: number;
    currency: string;
    name: string;
    description: string;
    image?: string;
    order_id: string;
    prefill?: {
        name?: string;
        email?: string;
        contact?: string;
        method?: "card" | "netbanking" | "wallet" | "emi" | "upi";
    };
    notes?: Record<string | number, string>;
    theme?: {
        hide_topbar?: boolean;
        color?: string;
        backdrop_color?: string;
    };
    modal?: {
        backdropclose?: boolean;
        escape?: boolean;
        handleback?: boolean;
        confirm_close?: boolean;
        ondismiss?: () => void;
        animation?: boolean;
    };
    subscription_id?: string;
    subscription_card_change?: boolean;
    recurring?: boolean;
    callback_url?: string;
    redirect?: boolean;
    customer_id?: string;
    timeout?: number;
    remember_customer?: boolean;
    readonly?: {
        contact?: boolean;
        email?: boolean;
        name?: boolean;
    };
    hidden?: {
        contact?: boolean;
        email?: boolean;
    };
    send_sms_hash?: boolean;
    allow_rotation?: boolean;
    retry?: {
        enabled: boolean;
        max_count: number;
    };
    config?: {
        display: {
            language: "en" | "ben" | "hi" | "mar" | "guj" | "tam" | "tel";
        };
    };
}

declare const RazorpayCheckout: {
    open: (
        options: CheckoutOptions,
        successCallback?: (data: SuccessResponse) => void,
        errorCallback?: (data: ErrorResponse) => void,
    ) => Promise<SuccessResponse>;
    onExternalWalletSelection: (externalWalletCallback: (data: unknown) => void) => void;
};

export default RazorpayCheckout;

````

### Additional Details
 * Last updated: Thu, 03 Oct 2024 22:37:43 GMT
 * Dependencies: [@types/react](https://npmjs.com/package/@types/react)

# Credits
These definitions were written by [Ankan Bhattacharya](https://github.com/Ankan002).

---
_Source: https://npm.io/package/@types/react-native-razorpay · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._