Crate paystack

Convenient rust bindings and types for the Paystakc HTTP API aiming to support the entire API surface. Not the case? Please open an issue. I update the definitions on a weekly basis.

Documentation

See the Rust API docs or the examples.

Installation

paystack-rs uses the reqwest http client under the hood and the tokio runtime for async operations

    [dependencies]
    paystack-rs = "0.1"

Usage

Initalizing an instance of the Paystack client and creating a transaction.

    use std::env;
    use dotenv::dotenv;
    use paystack::{PaystackClient, TransactionBuilder, PaystackError, Currency};

    #[tokio::main]
    async fn main() -> Result<(), PaystackError>{
        dotenv().ok();
        let api_key = env::var("PAYSTACK_API_KEY").unwrap();
        let client = PaystackClient::new(api_key);

        let body = TransactionBuilder::new()
            .email("email@example.com")
            .amount("200000")
            .currency(Currency::NGN)
            .build()
            .unwrap();

        let transaction = client
            .initialize_transaction(body)
            .await
            .expect("Unable to create transaction");

        Ok(())
    }

Contributing

See CONTRIBUTING.md for information on contributing to paystack-rs.

Licensed under MIT license (LICENSE-MIT).

Structs

• Authorization
  This struct represents the authorization data of the transaction status response
• Charge
  This struct is used to create a charge body for creating a Charge Authorization using the Paystack API.
• ChargeBuilder
  The ChargeBuilder struct provides a convenient way to construct a charge object with optional fields. Each field can be set individually using the builder’s methods. Once all the desired fields are set, the build method can be called to create an instance of the Charge struct.
• Customer
  This struct represents the Paystack customer data
• ExportTransactionData
  Export transaction response data.
• ExportTransactionResponse
  Represents the response of the export transaction.
• PartialDebitTransaction
  This struct is used to create a partial debit transaction body for creating a partial debit using the Paystack API.
• PartialDebitTransactionBuilder
  Builder for the Transaction object
• PartialDebitTransactionResponse
  Represents the response of the partial debit transaction.
• PaystackClient
  This is the struct that allows you to authenticate to the PayStack API. It contains the API key which allows you to interact with the API.
• PercentageSplitBuilder
  A builder pattern implementation for constructing PercentageSplit instances.
• RequestNotSuccessful
  Wrapper type which contains a failed request’s status code and body
• ResponseWithoutData
  Represents the JSON response of the Paystack API when there is no data property
• SplitData
  Represents the percentage split data received in the JSON response.
• Subaccount
  This struct represents the subacount that bears the transaction split
• SubaccountData
  Represents the data of th Subaccounts
• SubaccountResponse
  Represents a subaccount in the percentage split data.
• TranasctionHistory
  This struct represents the transaction history data
• Transaction
  This struct is used to create a transaction body for creating a transaction using the Paystack API.
• TransactionBuilder
  Builder for the Transaction object
• TransactionResponse
  This struct represents the response of the Paystack transaction initalization.
• TransactionResponseData
  This struct represents the data of the transaction response.
• TransactionSplit
  This struct is used to create a split payment on your integration.
• TransactionSplitListResponse
  Represents the JSON response containing percentage split information.
• TransactionSplitResponse
  Represents the JSON response containing percentage split information.
• TransactionStatus
  This struct represents the transaction status response.
• TransactionStatusData
  This struct represents the data of the transaction status response.
• TransactionStatusList
  This struct represents a list of transaction status.
• TransactionTimeline
  This struct represents the transaction timeline.
• TransactionTimelineData
  This struct represents the transaction timeline data.
• TransactionTotalData
  Transaction total data.
• TransactionTotalsResponse
  Represents the response of the total amount received on your account
• VolumeByCurrency
  Transaction volume by currecny.

Enums

• BearerType
  Represents the type of bearer for a charge.
• Channel
  Represents the payment channels supported by Paystack.
• Currency
  Represents different currencies supported by the Paystack API.
• PaystackError
  Custom Error for the Paystack API
• SplitType
  Represents the type of transaction split.
• Status
  Represents the status of a transaction.

Type Definitions

• PaystackResult
  Custom result type for the Paystack API