Paystack

https://paystack.com/docs
Admin
Paystack is a payment platform that enables businesses to accept payments from cards, bank accounts,...
Tokens:384,784
Snippets:2,055
Trust Score:9.5
Update:1 week ago
Show doc for...
Tokens:
Raw
### Navigate and start React app

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

Changes into the app directory and starts the development server with yarn start.

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

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

### Install react-paystack with yarn

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

Install the react-paystack library using yarn add.

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

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

### Sample Response for List Bulk Charge Batches

Source: https://paystack.com/docs/api/bulk-charge

Example 200 OK response from GET /bulkcharge, showing a list of batches with metadata including total, skipped, perPage, page, and pageCount.

```json
{
  "status": true,
  "message": "Bulk charges retrieved",
  "data": [
    {
      "domain": "test",
      "batch_code": "BCH_1nV4L1D7cayggh",
      "status": "complete",
      "id": 1733,
      "createdAt": "2017-02-04T05:44:19.000Z",
      "updatedAt": "2017-02-04T05:45:02.000Z"
    }
  ],
  "meta": {
    "total": 1,
    "skipped": 0,
    "perPage": 50,
    "page": 1,
    "pageCount": 1
  }
}
```

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

### Sample Response: Get Upload URL

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

Example 200 OK response from GET /dispute/:id/upload_url. Contains a signedUrl for uploading the file and the generated fileName.

```json
{
  "status": true,
  "message": "Upload url generated",
  "data": {
    "signedUrl": "https://s3.eu-west-1.amazonaws.com/files.paystack.co/qesp8a4df1xejihd9x5q?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAI7CL5IZL2DJHOPPA%2F20191009%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20191009T220931Z&X-Amz-Expires=1800&X-Amz-Signature=f5cc387949f3520982886e70ab2e08721a82a9fa9e26b696b91471f36453867a&X-Amz-SignedHeaders=host",
    "fileName": "qesp8a4df1xejihd9x5q"
  }
}
```

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

### Sample Response: Initialize Authorization (200 Ok)

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

Example successful response from the authorization initialize endpoint, containing the redirect URL, access code, and reference.

```json
{
  "status": true,
  "message": "Authorization initialized",
  "data": {
    "redirect_url": "https://checkout.paystack.com/82t4mp5b5mfn51h",
    "access_code": "82t4mp5b5mfn51h",
    "reference": "dfbzfotsrbv4n5s82t4mp5b5mfn51h"
  }
}
```

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

### Sample response for listing plans

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

Example 200 OK response showing a list of plans with subscription details, plan metadata, and pagination info.

```json
{
  "status": true,
  "message": "Plans retrieved",
  "data": [
    {
      "subscriptions": [
        {
          "customer": 63,
          "plan": 27,
          "integration": 100032,
          "domain": "test",
          "start": 1458505748,
          "status": "complete",
          "quantity": 1,
          "amount": 100000,
          "subscription_code": "SUB_birvokwpp0sftun",
          "email_token": "9y62mxp4uh25das",
          "authorization": {
            "authorization_code": "AUTH_6tmt288t0o",
            "bin": "408408",
            "last4": "4081",
            "exp_month": "12",
            "exp_year": "2020",
            "channel": "card",
            "card_type": "visa visa",
            "bank": "TEST BANK",
            "country_code": "NG",
            "brand": "visa",
            "reusable": true,
            "signature": "SIG_uSYN4fv1adlAuoij8QXh",
            "account_name": "BoJack Horseman"
          },
          "easy_cron_id": null,
          "cron_expression": "0 0 * * 0",
          "next_payment_date": "2016-03-27T07:00:00.000Z",
          "open_invoice": null,
          "id": 8,
          "createdAt": "2016-03-20T20:29:08.000Z",
          "updatedAt": "2016-03-22T16:23:52.000Z"
        }
      ],
      "integration": 100032,
      "domain": "test",
      "name": "Satin Flower",
      "plan_code": "PLN_lkozbpsoyd4je9t",
      "description": null,
      "amount": 100000,
      "interval": "weekly",
      "send_invoices": true,
      "send_sms": true,
      "hosted_page": false,
      "hosted_page_url": null,
      "hosted_page_summary": null,
      "currency": "NGN",
      "id": 27,
      "createdAt": "2016-03-21T02:44:14.000Z",
      "updatedAt": "2016-03-21T02:44:14.000Z"
    },
    {
      "subscriptions": [],
      "integration": 100032,
      "domain": "test",
      "name": "Monthly retainer",
      "plan_code": "PLN_gx2wn530m0i3w3m",
      "description": null,
      "amount": 50000,
      "interval": "monthly",
      "send_invoices": true,
      "send_sms": true,
      "hosted_page": false,
      "hosted_page_url": null,
      "hosted_page_summary": null,
      "currency": "NGN",
      "id": 28,
      "createdAt": "2016-03-29T22:42:50.000Z",
      "updatedAt": "2016-03-29T22:42:50.000Z"
    }
  ],
  "meta": {
    "total": 2,
    "skipped": 0,
    "perPage": 50,
    "page": 1,
    "pageCount": 1
  }
}
```

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

### Sample response for listing transfers

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

Example 200 OK response from the GET /transfer endpoint. Shows the structure of the returned data, including transfer and recipient details.

```json
{
  "status": true,
  "message": "Transfers retrieved",
  "data": [
    {
      "integration": 100073,
      "recipient": {
        "domain": "test",
        "type": "nuban",
        "currency": "NGN",
        "name": "Flesh",
        "details": {
          "account_number": "olounje",
          "account_name": null,
          "bank_code": "044",
          "bank_name": "Access Bank"
        },
        "description": "Eater",
        "metadata": null,
        "recipient_code": "RCP_2x5j67tnnw1t98k",
        "active": true,
        "id": 28,
        "integration": 100073,
        "createdAt": "2017-02-02T19:39:04.000Z",
        "updatedAt": "2017-02-02T19:39:04.000Z"
      },
      "domain": "test",
      "amount": 4400,
      "currency": "NGN",
      "source": "balance",
      "source_details": null,
      "reason": "Eater",
      "status": "otp",
      "failures": null,
      "transfer_code": "TRF_1ptvuv321ahaa7q",
      "id": 14,
      "createdAt": "2017-02-03T17:21:54.000Z",
      "updatedAt": "2017-02-03T17:21:54.000Z"
    },
    {
      "integration": 100073,
      "recipient": {
        "domain": "test",
        "type": "nuban",
        "currency": "USD",
        "name": "FleshUSD",
        "details": {
          "account_number": "1111111111",
          "account_name": null,
          "bank_code": "044",
          "bank_name": "Access Bank"
        },
        "description": "EaterUSD",
        "metadata": null,
        "recipient_code": "RCP_bi84k5gguakuqmg",
        "active": true,
        "id": 22,
        "integration": 100073,
        "createdAt": "2017-01-23T16:52:48.000Z",
        "updatedAt": "2017-01-23T16:52:48.000Z"
      },
      "domain": "test",
      "amount": 3300,
      "currency": "NGN",
      "source": "balance",
      "source_details": null,
      "reason": "I love you",
      "status": "otp",
      "failures": null,
      "transfer_code": "TRF_5pr8ypzb0htx0cn",
      "id": 13,
      "createdAt": "2017-01-23T16:55:59.000Z",
      "updatedAt": "2017-01-23T16:55:59.000Z"
    }
  ],
  "meta": {
    "total": 2,
    "skipped": 0,
    "perPage": 50,
    "page": 1,
    "pageCount": 1
  }
}
```

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

### Sample Response for Create Subscription

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

Example 200 OK response showing a successfully created subscription with customer, plan, authorization, and subscription code.

```json
{
  "status": true,
  "message": "Subscription successfully created",
  "data": {
    "customer": 1173,
    "plan": 28,
    "integration": 100032,
    "domain": "test",
    "start": 1459296064,
    "status": "active",
    "quantity": 1,
    "amount": 50000,
    "authorization": {
      "authorization_code": "AUTH_6tmt288t0o",
      "bin": "408408",
      "last4": "4081",
      "exp_month": "12",
      "exp_year": "2020",
      "channel": "card",
      "card_type": "visa visa",
      "bank": "TEST BANK",
      "country_code": "NG",
      "brand": "visa",
      "reusable": true,
      "signature": "SIG_uSYN4fv1adlAuoij8QXh",
      "account_name": "BoJack Horseman"
    },
    "subscription_code": "SUB_vsyqdmlzble3uii",
    "email_token": "d7gofp6yppn3qz7",
    "id": 9,
    "createdAt": "2016-03-30T00:01:04.687Z",
    "updatedAt": "2016-03-30T00:01:04.687Z"
  }
}
```

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

### Sample Response: Get Transaction Totals

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

Example 200 OK response for the transaction totals endpoint, showing total transactions, volume, and pending transfers by currency.

```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
      }
    ]
  }
}

```

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

### Create Storefront Sample Response

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

Example 200 OK response for creating a storefront. Shows the created storefront object with status 'inactive' and currency 'NGN'.

```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"
  }
}
```

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

### List Storefront Products - Sample Response

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

Example 200 OK response for listing storefront products, showing a success status, message, product data array, and pagination metadata.

```json
{
  "status": true,
  "message": "Products retrieved",
  "data": [
    {
      "id": 2196244,
      "name": "Sample Product",
      "description": "A sample product",
      "price": 10000,
      "currency": "NGN",
      "active": true
    }
  ],
  "meta": {
    "total": 1,
    "skipped": 0,
    "perPage": 50,
    "page": 1,
    "pageCount": 1
  }
}
```

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

### Add Products to Storefront - Sample Response

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

Example 200 OK response for adding products to a storefront, showing a success status and message.

```json
{
  "status": true,
  "message": "Products added to storefront"
}
```

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

### Install vue-paystack with npm

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

Install the vue-paystack package, which includes the Paystack Inline JS library and checkout component.

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

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

### GET /directdebit/mandate-authorizations

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

Get the list of direct debit mandates on your integration. This endpoint supports pagination and filtering by status.

```APIDOC
## GET /directdebit/mandate-authorizations

### Description
Get the list of direct debit mandates on your integration.

### Method
GET

### Endpoint
/directdebit/mandate-authorizations

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

### Query Parameters
- **cursor** (String) - Optional - The cursor value of the next set of authorizations to fetch. You can get this from the meta object of the response.
- **status** (String) - Optional - Filter by the authorization status. Accepted values are: `pending`, `active`, `revoked`.
- **per_page** (Integer) - Optional - The number of authorizations to fetch per request.

### Request Example
```
curl "https://api.paystack.co/directdebit/mandate-authorizations" \
-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.
- **data** (array) - List of mandate authorizations. Each item contains:
  - **id** (integer) - Authorization ID.
  - **status** (string) - Status of the authorization.
  - **mandate_id** (integer) - Mandate ID.
  - **authorization_id** (integer) - Authorization ID.
  - **authorization_code** (string) - Authorization code.
  - **integration_id** (integer) - Integration ID.
  - **account_number** (string) - Customer's account number.
  - **bank_code** (string) - Bank code.
  - **bank_name** (string) - Bank name.
  - **customer** (object) - Customer details (id, customer_code, email, first_name, last_name).
  - **authorized_at** (string) - Date and time of authorization.
- **meta** (object) - Pagination metadata (per_page, next, count, total).

#### Response Example
```
{
  "status": true,
  "message": "Mandate authorizations retrieved successfully",
  "data": [
    {
      "id": 112244,
      "status": "active",
      "mandate_id": 1560169,
      "authorization_id": 1069309917,
      "authorization_code": "AUTH_lEt8QgrSfW",
      "integration_id": 463433,
      "account_number": "0123456789",
      "bank_code": "058",
      "bank_name": "Guaranty Trust Bank",
      "customer": {
        "id": 28958104,
        "customer_code": "CUS_5kye9bc41uw15pb",
        "email": "customer@email.com",
        "first_name": "Booker",
        "last_name": "Jones"
      },
      "authorized_at": "2025-06-23T12:47:10.632Z"
    }
  ],
  "meta": {
    "per_page": 10,
    "next": "MTI1OTc=",
    "count": 10,
    "total": 40
  }
}
```
```

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

### Sample response: 200 OK

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

Example JSON response with status true and a list of preauthorizations. Shows fields like status, reference, amount, currency, authorization, and customer details.

```json
{
  "status": true,
  "message": "Preauthorizations retrieved",
  "data": [
    {
      "domain": "test",
      "status": "expired",
      "reference": "ctbaq5z6fkzsk2f",
      "amount": 1200,
      "created_at": "2023-08-21T06:30:31.000Z",
      "transaction_id": null,
      "captured_at": null,
      "released_at": null,
      "currency": "ZAR",
      "fees": 0,
      "authorization": {
        "authorization_code": "AUTH_qpbtw9k1kp",
        "bin": "408408",
        "last4": "4081",
        "exp_month": "12",
        "exp_year": "2030",
        "channel": "card",
        "card_type": "visa credit",
        "bank": "Test Bank",
        "country_code": "ZA",
        "brand": "visa",
        "reusable": true,
        "signature": "SIG_uUpNoxVEiErLme0Lo0e6",
        "account_name": null
      },
      "customer": {
        "id": 180063193,
        "first_name": null,
        "last_name": null,
        "email": "test@example.com",
        "customer_code": "CUS_zi5os4fs31qxao0",
        "phone": null,
        "metadata": null,
        "risk_action": "default",
        "international_format_phone": null
      },
      "id": 10321309
    },
    {
      "domain": "test",
      "status": "captured",
      "reference": "adoiasdiruvme",
      "amount": 500,
      "created_at": "2025-01-08T10:51:24.000Z",
      "transaction_id": 4563444462,
      "captured_at": "2025-01-08T10:53:31.000Z",
      "released_at": null,
      "currency": "ZAR",
      "fees": 115,
      "authorization": {
        "authorization_code": "AUTH_3nbm4tww49",
        "bin": "408408",
        "last4": "4081",
        "exp_month": "12",
        "exp_year": "2030",
        "channel": "card",
        "card_type": "visa credit",
        "bank": "Test Bank",
        "country_code": "ZA",
        "brand": "visa",
        "reusable": true,
        "signature": "SIG_uUpNoxVEiErLme0Lo0e6",
        "account_name": null
      },
      "customer": {
        "id": 226230427,
        "first_name": null,
        "last_name": null,
        "email": "chonky@example.com",
        "customer_code": "CUS_6bklfq9zapdbdpp",
        "phone": null,
        "metadata": null,
        "risk_action": "default",
        "international_format_phone": null
      },
      "id": 153028
    },
    {
      "domain": "test",
      "status": "released",
      "reference": "abcoeii-123adoi",
      "amount": 8888,
      "created_at": "2025-01-08T12:48:02.000Z",
      "transaction_id": null,
      "captured_at": null,
      "released_at": "2025-01-08T13:21:35.000Z",
      "currency": "ZAR",
      "fees": 115,
      "customer": {
        "id": 226271601,
        "first_name": null,
        "last_name": null,
        "email": "test@example.com",
        "customer_code": "CUS_l3hkvdfhxaxdad",
        "phone": null,
        "metadata": null,
        "risk_action": "default",
        "international_format_phone": null
      },
      "id": 53041032
    }
  ],
  "meta": {
    "total": 1,
    "skipped": 0,
    "perPage": 50,
    "page": 1,
    "pageCount": 1
  }
}
```

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

### GET /bank

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

Get a list of all supported banks and their properties. This endpoint supports various query parameters for filtering and pagination.

```APIDOC
## GET /bank

### Description
Get a list of all supported banks and their properties.

### Method
GET

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

### Parameters
#### Query Parameters
- **country** (String) - Optional - The country from which to obtain the list of supported banks. Accepted values are: `ghana`, `kenya`, `nigeria`, `south africa`
- **use_cursor** (boolean) - Optional - Flag to enable cursor pagination on the endpoint
- **perPage** (Integer) - Optional - The number of objects to return per page. Defaults to 50, and limited to 100 records per page.
- **pay_with_bank_transfer** (Boolean) - Optional - A flag to filter for available banks a customer can make a transfer to complete a payment
- **pay_with_bank** (Boolean) - Optional - A flag to filter for banks a customer can pay directly from
- **enabled_for_verification** (Boolean) - Optional - A flag to filter the banks that are supported for account verification in South Africa. You need to combine this with either the `currency` or `country` filter.
- **next** (String) - Optional - A cursor that indicates your place in the list. It can be used to fetch the next page of the list
- **previous** (String) - Optional - A cursor that indicates your place in the list. It should be used to fetch the previous page of the list after an intial next request
- **gateway** (String) - Optional - The gateway type of the bank. It can be one of these: [emandate, digitalbankmandate]
- **type** (String) - Optional - Type of financial channel. For Ghanaian channels, please use either **mobile_money** for mobile money channels OR **ghipss** for bank channels
- **currency** (String) - Optional - One of the supported currency
- **include_nip_sort_code** (Boolean) - Optional - A flag that returns Nigerian banks with their `nip institution code`. The returned value can be used in identifying institutions on NIP.

### Request Example
```sh
curl "https://api.paystack.co/bank" -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.
- **data** (array) - List of bank objects.
  - **name** (string) - Name of the bank.
  - **slug** (string) - Slug identifier for the bank.
  - **code** (string) - Bank code.
  - **longcode** (string) - Long code for the bank.
  - **gateway** (string|null) - Gateway type.
  - **pay_with_bank** (boolean) - Whether the bank supports pay with bank.
  - **active** (boolean) - Whether the bank is active.
  - **is_deleted** (boolean) - Whether the bank is deleted.
  - **country** (string) - Country of the bank.
  - **currency** (string) - Currency of the bank.
  - **type** (string) - Type of financial channel.
  - **id** (integer) - Unique identifier.
  - **createdAt** (string) - Creation timestamp.
  - **updatedAt** (string) - Last update timestamp.
- **meta** (object) - Pagination metadata.
  - **next** (string|null) - Cursor for next page.
  - **previous** (string|null) - Cursor for previous page.
  - **perPage** (integer) - Number of items per page.

#### Response Example
```json
{
  "status": true,
  "message": "Banks retrieved",
  "data": [
    {
      "name": "Abbey Mortgage Bank",
      "slug": "abbey-mortgage-bank",
      "code": "801",
      "longcode": "",
      "gateway": null,
      "pay_with_bank": false,
      "active": true,
      "is_deleted": false,
      "country": "Nigeria",
      "currency": "NGN",
      "type": "nuban",
      "id": 174,
      "createdAt": "2020-12-07T16:19:09.000Z",
      "updatedAt": "2020-12-07T16:19:19.000Z"
    }
  ],
  "meta": {
    "next": "YmFuazoxNjk=",
    "previous": null,
    "perPage": 5
  }
}
```
```

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

### Enable Subscription Sample Response

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

Example 200 OK response from the enable subscription endpoint, indicating the subscription was enabled successfully.

```json
{
  "status": true,
  "message": "Subscription enabled successfully"
}
```

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

### GET /bank

Source: https://paystack.com/docs/payments/payment-channels

Fetches the list of supported banks for the Pay with Bank feature. Use the pay_with_bank=true filter to get only banks that support this payment method.

```APIDOC
## GET /bank

### Description
Fetches the list of supported banks for the Pay with Bank feature. Use the pay_with_bank=true filter to get only banks that support this payment method.

### Method
GET

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

### Parameters
#### Query Parameters
- **pay_with_bank** (boolean) - Required - Set to `true` to filter banks that support the Pay with Bank feature.

### Response
#### Success Response (200)
- **status** (boolean) - Indicates if the request was successful.
- **message** (string) - Response message.
- **data** (array) - List of banks, each containing bank details such as `code` and `name`.

#### Response Example
{
  "status": true,
  "message": "Banks retrieved",
  "data": [
    {
      "name": "Access Bank",
      "code": "044"
    }
  ]
}
```

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

### Sample Response: List Dedicated Virtual Accounts

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

Example 200 OK response showing a list of dedicated virtual accounts with customer, bank, and split configuration details.

```json
{
  "status": true,
  "message": "Managed accounts successfully retrieved",
  "data": [
    {
      "customer": {
        "id": 1530104,
        "first_name": "yinka",
        "last_name": "Ojo",
        "email": "hello@company.co",
        "customer_code": "CUS_dy1r7ts03zixbq5",
        "phone": "08154239386",
        "risk_action": "default",
        "international_format_phone": null
      },
      "bank": {
        "name": "Paystack-Titan",
        "id": 629,
        "slug": "titan-paystack"
      },
      "id": 173,
      "account_name": "KAROKART/A YINKA",
      "account_number": "9930020212",
      "created_at": "2019-12-09T13:31:38.000Z",
      "updated_at": "2020-06-11T14:04:28.000Z",
      "currency": "NGN",
      "split_config": {
        "subaccount": "ACCT_xdrne0tcvr5jkei"
      },
      "active": true,
      "assigned": true
    }
  ],
  "meta": {
    "total": 1,
    "skipped": 0,
    "perPage": 50,
    "page": 1,
    "pageCount": 1
  }
}
```

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

### GET /decision/bin/:bin

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

Resolves a card BIN to get more information about a customer's card. The BIN is the first 6 characters of the card number.

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

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

### Method
GET

### Endpoint
https://api.paystack.co/decision/bin/:bin

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

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

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

### Response
#### Success Response (200)
- **status** (boolean) - Indicates if the request was successful
- **message** (string) - Response message
- **data** (object) - Contains card information
  - **bin** (string) - The BIN
  - **brand** (string) - Card brand
  - **sub_brand** (string) - Card sub-brand
  - **country_code** (string) - Country code
  - **country_name** (string) - Country name
  - **card_type** (string) - Card type
  - **bank** (string) - Bank name
  - **linked_bank_id** (integer) - Linked bank ID

#### Response Example
```json
{
  "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() Method Usage

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

Example of calling initialize with a public key and logging enabled. Handles PlatformException for errors.

```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!);
}
```

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

### POST /integration/webhooks/events/resend-matching

Source: https://paystack.com/docs/api/webhook-events

Documentation for the Resend Matching Events endpoint, including headers, query parameters, body parameters, request example, and response examples.

```APIDOC
## POST /integration/webhooks/events/resend-matching

### Description
Resend every webhook event matching a filter. Pass `preview=true` first to confirm how many events match before you commit to the resend.

### Method
POST

### Endpoint
`/integration/webhooks/events/resend-matching`

### Headers
- **authorization** (String) - Required - Set value to `Bearer SECRET_KEY`
- **content-type** (String) - Required - Set value to `application/json`

### Query Parameters
- **preview** (Boolean) - Optional - Set to `true` to return the matching count without resending anything

### Body Parameters
- **filters** (Object) - Optional - The same filters accepted by List Webhook Events: `category`, `event_type`, `status`, `category_row_id`, `from`, `to`. All optional

### Request Example
```sh
#!/bin/sh
url="https://api.paystack.co/integration/webhooks/events/resend-matching"
authorization="Authorization: Bearer YOUR_SECRET_KEY"
content_type="Content-Type: application/json"
data='{
  "filters": {
    "status": "Failed",
    "category": "transactions",
    "event_type": "charge.success",
    "from": "2026-07-01",
    "to": "2026-07-09"
  }
}'

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

### Response
#### Success Response (200 Ok, preview=true)
- **status** (Boolean) - Indicates success
- **message** (String) - Description of the response
- **data** (Object) - Contains the count of matching events
  - **count** (Integer) - Number of matching events

#### Response Example
```json
{
  "status": true,
  "message": "Preview",
  "data": {
    "count": 128
  }
}
```

#### Error Responses
- **202 Accepted** - Resend accepted
- **429 Too Many Requests** - Rate limit exceeded
- **500 Internal Server Error** - Server error
```

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

### Sample Response: List Subscriptions

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

Example 200 OK response from the List Subscriptions endpoint. Shows the structure of the returned data, including customer, plan, authorization, and subscription details.

```json
{
  "status": true,
  "message": "Subscriptions retrieved",
  "data": [
    {
      "customer": {
        "first_name": "BoJack",
        "last_name": "Horseman",
        "email": "bojack@horseman.com",
        "phone": "",
        "metadata": null,
        "domain": "test",
        "customer_code": "CUS_hdhye17yj8qd2tx",
        "risk_action": "default",
        "id": 84312,
        "integration": 100073,
        "createdAt": "2016-10-01T10:59:52.000Z",
        "updatedAt": "2016-10-01T10:59:52.000Z"
      },
      "plan": {
        "domain": "test",
        "name": "Weekly small chops",
        "plan_code": "PLN_0as2m9n02cl0kp6",
        "description": "Small chops delivered every week",
        "amount": 27000,
        "interval": "weekly",
        "send_invoices": true,
        "send_sms": true,
        "hosted_page": false,
        "hosted_page_url": null,
        "hosted_page_summary": null,
        "currency": "NGN",
        "migrate": null,
        "id": 1716,
        "integration": 100073,
        "createdAt": "2016-10-01T10:59:11.000Z",
        "updatedAt": "2016-10-01T10:59:11.000Z"
      },
      "integration": 123456,
      "authorization": {
        "authorization_code": "AUTH_6tmt288t0o",
        "bin": "408408",
        "last4": "4081",
        "exp_month": "12",
        "exp_year": "2020",
        "channel": "card",
        "card_type": "visa visa",
        "bank": "TEST BANK",
        "country_code": "NG",
        "brand": "visa",
        "reusable": true,
        "signature": "SIG_uSYN4fv1adlAuoij8QXh",
        "account_name": "BoJack Horseman"
      },
      "domain": "test",
      "start": 1475319599,
      "status": "active",
      "quantity": 1,
      "amount": 27000,
      "subscription_code": "SUB_6phdx225bavuwtb",
      "email_token": "ore84lyuwcv2esu",
      "easy_cron_id": "275226",
      "cron_expression": "0 0 * * 6",
      "next_payment_date": "2016-10-15T00:00:00.000Z",
      "open_invoice": "INV_qc875pkxpxuyodf",
      "id": 4192,
      "createdAt": "2016-10-01T10:59:59.000Z",
      "updatedAt": "2016-10-12T07:45:14.000Z"
    }
  ],
  "meta": {
    "total": 1,
    "skipped": 0,
    "perPage": 50,
    "page": 1,
    "pageCount": 1
  }
}
```

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

### Sample response for listing customers

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

Example 200 OK response showing a list of customer objects with fields like integration, email, customer_code, and pagination metadata.

```json
{
  "status": true,
  "message": "Customers retrieved",
  "data": [
    {
      "integration": 463433,
      "first_name": null,
      "last_name": null,
      "email": "dom@gmail.com",
      "phone": null,
      "metadata": null,
      "domain": "test",
      "customer_code": "CUS_c6wqvwmvwopw4ms",
      "risk_action": "default",
      "id": 90758908,
      "createdAt": "2022-08-15T13:46:39.000Z",
      "updatedAt": "2022-08-15T13:46:39.000Z"
    },
    {
      "integration": 463433,
      "first_name": "Okiki",
      "last_name": "Sample",
      "email": "okiki@sample.com",
      "phone": "09048829123",
      "metadata": {},
      "domain": "test",
      "customer_code": "CUS_rki2ccocw7g8lsj",
      "risk_action": "default",
      "id": 90758301,
      "createdAt": "2022-08-15T13:42:52.000Z",
      "updatedAt": "2022-08-15T13:42:52.000Z"
    },
    {
      "integration": 463433,
      "first_name": "lukman",
      "last_name": "calle",
      "email": "lukman@calle.co",
      "phone": "08922383034",
      "metadata": {},
      "domain": "test",
      "customer_code": "CUS_hpxsz8c1if90quo",
      "risk_action": "default",
      "id": 90747194,
      "createdAt": "2022-08-15T12:31:13.000Z",
      "updatedAt": "2022-08-15T12:31:13.000Z"
    }
  ],
  "meta": {
    "next": "Y3VzdG9tZXI6OTAyMjU4MDk=",
    "previous": null,
    "perPage": 3
  }
}
```

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

### Get Payment Request Totals (cURL)

Source: https://paystack.com/docs/api/payment-request

Retrieves payment request metrics using the GET /paymentrequest/totals endpoint. Requires the authorization header set to 'Bearer YOUR_SECRET_KEY'.

```shell
#!/bin/sh
url="https://api.paystack.co/paymentrequest/totals"
authorization="Authorization: Bearer YOUR_SECRET_KEY"

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

```

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

### Initialize Direct Debit Sample Response (200 OK)

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

Example successful response from the initialize direct debit endpoint, containing a redirect URL, access code, and reference.

```json
{
  "status": true,
  "message": "Authorization initialized",
  "data": {
    "redirect_url": "https://link.paystack.com/ll6b0szngj1f27k",
    "access_code": "ll6b0szngj1f27k",
    "reference": "1er945lpy4txyki"
  }
}

```

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

### Install Vue CLI with npm or yarn

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

Install the Vue CLI globally using either npm or yarn. Choose one method; both are popular for building large-scale Vue applications.

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

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

### Sample Response: Initiate Bulk Transfer (200 OK)

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

Example successful response from initiating a bulk transfer. Shows status true, message '3 transfers queued.', and an array of transfer details with reference, recipient, amount, transfer_code, currency, and status.

```json
{
  "status": true,
  "message": "3 transfers queued.",
  "data": [
    {
      "reference": "acv_2627bbfe-1a2a-4a1a-8d0e-9d2ee6c31496",
      "recipient": "RCP_gd9vgag7n5lr5ix",
      "amount": 20000,
      "transfer_code": "TRF_o0mv5dc2lv4t2wdb",
      "currency": "NGN",
      "status": "success"
    },
    {
      "reference": "acv_1bd0c1f8-78c2-463b-8bd4-ed9eeb36be50",
      "recipient": "RCP_zpk2tgagu6lgb4g",
      "amount": 35000,
      "transfer_code": "TRF_tlvxomz43gjso2py",
      "currency": "NGN",
      "status": "success"
    },
    {
      "reference": "acv_11bebfc3-18b3-40aa-a4df-c55068c93457",
      "recipient": "RCP_dfznnod8rwxlwgn",
      "amount": 15000,
      "transfer_code": "TRF_yt2y2gcd3dmli8av",
      "currency": "NGN",
      "status": "success"
    }
  ]
}
```

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

### Paystack UI chargeUIButton SwiftUI example

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

Paystack UI SwiftUI example that triggers a PaymentSheet using an access_code from the Initialize Transaction API. The onComplete callback handles the transaction result.

```swift
paystack?.chargeUIButton(accessCode: "0peioxfhpn", onComplete: paymentDone) {
  Text("Initiate Payment")
}
```
Tokens:
Raw