haystack

A low-level API client for Paystack

Haystack

Haystack is a low-level API client for Paystack. It features an intuitive interface that maps perfectly to the Paystack API.

Haystack comes with a webhook handler that intercepts events received from Paystack, and allows you to perform actions based on the event type.

Usage Examples

  1. Create client:

    paystack = Haystack.new(secret_key: "secret-key")
    
  2. Create charge:

    paystack.charges.create(
      email: "customer@email.com",
      amount: "20000"
    ) do |response|
      return puts response.message unless response.success?
    
      response.data.try do |transaction|
        puts transaction.transaction_date.try &.second
        puts transaction.subaccount.try &.account_number
        puts transaction.status
        # ...
      end
    end
    
  3. Initialize transaction:

    paystack.transactions.initiate(
      email: "customer@email.com",
      amount: "20000",
      currency: "GHS"
    ) do |response|
      return puts response.message unless response.success?
    
      response.data.try do |authorization|
        puts authorization.access_code
        puts authorization.authorization_url
        puts authorization.reference
      # ...
      end
    end
    
  4. Verify transaction:

    paystack.transactions.verify(reference: "abcdef") do |response|
      return puts response.message unless response.success?
    
      response.data.try do |transaction|
        puts transaction.status
        puts transaction.authorization.try &.authorization_code
        puts transaction.channel
      # ...
      end
    end
    
  5. List invoices:

    paystack.invoices.list(perPage: "20", page: "2") do |response|
      return puts response.message unless response.success?
    
      response.data.try &.each do |invoice|
        puts invoice.archived
        puts invoice.currency
        puts invoice.description
        # ...
      end
    end
    

Documentation

Find the complete documentation in the docs/ directory of this repository.

Development

  1. Copy your test secret key from your Paystack dashboard.

  2. Create a .env.sh file:

    #!/bin/bash
    #
    export PAYSTACK_SECRET_KEY='your-paystack-test-secret-key-here'
    
  3. Update the file with your own details. Then run tests with source .env.sh && crystal spec.

IMPORTANT: Remember to set permissions for your env file to 0600 or stricter: chmod 0600 .env*.

Contributing

  1. Fork it
  2. Switch to the master branch: git checkout master
  3. Create your feature branch: git checkout -b my-new-feature
  4. Make your changes, updating changelog and documentation as appropriate.
  5. Commit your changes: git commit
  6. Push to the branch: git push origin my-new-feature
  7. Submit a new Pull Request against the GrottoPress:master branch.
Owner
github statistic
  • 2
  • 0
  • 0
  • 0
  • 1 day ago
  • July 7, 2021
License

MIT License

Links
Synced at

Sun, 01 Aug 2021 13:00:23 GMT