merchants

Documentation

Index

• type BantupayAuthorizationData
• type ErrorResponse
• type LoginWithBantupayData
• type Merchant
  • func NewMerchant(baseUrl, merchantBantupayUsername, secretKey string) (merchantInfo *Merchant, err error)
  • func (m *Merchant) GetPaymentData(targetUser, paymentDestination, assetCode, assetIssuer, amount, memo string) (paymentData *PayWithBantupayData, err error)
  • func (m *Merchant) SendAuthorizationRequest(targetUser, authDescription, deviceInfo, callbackUrl string, ...) (authInfo *BantupayAuthorizationData, err error)
  • func (m *Merchant) SendLoginRequest(targetUser, deviceInfo, callbackUrl string) (loginInfo *LoginWithBantupayData, err error)
  • func (m *Merchant) SendPushNotification(targetUser, title, message string) (err error)
  • func (m *Merchant) VerifyAuthorizationRequest(targetUser, authID string) (err error)
  • func (m *Merchant) VerifyLoginRequest(targetUser, loginID string) (userDetail *MerchantBudsInfo, err error)
• type MerchantBudsInfo
• type MerchantPushNotification
• type MerchantRequestInput
• type PayWithBantupayData

Types

type BantupayAuthorizationData

type BantupayAuthorizationData struct {
	DynamicLink string `json:"dynamicLink"`
	QRCode      string `json:"qrCode"`
	AuthID      string `json:"authId"`
}

type ErrorResponse

type ErrorResponse struct {
	Error   string `json:"error"`
	Data    string `json:"data"`
	Message string `json:"message"`
}

type LoginWithBantupayData

type LoginWithBantupayData struct {
	DynamicLink string `json:"dynamicLink"`
	QRCode      string `json:"qrCode"`
	LoginID     string `json:"loginId"`
}

type Merchant

type Merchant struct {
	BantupayUsername string `json:"bantupayUsername" `
	BaseURL          string `json:"baseUrl"`
	KP               *keypair.Full
}

Merchant holds Merchant data model

func NewMerchant

func NewMerchant(baseUrl, merchantBantupayUsername, secretKey string) (merchantInfo *Merchant, err error)

NewMerchant retrieves merchant Info from the bantupay API

func (*Merchant) GetPaymentData

func (m *Merchant) GetPaymentData(targetUser, paymentDestination, assetCode, assetIssuer, amount, memo string) (paymentData *PayWithBantupayData, err error)

GetPaymentData verifies if authID is authorized and resturns nil

func (*Merchant) SendAuthorizationRequest

func (m *Merchant) SendAuthorizationRequest(targetUser, authDescription, deviceInfo, callbackUrl string, validityInMinutes int) (authInfo *BantupayAuthorizationData, err error)

SendAuthorizationRequest sends 2FA authorization request and retrieves QRCode and dynamic link

func (*Merchant) SendLoginRequest

func (m *Merchant) SendLoginRequest(targetUser, deviceInfo, callbackUrl string) (loginInfo *LoginWithBantupayData, err error)

SendLoginRequest sends login request and retrieves QRCode and dynamic link

func (*Merchant) SendPushNotification

func (m *Merchant) SendPushNotification(targetUser, title, message string) (err error)

SendPushNotification sends a push notification

func (*Merchant) VerifyAuthorizationRequest

func (m *Merchant) VerifyAuthorizationRequest(targetUser, authID string) (err error)

VerifyAuthorizationRequest verifies if authID is authorized and resturns nil

func (*Merchant) VerifyLoginRequest

func (m *Merchant) VerifyLoginRequest(targetUser, loginID string) (userDetail *MerchantBudsInfo, err error)

VerifyLoginRequest verifies if loginID is authorized and resturns nil

type MerchantBudsInfo

type MerchantBudsInfo struct {
	Username       string `json:"username"`
	PublicKey      string `json:"publicKey"`
	Email          string `json:"email"`
	LastName       string `json:"lastName"`
	FirstName      string `json:"firstName"`
	MiddleName     string `json:"middleName"`
	Mobile         string `json:"mobile"`
	BantuTalk      string `json:"bantuTalk"`
	ImageThumbnail string `json:"imageThumbnail"`
	Verified       uint   `json:"verified"`
	Suspended      uint   `json:"suspended"`
	Referrer       string `json:"referrer"`
}

MerchantBudsInfo model for bantu user directory info

type MerchantPushNotification

type MerchantPushNotification struct {
	Title   string `json:"title,omitempty"`
	Message string `json:"message,omitempty"`
}

type MerchantRequestInput

type MerchantRequestInput struct {
	AuthDescription   string `json:"authDescription,omitempty"`
	DeviceInfo        string `json:"deviceInfo,omitempty"`
	CallbackURL       string `json:"callbackUrl,omitempty"`
	ValidityInMinutes int    `json:"validityInMinutes,omitempty"`
}

type PayWithBantupayData

type PayWithBantupayData struct {
	DynamicLink string `json:"dynamicLink"`
	QRCode      string `json:"qrCode"`
}