models

Documentation

Overview

Package models provides the structs for the response

Index

• type AgreementRequest
• type BkashError
• type BkashIPNPayload
• type CancelAgreementResponse
• type CreateAgreementResponse
• type CreateAgreementValidationResponse
• type CreatePaymentResponse
• type CreateRequest
• type ExecuteAgreementResponse
• type ExecutePaymentResponse
• type ExecuteRequest
• type Message
• type QueryAgreementResponse
• type QueryPaymentResponse
• type RefundRequest
• type RefundResponse
• type SearchTransactionRequest
• type SearchTransactionResponse
• type TokenRequest
• type TokenResponse

Types

type AgreementRequest

type AgreementRequest struct {
	AgreementID string `json:"agreementID,omitempty"`
}

Query/Cancel Agreement Request

type BkashError

type BkashError struct {
	ErrorCode    string `json:"errorCode,omitempty"`
	ErrorMessage string `json:"errorMessage,omitempty"`
}

Error response

type BkashIPNPayload

type BkashIPNPayload struct {
	Type             string      `json:"Type,omitempty"`
	MessageId        string      `json:"MessageId,omitempty"`
	Token            string      `json:"Token,omitempty"`
	TopicArn         string      `json:"TopicArn,omitempty"`
	SubscribeURL     string      `json:"SubscribeURL,omitempty"`
	Timestamp        string      `json:"Timestamp,omitempty"`
	SignatureVersion string      `json:"SignatureVersion,omitempty"`
	Signature        string      `json:"Signature,omitempty"`
	SigningCertURL   string      `json:"SigningCertURL,omitempty"`
	UnSubscribeURL   string      `json:"UnSubscribeURL,omitempty"`
	Message          interface{} `json:"Message,omitempty"`
}

BkashIPN Request/Response payload

type CancelAgreementResponse

type CancelAgreementResponse struct {
	PaymentID         string `json:"paymentID,omitempty"`
	AgreementID       string `json:"agreementID,omitempty"`
	PayerReference    string `json:"payerReference,omitempty"`
	AgreementVoidTime string `json:"agreementVoidTime,omitempty"`
	AgreementStatus   string `json:"agreementStatus,omitempty"`
	StatusCode        string `json:"statusCode,omitempty"`
	StatusMessage     string `json:"statusMessage,omitempty"`
}

Cancel Agreement Response

type CreateAgreementResponse

type CreateAgreementResponse struct {
	PaymentID            string `json:"paymentID,omitempty"`
	BkashURL             string `json:"bkashURL,omitempty"`
	CallbackURL          string `json:"callbackURL,omitempty"`
	SuccessCallbackURL   string `json:"successCallbackURL,omitempty"`
	FailureCallbackURL   string `json:"failureCallbackURL,omitempty"`
	CancelledCallbackURL string `json:"cancelledCallbackURL,omitempty"`
	StatusCode           string `json:"statusCode,omitempty"`
	StatusMessage        string `json:"statusMessage,omitempty"`
}

Create Agreement Response

type CreateAgreementValidationResponse

type CreateAgreementValidationResponse struct {
	PaymentID string `json:"paymentID,omitempty"`
	Status    string `json:"status,omitempty"`
}

type CreatePaymentResponse

type CreatePaymentResponse struct {
	PaymentID             string `json:"paymentID,omitempty"`
	AgreementID           string `json:"agreementID,omitempty"`
	PaymentCreateTime     string `json:"paymentCreateTime,omitempty"`
	TransactionStatus     string `json:"transactionStatus,omitempty"`
	Amount                string `json:"amount,omitempty"`
	Currency              string `json:"currency,omitempty"`
	Intent                string `json:"intent,omitempty"`
	MerchantInvoiceNumber string `json:"merchantInvoiceNumber,omitempty"`
	BkashURL              string `json:"bkashURL,omitempty"`
	CallbackURL           string `json:"callbackURL,omitempty"`
	SuccessCallbackURL    string `json:"successCallbackURL,omitempty"`
	FailureCallbackURL    string `json:"failureCallbackURL,omitempty"`
	CancelledCallbackURL  string `json:"cancelledCallbackURL,omitempty"`
	StatusCode            string `json:"statusCode,omitempty"`
	StatusMessage         string `json:"statusMessage,omitempty"`
}

Create Payment Response

type CreateRequest

type CreateRequest struct {
	Mode                    string `json:"mode,omitempty"`
	PayerReference          string `json:"payerReference,omitempty"`
	CallbackURL             string `json:"callbackURL,omitempty"`
	Amount                  string `json:"amount,omitempty"`
	Currency                string `json:"currency,omitempty"`
	Intent                  string `json:"intent,omitempty"`
	MerchantInvoiceNumber   string `json:"merchantInvoiceNumber,omitempty"`
	AgreementID             string `json:"agreementID,omitempty"`
	MerchantAssociationInfo string `json:"merchantAssociationInfo,omitempty"`
}

Create Agreement/Payment Request

type ExecuteAgreementResponse

type ExecuteAgreementResponse struct {
	PaymentID            string `json:"paymentID,omitempty"`
	AgreementID          string `json:"agreementID,omitempty"`
	CustomerMsisdn       string `json:"customerMsisdn,omitempty"`
	PayerReference       string `json:"payerReference,omitempty"`
	AgreementExecuteTime string `json:"agreementExecuteTime,omitempty"`
	AgreementStatus      string `json:"agreementStatus,omitempty"`
	StatusCode           string `json:"statusCode,omitempty"`
	StatusMessage        string `json:"statusMessage,omitempty"`
}

Execute Agreement Response

type ExecutePaymentResponse

type ExecutePaymentResponse struct {
	PaymentID             string `json:"paymentID,omitempty"`
	AgreementID           string `json:"agreementID,omitempty"`
	CustomerMsisdn        string `json:"customerMsisdn,omitempty"`
	PayerReference        string `json:"payerReference,omitempty"`
	AgreementExecuteTime  string `json:"agreementExecuteTime,omitempty"`
	AgreementStatus       string `json:"agreementStatus,omitempty"`
	PaymentExecuteTime    string `json:"paymentExecuteTime,omitempty"`
	TrxID                 string `json:"trxID,omitempty"`
	TransactionStatus     string `json:"transaction_status,omitempty"`
	Amount                string `json:"amount,omitempty"`
	Currency              string `json:"currency,omitempty"`
	Intent                string `json:"intent,omitempty"`
	MerchantInvoiceNumber string `json:"merchantInvoiceNumber,omitempty"`
	StatusCode            string `json:"statusCode,omitempty"`
	StatusMessage         string `json:"statusMessage,omitempty"`
}

Execute Payment Response

type ExecuteRequest

type ExecuteRequest struct {
	PaymentID string `json:"paymentID,omitempty"`
}

Execute Agreement/Payment/Query Request

type Message

type Message struct {
	DateTime               string `json:"dateTime,omitempty"`
	DebitMSISDN            string `json:"debitMSISDN,omitempty"`
	CreditOrganizationName string `json:"creditOrganizationName,omitempty"`
	CreditShortCode        string `json:"creditShortCode,omitempty"`
	TrxID                  string `json:"trxID,omitempty"`
	TransactionStatus      string `json:"transactionStatus,omitempty"`
	TransactionType        string `json:"transactionType,omitempty"`
	Amount                 string `json:"amount,omitempty"`
	Currency               string `json:"currency,omitempty"`
	TransactionReference   string `json:"transactionReference,omitempty"`
}

Message for response

type QueryAgreementResponse

type QueryAgreementResponse struct {
	PaymentID            string `json:"paymentID,omitempty"`
	AgreementID          string `json:"agreementID,omitempty"`
	PayerReference       string `json:"payerReference,omitempty"`
	CustomerMsisdn       string `json:"customerMsisdn,omitempty"`
	AgreementCreateTime  string `json:"agreementCreateTime,omitempty"`
	AgreementExecuteTime string `json:"agreementExecuteTime,omitempty"`
	AgreementVoidTime    string `json:"agreementVoidTime,omitempty"`
	AgreementStatus      string `json:"agreementStatus,omitempty"`
	StatusCode           string `json:"statusCode,omitempty"`
	StatusMessage        string `json:"statusMessage,omitempty"`
}

Query Agreement Response

type QueryPaymentResponse

type QueryPaymentResponse struct {
	PaymentID              string `json:"paymentID,omitempty"`
	Mode                   string `json:"mode,omitempty"`
	PayerReference         string `json:"payerReference,omitempty"`
	PaymentCreateTime      string `json:"paymentCreateTime,omitempty"`
	PaymentExecuteTime     string `json:"paymentExecuteTime,omitempty"`
	TrxID                  string `json:"trxID,omitempty"`
	TransactionStatus      string `json:"transaction_status,omitempty"`
	Amount                 string `json:"amount,omitempty"`
	Currency               string `json:"currency,omitempty"`
	Intent                 string `json:"intent,omitempty"`
	MerchantInvoiceNumber  string `json:"merchantInvoiceNumber,omitempty"`
	UserVerificationStatus string `json:"userVerificationStatus,omitempty"`
	StatusCode             string `json:"statusCode,omitempty"`
	StatusMessage          string `json:"statusMessage,omitempty"`
}

Query Payment Response

type RefundRequest

type RefundRequest struct {
	PaymentID string `json:"paymentID,omitempty"`
	Amount    string `json:"amount,omitempty"`
	TrxID     string `json:"trxID,omitempty"`
	SKU       string `json:"sku,omitempty"`
	Reason    string `json:"reason,omitempty"`
}

Refund Transaction/Status Request

type RefundResponse

type RefundResponse struct {
	CompletedTime     string `json:"completedTime,omitempty"`
	TransactionStatus string `json:"transactionStatus,omitempty"`
	OriginalTrxID     string `json:"originalTrxID,omitempty"`
	RefundTrxID       string `json:"refundTrxID,omitempty"`
	Amount            string `json:"amount,omitempty"`
	Currency          string `json:"currency,omitempty"`
	Charge            string `json:"charge,omitempty"`
}

Refund Transaction/Status Response

type SearchTransactionRequest

type SearchTransactionRequest struct {
	TrxID string `json:"trxID,omitempty"`
}

Search Transaction Request

type SearchTransactionResponse

type SearchTransactionResponse struct {
	Amount                string `json:"amount,omitempty"`
	CompletedTime         string `json:"completed_time,omitempty"`
	Currency              string `json:"currency,omitempty"`
	CustomerMsisdn        string `json:"customerMsisdn,omitempty"`
	InitiationTime        string `json:"initiationTime,omitempty"`
	OrganizationShortCode string `json:"organizationShortCode,omitempty"`
	TransactionReference  string `json:"transactionReference,omitempty"`
	TransactionStatus     string `json:"transactionStatus,omitempty"`
	TransactionType       string `json:"transactionType,omitempty"`
	StatusCode            string `json:"statusCode,omitempty"`
	StatusMessage         string `json:"statusMessage,omitempty"`
	TrxID                 string `json:"trxID,omitempty"`
}

Search Transaction Response

type TokenRequest

type TokenRequest struct {
	AppKey       string `json:"app_key,omitempty"`
	AppSecret    string `json:"app_secret,omitempty"`
	RefreshToken string `json:"refresh_token,omitempty"`
}

Grant/Refresh Token Request

type TokenResponse

type TokenResponse struct {
	ExpiresIn     int    `json:"expires_in,omitempty"`
	IdToken       string `json:"id_token,omitempty"`
	RefreshToken  string `json:"refresh_token,omitempty"`
	TokenType     string `json:"token_type,omitempty"`
	StatusCode    string `json:"statusCode,omitempty"`
	StatusMessage string `json:"statusMessage,omitempty"`
}

Grant/Refresh Token Response