### Navigate and Start React App

Source: https://paystack.com/docs/guides/accept_payments_on_your_react_app

Change directory into the newly created app and start the development server.

```bash
cd react-paystack-checkout
yarn start
```

--------------------------------

### Install Vue CLI

Source: https://paystack.com/docs/guides/accept_payments_on_your_vue_app

Install the Vue command-line interface globally using npm or yarn.

```bash
npm install -g @vue/cli
# OR
yarn global add @vue/cli
```

--------------------------------

### Install and Run MCP Server

Source: https://paystack.com/docs/developer-tools/mcp-server

Install and run the Paystack MCP Server using npx. Ensure you have Node.js v18+ and your Paystack test secret key.

```bash
npx @paystack/mcp-server --api-key sk_test_your_key_here
```

--------------------------------

### GET /product

Source: https://paystack.com/docs/api/product

List products available on your integration.

```APIDOC
## GET /product

### Description
List products available on your integration.

### Method
GET

### Endpoint
/product
```

--------------------------------

### GET /plan

Source: https://paystack.com/docs/api/plan

List plans available on your integration.

```APIDOC
## GET /plan

### Description
List plans available on your integration.

### Method
GET

### Endpoint
https://api.paystack.co/plan
```

--------------------------------

### GET /storefront/:id/product

Source: https://paystack.com/docs/api/storefront

Lists all products currently in a storefront.

```APIDOC
## GET /storefront/:id/product

### Description
List the products in a storefront.

### Method
GET

### Endpoint
/storefront/:id/product

### Parameters
#### Path Parameters
- **id** (Integer) - Required - The storefront ID

### Headers
- **authorization** (String) - Required - Set value to Bearer SECRET_KEY

### Response
#### Success Response (200)
- **status** (boolean) - Success status
- **data** (Array) - List of products

#### Response Example
{
  "status": true,
  "message": "Products retrieved",
  "data": [
    {
      "id": 2196244,
      "name": "Sample Product",
      "description": "A sample product",
      "price": 10000,
      "currency": "NGN",
      "active": true
    }
  ]
}
```

--------------------------------

### Install react-paystack Library

Source: https://paystack.com/docs/guides/accept_payments_on_your_react_app

Add the react-paystack library to your project dependencies using yarn.

```bash
yarn add react-paystack
```

--------------------------------

### Installation

Source: https://paystack.com/docs/developer-tools/android-sdk

Add the Paystack Android SDK dependency to your app-level build.gradle file.

```APIDOC
## Installation

To use the SDK, add the `paystack-ui` in the `dependencies` block of your app-level build file:

##### Latest dependency version
You should check Maven Central to get the latest version before installation.

* build.gradle

```groovy
1dependencies {
2  implementation 'com.paystack.android:paystack-ui:0.0.9'
3}
```

Ensure you sync the project to download the SDK into your project. On successful installation, you’d have access to the UI components and methods to accept payment in your Android app.
```

--------------------------------

### Include Paystack Popup JS via CDN

Source: https://paystack.com/docs/payments/accept-payments

Add the Paystack Popup Javascript library to your frontend application using a CDN link. This is the simplest way to get started with the Popup integration.

```html
<script src="https://js.paystack.co/v2/inline.js">

```

--------------------------------

### GET /decision/bin/:bin

Source: https://paystack.com/docs/api/verification

Get more information about a customer's card.

```APIDOC
## GET /decision/bin/:bin

### Description
Get more information about a customer's card.

### Method
GET

### Endpoint
/decision/bin/:bin

### Parameters
#### Path Parameters
- **bin** (String) - Required - First 6 characters of card

### Request Example
curl "https://api.paystack.co/decision/bin/539983" -H "Authorization: Bearer YOUR_SECRET_KEY" -X GET

### Response
#### Success Response (200)
- **status** (boolean) - Status of the request
- **message** (string) - Response message
- **data** (object) - Card details

#### Response Example
{
  "status": true,
  "message": "Bin resolved",
  "data": {
    "bin": "539983",
    "brand": "Mastercard",
    "sub_brand": "",
    "country_code": "NG",
    "country_name": "Nigeria",
    "card_type": "DEBIT",
    "bank": "Guaranty Trust Bank",
    "linked_bank_id": 9
  }
}
```

--------------------------------

### Initialize Paystack Builder

Source: https://paystack.com/docs/developer-tools/android-sdk

Configure the Paystack SDK with your public key and logging preferences.

```kotlin
Paystack.builder()
    .setPublicKey("pk_domain_xxxxxxxx")
    .setLoggingEnabled(true)
    .build()
```

--------------------------------

### GET /storefront/:id

Source: https://paystack.com/docs/api/storefront

Get the details of a specific storefront on your integration.

```APIDOC
## GET /storefront/:id

### Description
Get the details of a storefront on your integration.

### Method
GET

### Endpoint
/storefront/:id

### Parameters
#### Path Parameters
- **id** (Integer) - Required - The storefront ID you want to fetch

### Response
#### Success Response (200)
- **status** (Boolean) - Status of the request
- **data** (Object) - Storefront details

#### Response Example
{
  "status": true,
  "message": "Storefront retrieved",
  "data": {
    "id": 1559046,
    "name": "My Storefront",
    "slug": "my-storefront",
    "description": "A description of my storefront",
    "status": "active",
    "currency": "NGN",
    "createdAt": "2024-11-01T12:00:00.000Z",
    "updatedAt": "2024-11-01T12:00:00.000Z"
  }
}
```

--------------------------------

### Configure Legacy Card Parameters

Source: https://paystack.com/docs/guides/migrating-to-paystack-ui-ios

Set up card and transaction parameters using the legacy SDK approach.

```swift
let cardParams = PSTCKCardParams.init();
let transactionParams = PSTCKTransactionParams.init();

// then set parameters thus from card
cardParams.number = "4084084084084081"
cardParams.cvc = "408"
cardParams.expMonth = 06
cardParams.expYear = 2024

transactionParams.amount = 12390;
transactionParams.email = "old@ma.il";
```

--------------------------------

### State Variables and Input Handling

Source: https://paystack.com/docs/guides/accept_payments_on_your_react_app

Initialize state variables for email, name, and phone, and set up input change handlers. Ensure the publicKey is set and the amount is in kobo.

```jsx
const publicKey = "pk_your_public_key_here"
  const amount = 1000000 // Remember, set in kobo!
  const [email, setEmail] = useState("")
  const [name, setName] = useState("")
  const [phone, setPhone] = useState("")

...

<div className="checkout-form">
  <div className="checkout-field">
    <label>Name</label>
    <input
      type="text"
      id="name"
      onChange={(e) => setName(e.target.value)}
    />
  </div>
  <div className="checkout-field">
    <label>Email</label>
    <input
      type="text"
      id="email"
      onChange={(e) => setEmail(e.target.value)}
    />
  </div>
  <div className="checkout-field">
    <label>Phone</label>
    <input
      type="text"
      id="phone"
      onChange={(e) => setPhone(e.target.value)}
    />
  </div>
  <PaystackButton className="paystack-button" {...componentProps} />
</div>
```

--------------------------------

### Create a New Vue Project

Source: https://paystack.com/docs/guides/accept_payments_on_your_vue_app

Create a new Vue.js project using the Vue CLI. It's recommended to choose the default preset for beginners.

```bash
vue create project_name
```

--------------------------------

### Install Vue Paystack Package

Source: https://paystack.com/docs/guides/accept_payments_on_your_vue_app

Install the vue-paystack package using npm to integrate Paystack's checkout functionality into your Vue application.

```bash
npm install vue-paystack --save
```

--------------------------------

### Initialize Paystack SDK (Old)

Source: https://paystack.com/docs/guides/migrating-to-paystack-ui-android

This is the initialization method for the older Paystack SDK. It is shown for comparison during migration.

```kotlin
PaystackSdk.initialize(applicationContext)
PaystackSdk.setPublicKey("pk_your-public-key")
```

```java
PaystackSdk.initialize(applicationContext);
PaystackSdk.setPublicKey("pk_your-public-key");
```

--------------------------------

### launch() Method

Source: https://paystack.com/docs/developer-tools/flutter-sdk

The launch method completes a transaction previously initialized on your server by loading the payment UI.

```APIDOC
## launch(accessCode)

### Description
This method is used for completing the transaction that you previously initialized on your server. It loads the payment UI which your customers interact with when completing their payment.

### Parameters
#### Path Parameters
- **accessCode** (String) - Required - This is the access_code in the response from the transaction initialization request.

### Request Example
final response = await _paystack.launch(_accessCode);

### Response
#### Success Response (TransactionResponse)
- **status** (String) - Indicates the state of the transaction (success, cancelled, failed).
- **message** (String) - A short detail about the status of the transaction.
- **reference** (String) - A unique identifier used to manage post-payment processes (only returned when status is success).
```

--------------------------------

### Get Transaction Totals

Source: https://paystack.com/docs/api/transaction

Retrieve the total number of transactions, total volume, and breakdown by currency. This endpoint is useful for getting an overview of transaction activity.

```APIDOC
## GET /transaction/totals

### Description
Retrieve the total number of transactions and total volume processed.

### Method
GET

### Endpoint
/transaction/totals

### Query Parameters
- **perPage** (Integer) - Specify how many records you want to retrieve per page. If not specified, we use a default value of 50.
- **page** (Integer) - Specify exactly what page you want to retrieve. If not specified, we use a default value of 1.
- **from** (Datetime) - Optional. A timestamp from which to start listing transactions (e.g., `2016-09-24T00:00:05.000Z`, `2016-09-21`).
- **to** (Datetime) - Optional. A timestamp at which to stop listing transactions (e.g., `2016-09-24T00:00:05.000Z`, `2016-09-21`).

### Request Example
```curl
curl "https://api.paystack.co/transaction/totals" \
     -H "Authorization: Bearer YOUR_SECRET_KEY" \
     -X GET
```

### Response
#### Success Response (200)
- **status** (Boolean) - Indicates if the request was successful.
- **message** (String) - A message describing the result of the request.
- **data** (Object) - Contains the transaction totals.
  - **total_transactions** (Integer) - The total number of transactions.
  - **total_volume** (Integer) - The total volume of transactions in the smallest currency unit.
  - **total_volume_by_currency** (Array) - An array of objects, each containing currency and its total volume.
  - **pending_transfers** (Integer) - The total amount of pending transfers.
  - **pending_transfers_by_currency** (Array) - An array of objects, each containing currency and its pending transfer amount.

#### Response Example
```json
{
  "status": true,
  "message": "Transaction totals",
  "data": {
    "total_transactions": 42670,
    "total_volume": 6617829946,
    "total_volume_by_currency": [
      {
        "currency": "NGN",
        "amount": 6617829946
      },
      {
        "currency": "USD",
        "amount": 28000
      }
    ],
    "pending_transfers": 6617829946,
    "pending_transfers_by_currency": [
      {
        "currency": "NGN",
        "amount": 6617829946
      },
      {
        "currency": "USD",
        "amount": 28000
      }
    ]
  }
}
```
```

--------------------------------

### Initialize PaystackCore Builder

Source: https://paystack.com/docs/developer-tools/ios-sdk

Use the PaystackCore builder pattern to initialize the SDK, set your public key, and build the Paystack instance. Ensure your public key is correctly formatted.

```swift
let paystack = try? PaystackBuilder
        .newInstance
        .setKey("pk_domain_xxxxxxxx")
        .build()
```

--------------------------------

### Refunds API Response Example

Source: https://paystack.com/docs/payments/refunds

This is an example of the JSON response you can expect when listing refunds. It includes details for each refund such as integration ID, transaction ID, amount, status, and timestamps.

```json
{
  "status": true,
  "message": "Refunds retrieved",
  "data": [
    {
      "integration": 428626,
      "transaction": 627178582,
      "dispute": null,
      "settlement": null,
      "id": 747680,
      "domain": "test",
      "currency": "NGN",
      "amount": 10000,
      "status": "processed",
      "refunded_at": null,
      "refunded_by": "jen@smith.com",
      "customer_note": "Refund for transaction qufywna9w9a5d8v",
      "merchant_note": "Refund for transaction qufywna9w9a5d8v by jen@smith.com",
      "deducted_amount": 10000,
      "fully_deducted": true,
      "createdAt": "2020-05-19T11:12:17.000Z"
    },
    {
      "integration": 428626,
      "transaction": 640672957,
      "dispute": null,
      "settlement": null,
      "id": 742609,
      "domain": "test",
      "currency": "NGN",
      "amount": 20000,
      "status": "processed",
      "refunded_at": null,
      "refunded_by": "jen@smith.com",
      "customer_note": "blah blah",
      "merchant_note": "yada yada",
      "deducted_amount": 20000,
      "fully_deducted": true,
      "createdAt": "2020-04-30T10:43:47.000Z"
    }
  ],
  "meta": {
    "total": 2,
    "skipped": 0,
    "perPage": 50,
    "page": 1,
    "pageCount": 1
  }
}
```

--------------------------------

### Initialize Paystack SDK

Source: https://paystack.com/docs/guides/accept-payments-on-your-android-app

Initialize the Paystack SDK using a builder pattern, providing your public key and enabling logging.

```kotlin
Paystack.builder()
    .setPublicKey("pk_domain_xxxxxxxx")
    .setLoggingEnabled(true)
    .build()
```

--------------------------------

### Verify Transaction Response Example

Source: https://paystack.com/docs/payments/verify-payments

This is an example of a successful response from the Verify Transaction API. Note that `response.status` indicates the API call status, while `response.data.status` indicates the transaction status.

```json
{
  "status": true,
  "message": "Verification successful",
  "data": {
    "id": 4099260516,
    "domain": "test",
    "status": "success",
    "reference": "re4lyvq3s3",
    "receipt_number": null,
    "amount": 40333,
    "message": null,
    "gateway_response": "Successful",
    "paid_at": "2024-08-22T09:15:02.000Z",
    "created_at": "2024-08-22T09:14:24.000Z",
    "channel": "card",
    "currency": "NGN",
    "ip_address": "197.210.54.33",
    "metadata": "",
    "log": {
      "start_time": 1724318098,
      "time_spent": 4,
      "attempts": 1,
      "errors": 0,
      "success": true,
      "mobile": false,
      "input": [],
      "history": [
        {
          "type": "action",
          "message": "Attempted to pay with card",
          "time": 3
        },
        {
          "type": "success",
          "message": "Successfully paid with card",
          "time": 4
        }
      ]
    },
    "fees": 10283,
    "fees_split": null,
    "authorization": {
      "authorization_code": "AUTH_uh8bcl3zbn",
      "bin": "408408",
      "last4": "4081",
      "exp_month": "12",
      "exp_year": "2030",
      "channel": "card",
      "card_type": "visa ",
      "bank": "TEST BANK",
      "country_code": "NG",
      "brand": "visa",
      "reusable": true,
      "signature": "SIG_yEXu7dLBeqG0kU7g95Ke",
      "account_name": null
    },
    "customer": {
      "id": 181873746,
      "first_name": null,
      "last_name": null,
      "email": "demo@test.com",
      "customer_code": "CUS_1rkzaqsv4rrhqo6",
      "phone": null,
      "metadata": null,
      "risk_action": "default",
      "international_format_phone": null
    },
    "plan": null,
    "split": {},
    "order_id": null,
    "paidAt": "2024-08-22T09:15:02.000Z",
    "createdAt": "2024-08-22T09:14:24.000Z",
    "requested_amount": 30050,
    "pos_transaction_data": null,
    "source": null,
    "fees_breakdown": null,
    "connect": null,
    "transaction_date": "2024-08-22T09:14:24.000Z",
    "plan_object": {},
    "subaccount": {}
  }
}
```

--------------------------------

### POST /product

Source: https://paystack.com/docs/api/product

Create a new product on your integration.

```APIDOC
## POST /product

### Description
Create a product on your integration.

### Method
POST

### Endpoint
/product

### Parameters
#### Request Body
- **name** (String) - Required - Name of product
- **description** (String) - Required - A description for this product
- **price** (Integer) - Required - Price should be in the subunit of the supported currency
- **currency** (String) - Required - Currency in which price is set
- **unlimited** (Boolean) - Optional - Set to true if the product has unlimited stock. Leave as false if the product has limited stock
- **quantity** (Integer) - Optional - Number of products in stock. Use if unlimited is false

### Request Example
{
  "name": "Puff Puff",
  "description": "Crispy flour ball with fluffy interior",
  "price": "5000",
  "currency": "NGN",
  "unlimited": false,
  "quantity": 100
}

### Response
#### Success Response (201)
- **status** (Boolean) - Success status
- **message** (String) - Success message
- **data** (Object) - Product details

#### Response Example
{
  "status": true,
  "message": "Product successfully created",
  "data": {
    "name": "Puff Puff",
    "description": "Crispy flour ball with fluffy interior",
    "currency": "NGN",
    "price": 5000,
    "quantity": 100,
    "id": 489399
  }
}
```

--------------------------------

### List Banks Response Example

Source: https://paystack.com/docs/identity-verification/verify-account-number

This is an example of the JSON response when listing banks that are enabled for verification. It includes bank details such as ID, name, slug, code, and supported types.

```json
{
  "status": true,
  "message": "Banks retrieved",
  "data": [
    {
      "id": 140,
      "name": "Absa Bank Limited, South Africa",
      "slug": "absa-za",
      "code": "632005",
      "longcode": "632005",
      "gateway": null,
      "pay_with_bank": false,
      "active": true,
      "country": "South Africa",
      "currency": "ZAR",
      "type": "basa",
      "is_deleted": false,
      "createdAt": "2020-09-04T10:38:56.000Z",
      "updatedAt": null,
      "supported_types": [
        "business",
        "personal"
      ]
    },
    {
      "id": 141,
      "name": "African Bank Limited",
      "slug": "african-bank-za",
      "code": "430000",
      "longcode": "430000",
      "gateway": null,
      "pay_with_bank": false,
      "active": true,
      "country": "South Africa",
      "currency": "ZAR",
      "type": "basa",
      "is_deleted": false,
      "createdAt": "2020-09-04T10:38:56.000Z",
      "updatedAt": null,
      "supported_types": [
        "business",
        "personal"
      ]
    },
    {
      "id": 146,
      "name": "Capitec Bank Limited",
      "slug": "capitec-bank-za",
      "code": "470010",
      "longcode": "470010",
      "gateway": null,
      "pay_with_bank": false,
      "active": true,
      "country": "South Africa",
      "currency": "ZAR",
      "type": "basa",
      "is_deleted": false,
      "createdAt": "2020-09-04T10:38:56.000Z",
      "updatedAt": null,
      "supported_types": [
        "personal"
      ]
    },
    {
      "id": 147,
      "name": "Discovery Bank Limited",
      "slug": "discovery-bank-za",
      "code": "679000",
      "longcode": "679000",
      "gateway": null,
      "pay_with_bank": false,
      "active": true,
      "country": "South Africa",
      "currency": "ZAR",
      "type": "basa",
      "is_deleted": false,
      "createdAt": "2020-09-04T10:38:56.000Z",
      "updatedAt": null,
      "supported_types": [
        "business",
        "personal"
      ]
    },
    {
      "id": 151,
      "name": "First National Bank",
      "slug": "first-national-bank-za",
      "code": "250655",
      "longcode": "250655",
      "gateway": null,
      "pay_with_bank": false,
      "active": true,
      "country": "South Africa",
      "currency": "ZAR",
      "type": "basa",
      "is_deleted": false,
      "createdAt": "2020-09-04T10:38:56.000Z",
      "updatedAt": null,
      "supported_types": [
        "business",
        "personal"
      ]
    },
    {
      "id": 152,
      "name": "Grindrod Bank",
      "slug": "grindrod-bank-za",
      "code": "584000",
      "longcode": "584000",
      "gateway": null,
      "pay_with_bank": false,
      "active": true,
      "country": "South Africa",
      "currency": "ZAR",
      "type": "basa",
      "is_deleted": false,
      "createdAt": "2020-09-04T10:38:56.000Z",
      "updatedAt": null,
      "supported_types": [
        "business",
        "personal"
      ]
    },
    {
      "id": 153,
      "name": "Investec Bank Ltd",
      "slug": "investec-bank-za",
      "code": "580105",
      "longcode": "580105",
      "gateway": null,
      "pay_with_bank": false,
      "active": true,
      "country": "South Africa",
      "currency": "ZAR",
      "type": "basa",
      "is_deleted": false,
      "createdAt": "2020-09-04T10:38:56.000Z",
      "updatedAt": null,
      "supported_types": [
        "business",
        "personal"
      ]
    },
    {
      "id": 157,
      "name": "Nedbank",
      "slug": "nedbank-za",
      "code": "198765",
      "longcode": "198765",
      "gateway": null,
      "pay_with_bank": false,
      "active": true,
      "country": "South Africa",
      "currency": "ZAR",
      "type": "basa",
      "is_deleted": false,
      "createdAt": "2020-09-04T10:38:56.000Z",
      "updatedAt": null,
      "supported_types": [
        "business",
        "personal"
      ]
    },
    {
      "id": 161,
      "name": "SASFIN Bank",
      "slug": "sasfin-bank-za",
      "code": "683000",
      "longcode": "683000",
      "gateway": null,
      "pay_with_bank": false,
      "active": true,
      "country": "South Africa",
      "currency": "ZAR",
      "type": "basa",
      "is_deleted": false,
      "createdAt": "2020-09-04T10:38:56.000Z",
      "updatedAt": null,
      "supported_types": [
        "business",
        "personal"
      ]
    }
  ]
}
```

--------------------------------

### Get Available Dedicated Account Providers (cURL)

Source: https://paystack.com/docs/api/dedicated-virtual-account

Use this cURL command to make a GET request to retrieve available dedicated account providers. Ensure your Authorization header is correctly formatted with your secret key.

```bash
#!/bin/sh
url="https://api.paystack.co/dedicated_account/available_providers"
authorization="Authorization: Bearer YOUR_SECRET_KEY"

curl "$url" -H "$authorization" -X GET

```

--------------------------------

### Fetch Dispute

Source: https://paystack.com/docs/api/dispute

Get more details about a specific dispute.

```APIDOC
## GET /dispute/{id}

### Description
Get more details about a dispute.

### Method
GET

### Endpoint
/dispute/{id}

### Headers
- **authorization** (String) - Required - Set value to `Bearer SECRET_KEY`
```

--------------------------------

### Plan Creation Response

Source: https://paystack.com/docs/payments/subscriptions

This is a sample response after successfully creating a plan. It includes details like the plan code, currency, and creation timestamps.

```json
{
  "status": true,
  "message": "Plan created",
  "data": {
    "name": "Monthly Retainer",
    "interval": "monthly",
    "amount": 500000,
    "integration": 428626,
    "domain": "test",
    "currency": "NGN",
    "plan_code": "PLN_u4cqud8vabi89hx",
    "invoice_limit": 0,
    "send_invoices": true,
    "send_sms": true,
    "hosted_page": false,
    "migrate": false,
    "id": 49122,
    "createdAt": "2020-05-22T12:36:12.333Z",
    "updatedAt": "2020-05-22T12:36:12.333Z"
  }
}
```

--------------------------------

### Initialize Paystack SDK

Source: https://paystack.com/docs/developer-tools/flutter-sdk

Asynchronously initialize the Paystack SDK with your public key and optionally enable logging. Handles potential platform exceptions during initialization.

```dart
String publicKey = "pk_domain_xxxxxx";

try {
  final response = await _paystack.initialize(publicKey, true); // allow logging
  if (response) {
    log("Sucessfully initialised the SDK");
  } else {
     log("Unable to initialise the SDK");
  }
} on PlatformException catch (e) {
   log(e.message!);
}
```

--------------------------------

### GET /terminal

Source: https://paystack.com/docs/api/terminal

List all Terminals associated with your integration.

```APIDOC
## GET /terminal

### Description
List the Terminals available on your integration.

### Method
GET

### Endpoint
/terminal

### Headers
- **authorization** (String) - Required - Set value to `Bearer SECRET_KEY`

### Query Parameters
- **perPage** (Integer) - Optional - Specify how many records you want to retrieve per page. Default is 50.
- **next** (String) - Optional - A cursor that indicates your place in the list. Used to fetch the next page.
- **previous** (String) - Optional - A cursor that indicates your place in the list. Used to fetch the previous page.

### Response
#### Success Response (200)
- **status** (Boolean) - Indicates if the request was successful.
- **message** (String) - A message describing the result of the request.
- **data** (Array) - A list of terminal objects.
  - **id** (Integer) - The unique identifier for the terminal.
  - **serial_number** (String) - The serial number of the terminal.
  - **device_make** (String or null) - The make of the terminal device.
  - **terminal_id** (String) - The Paystack-assigned ID for the terminal.
  - **integration** (Integer) - The integration ID associated with the terminal.
  - **domain** (String) - The domain (e.g., 'live') the terminal is associated with.
  - **name** (String) - The name assigned to the terminal.
  - **address** (String or null) - The physical address of the terminal.
  - **status** (String) - The current status of the terminal (e.g., 'active').
- **meta** (Object) - Metadata for pagination.
  - **next** (String or null) - Cursor for the next page.
  - **previous** (String or null) - Cursor for the previous page.
  - **perPage** (Integer) - The number of items per page.

#### Response Example
```json
{
  "status": true,
  "message": "Terminals retrieved successfully",
  "data": [
    {
      "id": 30,
      "serial_number": "033301504100A563877",
      "device_make": null,
      "terminal_id": "2872S934",
      "integration": 463433,
      "domain": "live",
      "name": "Damilola's Terminal",
      "address": null,
      "status": "active"
    }
  ],
  "meta": {
    "next": null,
    "previous": null,
    "perPage": 1
  }
}
```
```

--------------------------------

### GET /storefront

Source: https://paystack.com/docs/api/storefront

List the storefronts available on your integration.

```APIDOC
## GET /storefront

### Description
List the storefronts available on your integration.

### Method
GET

### Endpoint
/storefront

### Parameters
#### Query Parameters
- **perPage** (Integer) - Optional - Specify how many records you want to retrieve per page.
- **page** (Integer) - Optional - Specify exactly what page you want to retrieve.
- **status** (String) - Optional - Filter by storefront status (active or inactive).

### Response
#### Success Response (200)
- **status** (Boolean) - Status of the request
- **data** (Array) - List of storefronts
- **meta** (Object) - Pagination metadata

#### Response Example
{
  "status": true,
  "message": "Storefronts retrieved",
  "data": [
    {
      "id": 1559046,
      "name": "My Storefront",
      "slug": "my-storefront",
      "description": "A description of my storefront",
      "status": "active",
      "currency": "NGN",
      "createdAt": "2024-11-01T12:00:00.000Z",
      "updatedAt": "2024-11-01T12:00:00.000Z"
    }
  ],
  "meta": {
    "total": 1,
    "skipped": 0,
    "perPage": 50,
    "page": 1,
    "pageCount": 1
  }
}
```

--------------------------------

### Initiate Multi-Split Transaction with Predefined Split

Source: https://paystack.com/docs/developer-tools/inlinejs

This code demonstrates setting up a transaction that is split among multiple subaccounts using a predefined split configuration. The `split` object defines the type and distribution.

```javascript
const popup = new Paystack()

popup.newTransaction({
  key: 'pk_domain_xxxxxx',
  email: 'split@dynamic.com',
  amount: 35650,
  currency: 'NGN',
  split: {
    type: 'percentage',
    bearer_type: 'account',
    subaccounts: [
      {
        subaccount: 'ACCT_dskvlw3y3dsvkmt',
        share: 30
      },
      {
        subaccount: 'ACCT_eg4sob4590pq9vb',
        share: 20
      }
    ]
  },
  onSuccess: (transaction) => {
    console.log(transaction);
  },
  onLoad: (response) => {
    console.log("onLoad: ", response);
  },
  onCancel: () => {
    console.log("onCancel");
  },
  onError: (error) => {
    console.log("Error: ", error.message);
  }
})
```

--------------------------------

### Sample Product Creation Response

Source: https://paystack.com/docs/api/product

This is a sample successful response when a product is created via the API.

```json
{
  "status": true,
  "message": "Product successfully created",
  "data": {
    "name": "Puff Puff",
    "description": "Crispy flour ball with fluffy interior",
    "currency": "NGN",
    "price": 5000,
    "quantity": 100,
    "is_shippable": true,
    "unlimited": false,
    "integration": 463433,
    "domain": "test",
    "metadata": {
      "background_color": "#F5F5F5"
    },
    "slug": "puff-puff-prqnxc",
    "product_code": "PROD_ddot3upakgl3ejt",
    "quantity_sold": 0,
    "type": "good",
    "shipping_fields": {
      "delivery_note": "disabled"
    },
    "active": true,
    "in_stock": true,
    "minimum_orderable": 1,
    "maximum_orderable": null,
    "low_stock_alert": false,
    "id": 489399,
    "createdAt": "2021-11-08T14:39:37.303Z",
    "updatedAt": "2021-11-08T14:39:37.303Z"
  }
}

```

--------------------------------

### GET /apple-pay/domain

Source: https://paystack.com/docs/api/apple-pay

Lists all registered domains on your integration.

```APIDOC
## GET /apple-pay/domain

### Description
Lists all registered domains on your integration. Returns an empty array if no domains have been added.

### Method
GET

### Endpoint
/apple-pay/domain

### Parameters
#### Query Parameters
- **use_cursor** (boolean) - Optional - Flag to enable cursor pagination on the endpoint
- **next** (String) - Optional - A cursor that indicates your place in the list to fetch the next page
- **previous** (String) - Optional - A cursor that indicates your place in the list to fetch the previous page

### Response
#### Success Response (200)
- **status** (boolean) - Status of the request
- **message** (String) - Success message
- **data** (Object) - Object containing domainNames array

#### Response Example
{
  "status": true,
  "message": "Apple Pay registered domains retrieved",
  "data": {
    "domainNames": [
      "example.com"
    ]
  }
}
```

--------------------------------

### Create Product - cURL

Source: https://paystack.com/docs/api/product

Use this cURL command to create a new product. Ensure to replace YOUR_SECRET_KEY with your actual secret key and adjust the JSON body as needed.

```bash
#!/bin/sh
url="https://api.paystack.co/product"
authorization="Authorization: Bearer YOUR_SECRET_KEY"
content_type="Content-Type: application/json"
data='{
  "name": "Puff Puff",
  "description": "Crispy flour ball with fluffy interior",
  "price": "5000",
  "currency": "NGN",
  "unlimited": false,
  "quantity": 100
}'

curl "$url" -H "$authorization" -H "$content_type" -d "$data" -X POST

```

--------------------------------

### Launch PaymentSheet

Source: https://paystack.com/docs/developer-tools/android-sdk

Trigger the payment UI using the access_code obtained from your server.

```kotlin
fun makePayment() {
  // Pass access_code from transaction initialize call on the server
  paymentSheet.launch("br6cgmvflhn3qtd")
}
```

--------------------------------

### GET /virtual_terminal

Source: https://paystack.com/docs/api/virtual-terminal

List all Virtual Terminals associated with your integration.

```APIDOC
## GET /virtual_terminal

### Description
List Virtual Terminals on your integration.

### Method
GET

### Endpoint
/virtual_terminal

### Parameters
#### Query Parameters
- **status** (String) - Optional - Filter by status ('active' or 'inactive')
- **perPage** (Integer) - Optional - Number of records per page
- **search** (String) - Optional - Search query string
- **next** (String) - Optional - Cursor for next page
- **previous** (String) - Optional - Cursor for previous page

### Response
#### Success Response (200)
- **status** (Boolean) - Success status
- **data** (Array) - List of virtual terminals
- **meta** (Object) - Pagination metadata

#### Response Example
{
  "status": true,
  "data": [
    {
      "id": 26740,
      "code": "VT_SOUAPKJZ",
      "name": "Sales Point #3"
    }
  ]
}
```

--------------------------------

### Paystack Object Initialization

Source: https://paystack.com/docs/developer-tools/inlinejs

Demonstrates how to initialize the Paystack object after installing the library via NPM or Yarn.

```APIDOC
## Initialization

```javascript
// Add for NPM, Yarn
import Paystack from '@paystack/inline-js';

const popup = new Paystack()
```
```

--------------------------------

### GET /transferrecipient

Source: https://paystack.com/docs/api/transfer-recipient

List all transfer recipients associated with your integration.

```APIDOC
## GET /transferrecipient

### Description
List all transfer recipients associated with your integration.

### Method
GET

### Endpoint
https://api.paystack.co/transferrecipient

### Parameters
#### Query Parameters
- **perPage** (Integer) - Optional - Specify how many records you want to retrieve per page.
- **page** (Integer) - Optional - Specify exactly what page you want to retrieve.
- **from** (Datetime) - Optional - A timestamp from which to start listing transfer recipients.
- **to** (Datetime) - Optional - A timestamp at which to stop listing transfer recipients.

### Response
#### Success Response (200)
- **status** (boolean) - Request status
- **message** (string) - Success message
- **data** (array) - List of recipients

#### Response Example
{
  "status": true,
  "message": "Recipients retrieved",
  "data": []
}
```

--------------------------------

### GET /bank/resolve

Source: https://paystack.com/docs/api/verification

Confirm an account belongs to the right customer.

```APIDOC
## GET /bank/resolve

### Description
Confirm an account belongs to the right customer.

### Method
GET

### Endpoint
/bank/resolve

### Parameters
#### Query Parameters
- **account_number** (String) - Required - Account Number
- **bank_code** (String) - Required - You can get the list of bank codes by calling the List Banks endpoint

### Request Example
curl "https://api.paystack.co/bank/resolve?account_number=0022728151&bank_code=063" -H "Authorization: Bearer YOUR_SECRET_KEY" -X GET

### Response
#### Success Response (200)
- **status** (boolean) - Status of the request
- **message** (string) - Response message
- **data** (object) - Account details including account_number and account_name

#### Response Example
{
  "status": true,
  "message": "Account number resolved",
  "data": {
    "account_number": "0022728151",
    "account_name": "WES GIBBONS"
  }
}
```

--------------------------------

### Initialize Paystack UI with Builder Pattern

Source: https://paystack.com/docs/guides/migrating-to-paystack-ui-android

Initialize Paystack UI using the builder pattern, setting your public key. This replaces the older initialization method.

```kotlin
Paystack.builder
    .setPublicKey("pk_your-public-key")  
    .build()
```

--------------------------------

### Enable Subscription

Source: https://paystack.com/docs/api/subscription

Enable a subscription on your integration by providing the subscription code and email token. The `authorization` header must be set to `Bearer YOUR_SECRET_KEY` and `content-type` to `application/json`.

```bash
#!/bin/sh
url="https://api.paystack.co/subscription/enable"
authorization="Authorization: Bearer YOUR_SECRET_KEY"
content_type="Content-Type: application/json"
data='{
  "code": "SUB_vsyqdmlzble3uii",
  "token": "d7gofp6yppn3qz7"
}'

curl "$url" -H "$authorization" -H "$content_type" -d "$data" -X POST

```

--------------------------------

### POST /storefront

Source: https://paystack.com/docs/api/storefront

Create a digital shop to manage and display your products.

```APIDOC
## POST /storefront

### Description
Create a digital shop to manage and display your products.

### Method
POST

### Endpoint
/storefront

### Parameters
#### Request Body
- **name** (String) - Required - Name of the storefront
- **slug** (String) - Optional - URL slug for the storefront. Must be unique
- **description** (String) - Optional - A description for this storefront

### Request Example
{
  "name": "My Storefront",
  "slug": "my-storefront",
  "description": "A description of my storefront"
}

### Response
#### Success Response (200)
- **status** (Boolean) - Status of the request
- **message** (String) - Success message
- **data** (Object) - Created storefront details

#### Response Example
{
  "status": true,
  "message": "Storefront created",
  "data": {
    "id": 1559046,
    "name": "My Storefront",
    "slug": "my-storefront",
    "description": "A description of my storefront",
    "status": "inactive",
    "currency": "NGN",
    "createdAt": "2024-11-01T12:00:00.000Z",
    "updatedAt": "2024-11-01T12:00:00.000Z"
  }
}
```

--------------------------------

### GET /storefront/verify/:slug

Source: https://paystack.com/docs/api/storefront

Verifies the availability of a storefront slug.

```APIDOC
## GET /storefront/verify/:slug

### Description
Verify the availability of a slug before using it for your storefront.

### Method
GET

### Endpoint
/storefront/verify/:slug

### Parameters
#### Path Parameters
- **slug** (String) - Required - The slug you want to verify

### Headers
- **authorization** (String) - Required - Set value to Bearer SECRET_KEY

### Response
#### Success Response (200)
- **status** (boolean) - Success status
- **message** (string) - Availability message

#### Response Example
{
  "status": true,
  "message": "Slug is available"
}
```

--------------------------------

### Create Storefront

Source: https://paystack.com/docs/api/storefront

Creates a new digital shop. Requires a unique slug and authorization header.

```bash
#!/bin/sh
url="https://api.paystack.co/storefront"
authorization="Authorization: Bearer YOUR_SECRET_KEY"
content_type="Content-Type: application/json"
data='{ 
  "name": "My Storefront",
  "slug": "my-storefront",
  "description": "A description of my storefront"
}'

curl "$url" -H "$authorization" -H "$content_type" -d "$data" -X POST
```

```json
{
  "status": true,
  "message": "Storefront created",
  "data": {
    "id": 1559046,
    "name": "My Storefront",
    "slug": "my-storefront",
    "description": "A description of my storefront",
    "status": "inactive",
    "currency": "NGN",
    "createdAt": "2024-11-01T12:00:00.000Z",
    "updatedAt": "2024-11-01T12:00:00.000Z"
  }
}
```

--------------------------------

### GET /transferrecipient/:id_or_code

Source: https://paystack.com/docs/api/transfer-recipient

Fetch the details of a specific transfer recipient.

```APIDOC
## GET /transferrecipient/:id_or_code

### Description
Fetch the details of a transfer recipient.

### Method
GET

### Endpoint
https://api.paystack.co/transferrecipient/:id_or_code

### Parameters
#### Path Parameters
- **id_or_code** (String) - Required - An ID or code for the recipient.

### Response
#### Success Response (200)
- **status** (boolean) - Request status
- **data** (object) - Recipient details

#### Response Example
{
  "status": true,
  "message": "Recipient retrieved",
  "data": {}
}
```