vposgo

package module
v1.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 21, 2023 License: MIT Imports: 9 Imported by: 0

README

vPOS Go

This package facilitates the integration of your Golang project/application with the vPOS API Payment Gateway.

Installation

go get github.com/nellcorp/vpos-go

Configuration

This package requires you set up the following environment variables on your machine before interacting with the API using this package:

Variable Description Required
GPO_POS_ID The Point of Sale ID provided by EMIS true
GPO_SUPERVISOR_CARD The Supervisor card ID provided by EMIS true
MERCHANT_VPOS_TOKEN The API token provided by vPOS true
PAYMENT_CALLBACK_URL The URL that will handle payment notifications false
REFUND_CALLBACK_URL The URL that will handle refund notifications false

Given you have set up all the environment variables above with the correct information, you will now be able to authenticate and communicate effectively with vPOS API Payment Gateway using this package.

Note: During development, make sure to use a token created for the sandbox environment

The next section will show the various payment actions that can be performed by you, the merchant.

How to instantiate vPOS

To create an instance of a vPOS merchant see argument table and a simple example below:

Argument Description Type
token Token generated at vPOS dashboard string
posID Merchant POS ID provided by EMIS int64
supervisorCard Merchant Supervisor Card number provided by EMIS string
paymentCallbackURL Merchant application endpoint to accept the callback payment response string
refundCallbackURL Merchant application endpoint to accept the callback refund response string
Example
package main

import (
    "os"

    "github.com/nellcorp/vpos-go"
)

var (
    posID              = os.Getenv("GPO_POS_ID")
    token              = os.Getenv("MERCHANT_VPOS_TOKEN")
    paymentCallbackURL = os.Getenv("PAYMENT_CALLBACK_URL")
    refundCallbackURL  = os.Getenv("REFUND_CALLBACK_URL")
    supervisorCard     = os.Getenv("GPO_SUPERVISOR_CARD")
)

func main() {
    vpos := vposgo.NewVPOS(
        posID,
        token,
        paymentCallbackURL,
        refundCallbackURL,
        supervisorCard
    )
}
Payment Transaction

Creates a new payment transaction (or authorization request) given a transactionType, a valid mobile number associated with a MULTICAIXA EXPRESS account and a valid amount.

package main

import (
    "log"
    "os"

    "github.com/nellcorp/vpos-go"
)

var (
    posID              = os.Getenv("GPO_POS_ID")
    token              = os.Getenv("MERCHANT_VPOS_TOKEN")
    paymentCallbackURL = os.Getenv("PAYMENT_CALLBACK_URL")
    refundCallbackURL  = os.Getenv("REFUND_CALLBACK_URL")
    supervisorCard     = os.Getenv("GPO_SUPERVISOR_CARD")
)

func main() {
    vpos := vposgo.NewVPOS(
        posID,
        token,
        paymentCallbackURL,
        refundCallbackURL,
        supervisorCard
    )

    transactionType := "payment" // or "authorization"
    mobile := "934174394"
    amount := "2000.00"

    transactionID, idempotencyKey, nonce, timeRemaining, err := vpos.PaymentTransaction(transactionType, mobile, amount)
    if err != nil {
		log.Fatal(err)
	}
}
Argument Description Type
transactionType The transactionType is either 'payment' or 'authorization' string
mobile The client mobile number in a string format. Must be a number registered in Multicaixa Express string
amount Amount of the requested payment in a string format. Use (.) as decimals separator; at most 2 decimal places string
Payment Transaction with Authorization

Creates a new payment transaction from a previously accepted authorization transaction

package main

import (
    "log"
    "os"

    "github.com/nellcorp/vpos-go"
)

var (
    posID              = os.Getenv("GPO_POS_ID")
    token              = os.Getenv("MERCHANT_VPOS_TOKEN")
    paymentCallbackURL = os.Getenv("PAYMENT_CALLBACK_URL")
    refundCallbackURL  = os.Getenv("REFUND_CALLBACK_URL")
    supervisorCard     = os.Getenv("GPO_SUPERVISOR_CARD")
)

func main() {
    vpos := vposgo.NewVPOS(
        posID,
        token,
        paymentCallbackURL,
        refundCallbackURL,
        supervisorCard
    )

    parentTransactionID := "9kOmKYUWxN0Jpe4PBoXzE"
    amount := "2000.00"

    transactionID, idempotencyKey, nonce, timeRemaining, err := vpos.PaymentWithAuthorization(parentTransactionID, amount)
    if err != nil {
		log.Fatal(err)
	}
}
Argument Description Type
parentTransactionID The ID of the accepted authorization transaction string
amount Amount to capture. Must be equal or less than the amount of the authorization. Use (.) as decimals separator; at most 2 decimal places string
Request Refund or Request Transaction Cancelation

Given an transactionType existing parentTransactionID, request a refund or transaction cancelation.

package main

import (
    "log"
    "os"

    "github.com/nellcorp/vpos-go"
)

var (
    posID              = os.Getenv("GPO_POS_ID")
    token              = os.Getenv("MERCHANT_VPOS_TOKEN")
    paymentCallbackURL = os.Getenv("PAYMENT_CALLBACK_URL")
    refundCallbackURL  = os.Getenv("REFUND_CALLBACK_URL")
    supervisorCard     = os.Getenv("GPO_SUPERVISOR_CARD")
)

func main() {
    vpos := vposgo.NewVPOS(
        posID,
        token,
        paymentCallbackURL,
        refundCallbackURL,
        supervisorCard
    )

    transactionType := "refund" // or "cancelation"
    parentTransactionID := "9kOmKYUWxN0Jpe4PBoXzE"

    transactionID, idempotencyKey, nonce, timeRemaining, err := vpos.RefundOrCancelation(transactionType, parentTransactionID)
    if err != nil {
		log.Fatal(err)
	}
}
Argument Description Type
transactionType The transactionType is either 'refund' or 'cancelation' string
parentTransactionID This is a string value of the transaction id you're requesting to be refunded or canceled string
Get Transaction

This retrieves a specific transaction.

package main

import (
    "log"
    "os"

    "github.com/nellcorp/vpos-go"
)

var (
    posID              = os.Getenv("GPO_POS_ID")
    token              = os.Getenv("MERCHANT_VPOS_TOKEN")
    paymentCallbackURL = os.Getenv("PAYMENT_CALLBACK_URL")
    refundCallbackURL  = os.Getenv("REFUND_CALLBACK_URL")
    supervisorCard     = os.Getenv("GPO_SUPERVISOR_CARD")
)

func main() {
    vpos := vposgo.NewVPOS(
        posID,
        token,
        paymentCallbackURL,
        refundCallbackURL,
        supervisorCard
    )

    transactionID := "1jHbXEbRTIbbwaoJ6w06nLcRG7X"
    transaction, err := vpos.GetTransaction(transactionID)
    if err != nil {
		log.Fatal(err)
	}

    /* 
        transaction = &Transaction{
            "amount": "101.09",
            "clearing_period": null,
            "id": "1jHbXEbRTIbbwaoJ6w06nLcRG7X",
            "mobile": "900111222",
            "parent_transaction_id": null,
            "pos_id": 100,
            "status": "accepted",
            "status_datetime": "2020-10-23T14:41:00Z",
            "status_reason": null,
            "type": "payment"
        }
    */
}
Argument Description Type
transactionID The ID of the transaction to retrieve string

We hope this module can be useful for you. Feel free to contribute and help to improve this package opening an ISSUE or Pull Request 😀.

License

The package is available as open source under the terms of the MIT License.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetStatusReason 

func GetStatusReason(code int64) (reason string, err error)

Types

type AuthorizedPaymentTransaction 

type AuthorizedPaymentTransaction struct {
	Type                TransactionType `json:"type"`
	ParentTransactionID string          `json:"parent_transaction_id"`
	Amount              string          `json:"amount"`
	CallbackURL         string          `json:"callback_url"`
}

type PaymentTransaction 

type PaymentTransaction struct {
	Type        TransactionType `json:"type"`
	PosID       int64           `json:"pos_id"`
	Mobile      string          `json:"mobile"`
	Amount      string          `json:"amount"`
	CallbackURL string          `json:"callback_url"`
}

type RefundTransaction 

type RefundTransaction struct {
	Type                TransactionType `json:"type"`
	ParentTransactionID string          `json:"parent_transaction_id"`
	CallbackURL         string          `json:"call_back_url"`
}

type Transaction 

type Transaction struct {
	ID                  string          `json:"id"`
	Amount              string          `json:"amount"`
	ClearingPeriod      string          `json:"clearing_period"`
	Mobile              string          `json:"mobile"`
	ParentTransactionID string          `json:"parent_transaction_id"`
	PosID               int64           `json:"pos_id"`
	Status              string          `json:"status"`
	StatusDatetime      string          `json:"status_datetime"`
	StatusReason        string          `json:"status_reason"`
	Type                TransactionType `json:"type"`
}

type TransactionStatus 

type TransactionStatus struct {
	SecondsRemaining json.Number `json:"eta"`
	CreatedAt        string      `json:"inserted_at"`
}

type TransactionType added in v1.1.0 

type TransactionType string
const (
	TypePayment       TransactionType = "payment"
	TypeRefund        TransactionType = "refund"
	TypeAuthorization TransactionType = "authorization"
	TypeCancelation   TransactionType = "cancelation"
)

type VPOS 

type VPOS struct {
	Token              string //Your VPOS Token
	PosID              int64  //Your GPO POS ID
	PaymentCallbackURL string //Your Payment Callback URL
	RefundCallbackURL  string //Your Refund Callback URL
	SupervisorCard     string //Your GPO Supervisor Card
}

func NewVPOS 

func NewVPOS(posID int64, token, paymentCallbackURL, refundCallbackURL, supervisorCard string) *VPOS

func (*VPOS) GetRequest added in v1.1.0 

func (v *VPOS) GetRequest(transactionID string) (result int64, err error)

func (*VPOS) GetTransaction 

func (v *VPOS) GetTransaction(transactionID string) (transaction Transaction, err error)

func (*VPOS) PaymentTransaction 

func (v *VPOS) PaymentTransaction(transactionType TransactionType, mobile, amount string) (transactionID, idempotencyKey, nonce string, timeRemaining int64, err error)

transactionType is either 'payment' or 'authorization' if transactionType is 'payment', it will create a new payment transaction if transactionType is 'authorization', it will create a new authorization transaction

func (*VPOS) PaymentWithAuthorization 

func (v *VPOS) PaymentWithAuthorization(parent_transaction_id, amount string) (transactionID, idempotencyKey, nonce string, timeRemaining int64, err error)

It creates a new payment transaction from a previously accepted authorization transaction

func (*VPOS) RefundOrCancelation 

func (v *VPOS) RefundOrCancelation(transactionType TransactionType, parentTransactionID string) (transactionID, idempotencyKey, nonce string, timeRemaining int64, err error)

transactionType is either 'refund' or 'cancelation' if transactionType is 'refund', it will create a new refund transaction if transactionType is 'cancelation', it will create a new cancelation transaction for a previously accepted payment authorization

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.