gopayment

README

GoPayment

Multi Gateway Payment Package for Golang.

List of contents

• GoPayment
• List of contents
• List of available drivers
  • Installation
  • How to use
    • Purchase
    • Pay
    • Verify payment
    • Working with invoices
    • Working with receipts
    • Example
• Contributing
• Security
• Credits
• License

List of available drivers

• zarinpal ✅
• payping ✅
• asanpardakht ✅
• behpardakht (mellat) ❌ (will be added soon)
• digipay ❌ (will be added soon)
• etebarino (Installment payment) ❌ (will be added soon)
• sepehr (saderat) ❌ (will be added soon)
• idpay ✅
• poolam ❌ (will be added soon)
• irankish ❌ (will be added soon)
• nextpay ❌ (will be added soon)
• parsian ❌ (will be added soon)
• pasargad ❌ (will be added soon)
• payir ❌ (will be added soon)
• paystar ❌ (will be added soon)
• sadad (melli) ❌ (will be added soon)
• saman ❌ (will be added soon)
• walleta (Installment payment) ❌ (will be added soon)
• yekpay ❌ (will be added soon)
• zibal ✅
• sepordeh ❌ (will be added soon)
• paypal ❌ (will be added soon)
• Help me to add the other gateways by creating pull requests

Installation

go get -u github.com/mohammadv184/gopayment

How to use

Purchase

In order to pay the invoice, we need the payment transactionId. We purchase the invoice to retrieve transaction id:

// Configure the Gateway Driver
gateway:=&payping.Driver{
Callback:    "http://example.test/callback",
Token:       "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
}
// Create new Payment.
payment := gopayment.NewPayment(gateway)
// Set Invoice Amount.
payment.Amount(amountInt)
// Set Invoice Description.
payment.Description("description")
// Purchase the invoice.
err = payment.Purchase()
if err != nil {
    fmt.Println(err)
}
// Get Transaction ID
transactionID := payment.GetTransactionID()

Pay

After purchasing the invoice, we can redirect the user to the bank payment page:

func pay() gin.HandlerFunc {
    return func(c *gin.Context) {
        // Configure the Gateway Driver
        gateway:=&payping.Driver{
        Callback:    "http://example.test/callback",
        Token:       "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
        }
        // Create new Payment.
        payment := gopayment.NewPayment(gateway)
        // Set Invoice Amount.
		payment.Amount(amountInt)
		// Set Invoice Description.
		payment.Description("description")
		// Purchase the invoice.
        err = payment.Purchase()
        if err != nil {
            fmt.Println(err)
        }
        // Get Transaction ID And Save it to the database.
        transactionID := payment.GetTransactionID()
        // Redirect the user to the bank payment page.
        payUrl := payment.PayURL()
		c.Redirect(http.StatusFound, payUrl)
	}
}

Verify payment

When user has completed the payment, the bank redirects them to your website, then you need to verify your payment to make sure that the payment is valid.:

// Configure the Gateway Driver
gateway:=&payping.Driver{
Callback:    "http://example.test/callback",
Token:       "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
}

refId := c.Query("refId")
VerifyRequest:=&payping.VerifyRequest{
Amount: "100",
RefID:  refID,
}

if receipt, err := gateway.Verify(VerifyRequest); err == nil {

c.JSON(200, gin.H{
"status": "success",
"data":   receipt.GetReferenceID(),
"date":   receipt.GetDate().String(),
"card":   receipt.GetDetail("cardNumber"),
"gateway": receipt.GetDriver(),
})
} else {
c.JSON(200, gin.H{
"message": "error " + err.Error(),
})
}

Working with invoices

When you make a payment, the invoice is automatically generated within the payment

In your code, use it like the below:

// Create new Payment.
payment := gopayment.NewPayment(gateway)
// Get the invoice.
invoice:=payment.GetInvoice()
// Set Invoice Amount.
invoice.SetAmount(1000)
// Set Invoice Description.
invoice.SetDescription("description")
// Set Invoice Deatils.
invoice.Detail("phone","0912345678")
invoice.Detail("email","example@example.com")

Available methods:

• SetUuid: set the invoice unique id
• GetUuid: retrieve the invoice current unique id
• Detail: attach some custom details into invoice
• GetDetail: retrieve the invoice detail
• GetDetails: retrieve all custom details
• SetAmount: set the invoice amount
• GetAmount: retrieve invoice amount
• SetTransactionID: set invoice payment transaction id
• GetTransactionID: retrieve payment transaction id
• SetDescription: set invoice Description
• GetDescription: retrieve payment Description

Working with receipts

When you verify a payment, the receipt is automatically generated.

In your code, use it like the below:

// Verify the Payment.
receipt := gateway.verify(...)
// Get the Payment Reference ID.
refId := receipt.GetReferenceID()
// Get the payment date .
paymentDate:=receipt.GetDate()
// Get the payment driver name.
paymentDriver:=receipt.GetDriver()
// Get payment Deatils.
cardNum:=receipt.GetDetail("cardNumber")
cardHNum:=receipt.GetDetail("HashedCardNumber")

Available methods:

• GetReferenceID: retrieve the payment reference id
• GetDriver: retrieve the payment driver name
• Detail: attach some custom details into invoice
• GetDate: retrieve payment date
• GetDetail: retrieve the invoice detail
• GetDetails: retrieve all custom details

Example

There is an example project using GoPayment you can find at GoPayment-Example Repo It contains a payment implementation.

Contributing

Please see CONTRIBUTING and CONDUCT for details.

Security

If you discover any security related issues, please email mohammadv184@gmail.com instead of using the issue tracker.

Credits

• Mohammad Abbasi
• All Contributors

License

The MIT License (MIT). Please see License File for more information.

Documentation

Overview

Package gopayment multi gateway payment package for Golang

Index

• Constants
• type Payment
  • func NewPayment(driver gateway.Driver) *Payment
  • func (p *Payment) Amount(amount int) *Payment
  • func (p *Payment) Client(client httpClient.Client) *Payment
  • func (p *Payment) Description(description string) *Payment
  • func (p *Payment) Detail(key, value string) *Payment
  • func (p *Payment) GetInvoice() *invoice.Invoice
  • func (p *Payment) GetTransactionID() string
  • func (p *Payment) PayMethod() string
  • func (p *Payment) PayURL() string
  • func (p *Payment) Purchase() error
  • func (p *Payment) RenderRedirectForm() (string, error)

Constants

const Version = "v1.9.0"

Version is the version of gopayment

Types

type Payment

type Payment struct {
	// contains filtered or unexported fields
}

Payment is the payment main struct of gopayment

func NewPayment

func NewPayment(driver gateway.Driver) *Payment

NewPayment create a new payment

func (*Payment) Amount

func (p *Payment) Amount(amount int) *Payment

Amount set the amount of payment invoice

func (*Payment) Client

func (p *Payment) Client(client httpClient.Client) *Payment

Client sets the driver http client.

func (*Payment) Description

func (p *Payment) Description(description string) *Payment

Description set the payment description

func (*Payment) Detail

func (p *Payment) Detail(key, value string) *Payment

Detail set the payment detail

func (*Payment) GetInvoice

func (p *Payment) GetInvoice() *invoice.Invoice

GetInvoice return the payment invoice

func (*Payment) GetTransactionID

func (p *Payment) GetTransactionID() string

GetTransactionID return the payment transaction id

func (*Payment) PayMethod

func (p *Payment) PayMethod() string

PayMethod returns the Request Method to be used to pay the invoice.

func (*Payment) PayURL

func (p *Payment) PayURL() string

PayURL return the payment URL

func (*Payment) Purchase

func (p *Payment) Purchase() error

Purchase send the purchase request to the payment gateway

func (*Payment) RenderRedirectForm

func (p *Payment) RenderRedirectForm() (string, error)

RenderRedirectForm renders the html form for redirect to payment page.