Skip to content

Latest commit

 

History

History
145 lines (112 loc) · 3.7 KB

README.md

File metadata and controls

145 lines (112 loc) · 3.7 KB
Raw

SSLCommerz-Go

A Go package for integrating with the SSLCommerz payment gateway. This package provides functions to initiate payments and handle responses, structured in a modular way for easy management and extension.

Project Structure

sslcommerz-go/
├── config/
│   └── config.go
├── client/
│   └── client.go
├── sslcommerz/
│   └── sslcommerz.go
├── examples/
│   └── main.go
├── go.mod
└── go.sum

Description of Files

  • config/config.go: Handles configuration settings, such as storing the store ID and password.
  • client/client.go: Manages HTTP requests to the SSLCommerz API.
  • sslcommerz/sslcommerz.go: Implements payment processing functions, such as initiating payments.
  • examples/main.go: Provides an example usage of the package, demonstrating how to initiate a payment request.

Installation

  1. Install:

    go get -u github.com/JubaerHossain/sslcommerz-go

  2. Set up Go modules:

    go mod tidy

Configuration

Set the following environment variables with your SSLCommerz credentials:

export SSLCOMMERZ_STORE_ID=your_store_id
export SSLCOMMERZ_STORE_PASS=your_store_password

Usage

Example Usage

The following example demonstrates how to initiate a payment request using the package.

package main

import (
    "fmt"
    "log"
    "github.com/yourusername/sslcommerz-go/sslcommerz"
)

func main() {
  paymentRequest := &sslcommerzEntity.PaymentRequest{
		TotalAmount:      103,
		Currency:         "BDT",
		TransactionID:     "SSLCZ_TEST_" + GenerateUniqueID(),
		SuccessURL:        "http://localhost:8080/success",
		FailURL:           "http://localhost:8080/fail",
		CancelURL:         "http://localhost:8080/cancel",
		IPNURL:            "http://localhost:8080/ipn",
		CustomerName:     "Test Customer",
		CustomerEmail:    "test@test.com",
		CustomerAddress1: "Dhaka",
		CustomerAddress2: "Dhaka",
		CustomerCity:     "Dhaka",
		CustomerState:    "Dhaka",
		CustomerPostcode: "1000",
		CustomerCountry:  "Bangladesh",
		CustomerPhone:    "01711111111",
		CustomerFax:      "01711111111",
		ShippingMethod:   "No",
		ShippingName:     "Store Test",
		ShippingAddress1: "Dhaka",
		ShippingAddress2: "Dhaka",
		ShippingCity:     "Dhaka",
		ShippingState:    "Dhaka",
		ShippingPostcode: "1000",
		ShippingCountry:  "Bangladesh",
		ValueA:           "ref001",
		ValueB:           "ref002",
		ValueC:           "ref003",
		ValueD:           "ref004",
		ProductName:      "Computer",
		ProductCategory:  "Goods",
		ProductProfile:   "physical-goods",
	}

	sslc := sslcommerz.NewSSLCommerz()
	response, err := sslc.InitiatePayment(paymentRequest)
	if err != nil {
		log.Printf("Error initiating payment: %v", err)
		http.Error(w, "Internal Server Error: Payment initiation failed", http.StatusInternalServerError)
		return
	}

    fmt.Printf("Payment Response: %+v\n", response)

    // Redirect to the payment gateway
}

Run the Example

  1. Set environment variables:

    export SSLCOMMERZ_STORE_ID=your_store_id
export SSLCOMMERZ_STORE_PASS=your_store_password

  2. Run the example:

    go run examples/main.go

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contributing

Contributions are welcome! Please feel free to submit a pull request or open an issue.

Acknowledgements

Thanks to the SSLCommerz team for providing the API and documentation.

Contact

For any questions or feedback, please open an issue or contact me at your-email@example.com.

This README provides a comprehensive guide for using the SSLCommerz-Go package, including setup, configuration, and example usage.