paystack-ruby 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 20dd26b874ff452a577606c377865c231718eed6eb4b79fc7aa0baae84756384
+  data.tar.gz: d9fbffe98368c82182dbe69dcd1219ecf48b7767346688edb06e03477a852cd2
+SHA512:
+  metadata.gz: e486673d6965ce49c39a76f8f04d3900b436ab14a64856909be06580963dfb619b7a036ea1efcd5b799ec134aec7551006a4fe6ccff3a751995f4e8f8393871d
+  data.tar.gz: f3c628cc339cd55e06e90423ab4d00fcde5c05817e56e7aa92e50b30f5699a898b7f9328d3ed8f608674e9d100f9b6640328438b5d2356859b2bb16dfa3dcc71

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.1

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2026-06-16
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 andrew-paystack
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,153 @@
+# Paystack Ruby SDK
+
+> The official Ruby SDK for the Paystack API — generated from the Paystack OpenAPI specification.
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Ruby ≥ 3.1](https://img.shields.io/badge/ruby-%3E%3D3.1-red)](https://www.ruby-lang.org)
+
+---
+
+## Requirements
+
+- **Ruby 3.1 or later**
+- Standard library HTTP stack (`net/http`) — no extra runtime HTTP dependency
+
+---
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "paystack-ruby"
+```
+
+Then execute:
+
+```bash
+bundle install
+```
+
+Or install directly:
+
+```bash
+gem install paystack-ruby
+```
+
+---
+
+## Quick Start
+
+```ruby
+require "paystack"
+
+paystack = Paystack::Client.new(ENV.fetch("PAYSTACK_SECRET_KEY"))
+
+result = paystack.transaction.initialize(
+  {
+    email: "customer@example.com",
+    amount: 100_000 # kobo
+  }
+)
+
+puts result.data[:authorization_url]
+```
+
+---
+
+## Configuration
+
+Initialize `Paystack::Client` with your secret key:
+
+```ruby
+paystack = Paystack::Client.new("sk_live_xxxxxxxxxxxx")
+```
+
+| Option | Type | Required | Default |
+|---|---|---|---|
+| `api_key` | `String` | ✅ | — |
+
+---
+
+## Response Shape
+
+All resource methods return a `Paystack::Response` object exposing:
+
+```ruby
+response.http_status # Integer
+response.status      # Boolean
+response.message     # String
+response.data        # Hash / Array / nil
+response.meta        # Hash / nil
+```
+
+---
+
+## Error Handling
+
+API failures raise typed exceptions:
+
+```ruby
+begin
+  paystack.transaction.initialize({ email: "customer@example.com", amount: 100_000 })
+rescue Paystack::AuthenticationError,
+       Paystack::ValidationError,
+       Paystack::NotFoundError,
+       Paystack::RateLimitError,
+       Paystack::ServerError => e
+  puts e.message
+  puts e.http_status
+end
+```
+
+---
+
+## API Reference
+
+The SDK exposes one method per API resource on the `Paystack::Client` instance.
+
+| Resource | Property | Description | Methods |
+|---|---|---|---|
+| [ApplePay](./docs/apple_pay.md) | `paystack.apple_pay` | A collection of endpoints for managing application's top-level domain or subdomain accepting payment via Apple Pay | 3 |
+| [Balance](./docs/balance.md) | `paystack.balance` | A collection of endpoints gaining insights into the amount on an integration | 2 |
+| [Bank](./docs/bank.md) | `paystack.bank` | A collection of endpoints for managing bank details | 3 |
+| [BulkCharge](./docs/bulk_charge.md) | `paystack.bulk_charge` | A collection of endpoints for creating and managing multiple recurring payments | 6 |
+| [Charge](./docs/charge.md) | `paystack.charge` | A collection of endpoints for configuring and managing the payment channels when initiating a payment | 7 |
+| [Customer](./docs/customer.md) | `paystack.customer` | A collection of endpoints for creating and managing customers on an integration | 12 |
+| [DedicatedVirtualAccount](./docs/dedicated_virtual_account.md) | `paystack.dedicated_virtual_account` | A collection of endpoints for creating and managing payment accounts for customers | 9 |
+| [DirectDebit](./docs/direct_debit.md) | `paystack.direct_debit` | A collection of endpoints for managing Direct Debit | 2 |
+| [Dispute](./docs/dispute.md) | `paystack.dispute` | A collection of endpoints for managing transactions complaint made by customers | 8 |
+| [Integration](./docs/integration.md) | `paystack.integration` | A collection of endpoints for managing some settings on an integration | 2 |
+| [Miscellaneous](./docs/miscellaneous.md) | `paystack.miscellaneous` | A collection of endpoints that provides utility functions | 3 |
+| [Order](./docs/order.md) | `paystack.order` | A collection of endpoints for creating and managing orders | 5 |
+| [Page](./docs/page.md) | `paystack.page` | A collection of endpoints for creating and managing links for the collection of payment for products | 6 |
+| [PaymentRequest](./docs/payment_request.md) | `paystack.payment_request` | A collection of endpoints for managing invoices for the payment of goods and services | 9 |
+| [Plan](./docs/plan.md) | `paystack.plan` | A collection of endpoints for creating and managing recurring payment configuration | 4 |
+| [Product](./docs/product.md) | `paystack.product` | A collection of endpoints for creating and managing inventories | 5 |
+| [Refund](./docs/refund.md) | `paystack.refund` | A collection of endpoints for creating and managing transaction reimbursement | 4 |
+| [Settlement](./docs/settlement.md) | `paystack.settlement` | A collection of endpoints for gaining insights into payouts | 2 |
+| [Split](./docs/split.md) | `paystack.split` | A collection of endpoints for spliting a transaction and managing the splits | 6 |
+| [Storefront](./docs/storefront.md) | `paystack.storefront` | A collection of endpoints for creating and managing storefronts | 11 |
+| [Subaccount](./docs/subaccount.md) | `paystack.subaccount` | A collection of endpoints for creating and managing accounts for sharing a transaction with | 4 |
+| [Subscription](./docs/subscription.md) | `paystack.subscription` | A collection of endpoints for creating and managing recurring payments | 7 |
+| [Terminal](./docs/terminal.md) | `paystack.terminal` | A collection of endpoints for building delightful in-person payment experiences | 8 |
+| [Transaction](./docs/transaction.md) | `paystack.transaction` | A collection of endpoints for managing payments | 9 |
+| [Transfer](./docs/transfer.md) | `paystack.transfer` | A collection of endpoints for automating sending money to beneficiaries | 11 |
+| [TransferRecipient](./docs/transfer_recipient.md) | `paystack.transfer_recipient` | A collection of endpoints for creating and managing beneficiaries that you send money to | 6 |
+| [VirtualTerminal](./docs/virtual_terminal.md) | `paystack.virtual_terminal` | A collection of endpoints for building in-person payments without a physical terminal | 9 |
+
+Detailed method-level documentation for each resource is available in [`docs/`](./docs/).
+
+---
+
+## Contributing
+
+> ⚠️ **This SDK is auto-generated** from the Paystack OpenAPI specification. Regenerate instead of manually editing generated files.
+
+To request endpoint/schema changes, open an issue or pull request against the [Paystack OpenAPI specification](https://github.com/PaystackOSS/openapi).
+
+---
+
+## License
+
+MIT © Paystack

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+task default: %i[test]

data/docs/apple_pay.md

@@ -0,0 +1,60 @@
+# ApplePay
+
+A collection of endpoints for managing application's top-level domain or subdomain accepting payment via Apple Pay
+
+## Methods
+
+| Method | HTTP | Path | Summary |
+|---|---|---|---|
+| `list_domain` | `GET` | `/apple-pay/domain` | List Domains |
+| `register_domain` | `POST` | `/apple-pay/domain` | Register Domain |
+| `unregister_domain` | `DELETE` | `/apple-pay/domain` | Unregister Domain |
+
+---
+
+## `list_domain`
+
+**HTTP:** `GET`  
+**Path:** `/apple-pay/domain`
+
+```ruby
+paystack.apple_pay.list_domain({ ... })
+```
+
+### Query Fields
+
+| Name | Required |
+|---|---|
+| `use_cursor` | false |
+| `next` | false |
+| `previous` | false |
+
+## `register_domain`
+
+**HTTP:** `POST`  
+**Path:** `/apple-pay/domain`
+
+```ruby
+paystack.apple_pay.register_domain({ ... })
+```
+
+### Body Fields
+
+| Name | Required |
+|---|---|
+| `domainName` | true |
+
+## `unregister_domain`
+
+**HTTP:** `DELETE`  
+**Path:** `/apple-pay/domain`
+
+```ruby
+paystack.apple_pay.unregister_domain({ ... })
+```
+
+### Body Fields
+
+| Name | Required |
+|---|---|
+| `domainName` | true |

data/docs/balance.md

@@ -0,0 +1,39 @@
+# Balance
+
+A collection of endpoints gaining insights into the amount on an integration
+
+## Methods
+
+| Method | HTTP | Path | Summary |
+|---|---|---|---|
+| `fetch` | `GET` | `/balance` | Fetch Balance |
+| `ledger` | `GET` | `/balance/ledger` | Balance Ledger |
+
+---
+
+## `fetch`
+
+**HTTP:** `GET`  
+**Path:** `/balance`
+
+```ruby
+paystack.balance.fetch
+```
+
+## `ledger`
+
+**HTTP:** `GET`  
+**Path:** `/balance/ledger`
+
+```ruby
+paystack.balance.ledger({ ... })
+```
+
+### Query Fields
+
+| Name | Required |
+|---|---|
+| `perPage` | false |
+| `page` | false |
+| `from` | false |
+| `to` | false |

data/docs/bank.md

@@ -0,0 +1,77 @@
+# Bank
+
+A collection of endpoints for managing bank details
+
+## Methods
+
+| Method | HTTP | Path | Summary |
+|---|---|---|---|
+| `list` | `GET` | `/bank` | List Banks |
+| `resolve_account_number` | `GET` | `/bank/resolve` | Resolve Account Number |
+| `validate_account_number` | `POST` | `/bank/validate` | Validate Bank Account |
+
+---
+
+## `list`
+
+**HTTP:** `GET`  
+**Path:** `/bank`
+
+```ruby
+paystack.bank.list({ ... })
+```
+
+### Query Fields
+
+| Name | Required |
+|---|---|
+| `country` | false |
+| `currency` | false |
+| `use_cursor` | false |
+| `perPage` | false |
+| `page` | false |
+| `next` | false |
+| `previous` | false |
+| `pay_with_bank_transfer` | false |
+| `pay_with_bank` | false |
+| `enabled_for_verification` | false |
+| `gateway` | false |
+| `type` | false |
+| `include_nip_sort_code` | false |
+
+## `resolve_account_number`
+
+**HTTP:** `GET`  
+**Path:** `/bank/resolve`
+
+```ruby
+paystack.bank.resolve_account_number({ ... })
+```
+
+### Query Fields
+
+| Name | Required |
+|---|---|
+| `account_number` | false |
+| `bank_code` | false |
+
+## `validate_account_number`
+
+**HTTP:** `POST`  
+**Path:** `/bank/validate`
+
+```ruby
+paystack.bank.validate_account_number({ ... })
+```
+
+### Body Fields
+
+| Name | Required |
+|---|---|
+| `account_name` | true |
+| `account_number` | true |
+| `account_type` | true |
+| `bank_code` | true |
+| `country_code` | true |
+| `document_type` | true |
+| `document_number` | false |

data/docs/bulk_charge.md

@@ -0,0 +1,110 @@
+# BulkCharge
+
+A collection of endpoints for creating and managing multiple recurring payments
+
+## Methods
+
+| Method | HTTP | Path | Summary |
+|---|---|---|---|
+| `charges` | `GET` | `/bulkcharge/{code}/charges` | List Charges in a Batch |
+| `fetch` | `GET` | `/bulkcharge/{code}` | Fetch Bulk Charge Batch |
+| `initiate` | `POST` | `/bulkcharge` | Initiate Bulk Charge |
+| `list` | `GET` | `/bulkcharge` | List Bulk Charge Batches |
+| `pause` | `GET` | `/bulkcharge/pause/{code}` | Pause Bulk Charge Batch |
+| `resume` | `GET` | `/bulkcharge/resume/{code}` | Resume Bulk Charge Batch |
+
+---
+
+## `charges`
+
+**HTTP:** `GET`  
+**Path:** `/bulkcharge/{code}/charges`
+
+```ruby
+paystack.bulk_charge.charges(code, { ... })
+```
+
+### Path Parameters
+
+| Name | Required |
+|---|---|
+| `code` | true |
+
+### Query Fields
+
+| Name | Required |
+|---|---|
+| `perPage` | false |
+| `page` | false |
+| `status` | false |
+
+## `fetch`
+
+**HTTP:** `GET`  
+**Path:** `/bulkcharge/{code}`
+
+```ruby
+paystack.bulk_charge.fetch(code)
+```
+
+### Path Parameters
+
+| Name | Required |
+|---|---|
+| `code` | true |
+
+## `initiate`
+
+**HTTP:** `POST`  
+**Path:** `/bulkcharge`
+
+```ruby
+paystack.bulk_charge.initiate({ ... })
+```
+
+## `list`
+
+**HTTP:** `GET`  
+**Path:** `/bulkcharge`
+
+```ruby
+paystack.bulk_charge.list({ ... })
+```
+
+### Query Fields
+
+| Name | Required |
+|---|---|
+| `perPage` | false |
+| `page` | false |
+| `status` | false |
+
+## `pause`
+
+**HTTP:** `GET`  
+**Path:** `/bulkcharge/pause/{code}`
+
+```ruby
+paystack.bulk_charge.pause(code)
+```
+
+### Path Parameters
+
+| Name | Required |
+|---|---|
+| `code` | true |
+
+## `resume`
+
+**HTTP:** `GET`  
+**Path:** `/bulkcharge/resume/{code}`
+
+```ruby
+paystack.bulk_charge.resume(code)
+```
+
+### Path Parameters
+
+| Name | Required |
+|---|---|
+| `code` | true |