Crate paystack

Convenient rust bindings and types for the Paystack 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

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

    use std::env;
    use dotenv::dotenv;
    use paystack::{PaystackClient, InitializeTransactionBodyBuilder, Error, Currency, Channel};

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

        let body = InitializeTransactionBodyBuilder::default()
             .amount("10000".to_string())
             .email("email@example.com".to_string())
             .currency(Some(Currency::NGN))
             .channels(Some(vec![
                 Channel::ApplePay,
                 Channel::Bank,
                 Channel::BankTransfer
             ]))
             .build()
             .unwrap();

       let transaction = client
            .transaction
            .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
• ChargeBody
  This struct is used to create a charge body for creating a Charge Authorization using the Paystack API. The struct is constructed using the ChargeBodyBuilder
• ChargeBodyBuilder
  Builder for ChargeBody.
• CreateSubaccountBody
  This struct is used to create the body for creating a subaccount on your integration.
• CreateSubaccountBodyBuilder
  Builder for CreateSubaccountBody.
• CreateSubaccountResponse
  Represents the JSON response for subaccount creation.
• CreateTransactionSplitBody
  This struct is used to create a split payment on your integration. The struct is constructed using the CreateTransactionSplitBodyBuilder
• CreateTransactionSplitBodyBuilder
  Builder for CreateTransactionSplitBody.
• Customer
  This struct represents the Paystack customer data
• ExportTransactionData
  Export transaction response data.
• ExportTransactionResponse
  Represents the response of the export transaction.
• FetchSubaccountResponse
  Represents the JSON response for fetch subaccount.
• InitializeTransactionBody
  This struct is used to create a transaction body for creating a transaction using the Paystack API. This struct should be created using the InitializeTransactionBodyBuilder The Builder derivation allows for the automatic implementation of the builder pattern.
• InitializeTransactionBodyBuilder
  Builder for InitializeTransactionBody.
• ListSubaccountsResponse
  Response from List Subaccount route
• MetaData
  MetaData of list response
• PartialDebitTransactionBody
  This struct is used to create a partial debit transaction body for creating a partial debit using the Paystack API. This struct should be created using the PartialDebitTransactionBodyBuilder The derive Builder allows for the automatic creation of the BuilderPattern
• PartialDebitTransactionBodyBuilder
  Builder for PartialDebitTransactionBody.
• 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.
• 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
  A struct to hold all functions in the subaccount API route
• SubaccountBody
  This struct represents the subaccount. It can be used as the payload for the API end points that require a subaccount as a payload. It is also possible to extract a single field from this struct to use as well. The Struct is constructed using the SubaccountBuilder
• SubaccountBodyBuilder
  Builder for SubaccountBody.
• SubaccountData
  Represents the data of th Subaccounts
• SubaccountsResponseData
  Data of the list Subaccount response
• Transaction
  A Struct to hold all the functions of the transaction API route
• TransactionHistory
  This struct represents the transaction history data
• TransactionResponse
  This struct represents the response of the Paystack transaction initialization.
• TransactionResponseData
  This struct represents the data of the transaction response.
• TransactionSplit
  A struct to hold all the functions of the transaction split API route
• 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
• UpdateTransactionSplitBody
  This struct is used to update a transaction split details on your integration. The struct is constructed using the UpdateTransactionSplitBodyBuilder
• UpdateTransactionSplitBodyBuilder
  Builder for UpdateTransactionSplitBody.
• VolumeByCurrency
  Transaction volume by currency.

Enums

• BearerType
  Represents the type of bearer for a charge.
• Channel
  Represents the payment channels supported by Paystack.
• ChargeBodyBuilderError
  Error type for ChargeBodyBuilder
• CreateSubaccountBodyBuilderError
  Error type for CreateSubaccountBodyBuilder
• CreateTransactionSplitBodyBuilderError
  Error type for CreateTransactionSplitBodyBuilder
• Currency
  Represents different currencies supported by the Paystack API.
• Error
  Custom Error for the Paystack API
• InitializeTransactionBodyBuilderError
  Error type for InitializeTransactionBodyBuilder
• PartialDebitTransactionBodyBuilderError
  Error type for PartialDebitTransactionBodyBuilder
• SplitType
  Represents the type of transaction split.
• Status
  Represents the status of a transaction.
• SubaccountBodyBuilderError
  Error type for SubaccountBodyBuilder
• UpdateTransactionSplitBodyBuilderError
  Error type for UpdateTransactionSplitBodyBuilder

Functions

• delete_request
  A function for sending DELETE requests to a specified url using the reqwest client.
• get_request
  A function for sending GET request to a specified url with optional query parameters using reqwest client.
• post_request
  A function for sending POST requests to a specified url using the reqwest client.
• put_request
  A function for sending PUT requests to a specified url using the reqwest client.

Type Aliases

• PaystackResult
  Custom result type for the Paystack API