paymentv1

package
v1.16.6 Latest Latest
Warning

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

Go to latest
Published: Apr 26, 2024 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Index

Constants

View Source
const (
	PaymentService_Send_FullMethodName         = "/payment.v1.PaymentService/Send"
	PaymentService_Receive_FullMethodName      = "/payment.v1.PaymentService/Receive"
	PaymentService_Status_FullMethodName       = "/payment.v1.PaymentService/Status"
	PaymentService_StatusUpdate_FullMethodName = "/payment.v1.PaymentService/StatusUpdate"
	PaymentService_Release_FullMethodName      = "/payment.v1.PaymentService/Release"
	PaymentService_Search_FullMethodName       = "/payment.v1.PaymentService/Search"
	PaymentService_Reconcile_FullMethodName    = "/payment.v1.PaymentService/Reconcile"
)

Variables

View Source
var File_payment_v1_payment_proto protoreflect.FileDescriptor
View Source
var PaymentService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "payment.v1.PaymentService",
	HandlerType: (*PaymentServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Send",
			Handler:    _PaymentService_Send_Handler,
		},
		{
			MethodName: "Receive",
			Handler:    _PaymentService_Receive_Handler,
		},
		{
			MethodName: "Status",
			Handler:    _PaymentService_Status_Handler,
		},
		{
			MethodName: "StatusUpdate",
			Handler:    _PaymentService_StatusUpdate_Handler,
		},
		{
			MethodName: "Release",
			Handler:    _PaymentService_Release_Handler,
		},
		{
			MethodName: "Reconcile",
			Handler:    _PaymentService_Reconcile_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "Search",
			Handler:       _PaymentService_Search_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "payment/v1/payment.proto",
}

PaymentService_ServiceDesc is the grpc.ServiceDesc for PaymentService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterPaymentServiceServer

func RegisterPaymentServiceServer(s grpc.ServiceRegistrar, srv PaymentServiceServer)

func ToContext

func ToContext(ctx context.Context, paymentsClient *PaymentClient) context.Context

Types

type Payment

type Payment struct {
	Id                    string            `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	TransactionId         string            `protobuf:"bytes,2,opt,name=transaction_id,json=transactionId,proto3" json:"transaction_id,omitempty"`
	ReferenceId           string            `protobuf:"bytes,3,opt,name=reference_id,json=referenceId,proto3" json:"reference_id,omitempty"`
	BatchId               string            `protobuf:"bytes,4,opt,name=batch_id,json=batchId,proto3" json:"batch_id,omitempty"`
	ExternalTransactionId string            `` /* 126-byte string literal not displayed */
	Route                 string            `protobuf:"bytes,6,opt,name=route,proto3" json:"route,omitempty"`
	Source                *v1.ContactLink   `protobuf:"bytes,7,opt,name=source,proto3" json:"source,omitempty"`
	Recipient             *v1.ContactLink   `protobuf:"bytes,8,opt,name=recipient,proto3" json:"recipient,omitempty"`
	Amount                *money.Money      `protobuf:"bytes,9,opt,name=amount,proto3" json:"amount,omitempty"`
	Cost                  *money.Money      `protobuf:"bytes,10,opt,name=cost,proto3" json:"cost,omitempty"`
	State                 v1.STATE          `protobuf:"varint,11,opt,name=state,proto3,enum=common.v1.STATE" json:"state,omitempty"`
	Status                v1.STATUS         `protobuf:"varint,12,opt,name=status,proto3,enum=common.v1.STATUS" json:"status,omitempty"`
	DateCreated           string            `protobuf:"bytes,13,opt,name=date_created,json=dateCreated,proto3" json:"date_created,omitempty"`
	DateProcessed         string            `protobuf:"bytes,14,opt,name=date_processed,json=dateProcessed,proto3" json:"date_processed,omitempty"`
	Outbound              bool              `protobuf:"varint,15,opt,name=outbound,proto3" json:"outbound,omitempty"`
	Extra                 map[string]string `` /* 152-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*Payment) Descriptor deprecated

func (*Payment) Descriptor() ([]byte, []int)

Deprecated: Use Payment.ProtoReflect.Descriptor instead.

func (*Payment) GetAmount

func (x *Payment) GetAmount() *money.Money

func (*Payment) GetBatchId

func (x *Payment) GetBatchId() string

func (*Payment) GetCost

func (x *Payment) GetCost() *money.Money

func (*Payment) GetDateCreated

func (x *Payment) GetDateCreated() string

func (*Payment) GetDateProcessed

func (x *Payment) GetDateProcessed() string

func (*Payment) GetExternalTransactionId

func (x *Payment) GetExternalTransactionId() string

func (*Payment) GetExtra

func (x *Payment) GetExtra() map[string]string

func (*Payment) GetId

func (x *Payment) GetId() string

func (*Payment) GetOutbound

func (x *Payment) GetOutbound() bool

func (*Payment) GetRecipient added in v1.15.1

func (x *Payment) GetRecipient() *v1.ContactLink

func (*Payment) GetReferenceId

func (x *Payment) GetReferenceId() string

func (*Payment) GetRoute

func (x *Payment) GetRoute() string

func (*Payment) GetSource

func (x *Payment) GetSource() *v1.ContactLink

func (*Payment) GetState

func (x *Payment) GetState() v1.STATE

func (*Payment) GetStatus

func (x *Payment) GetStatus() v1.STATUS

func (*Payment) GetTransactionId

func (x *Payment) GetTransactionId() string

func (*Payment) ProtoMessage

func (*Payment) ProtoMessage()

func (*Payment) ProtoReflect

func (x *Payment) ProtoReflect() protoreflect.Message

func (*Payment) Reset

func (x *Payment) Reset()

func (*Payment) String

func (x *Payment) String() string

type PaymentClient

type PaymentClient struct {
	*common.GrpcClientBase
	// The gRPC API Client.
	Client PaymentServiceClient
}

PaymentClient is a Client for interacting with the payments service API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

func FromContext

func FromContext(ctx context.Context) *PaymentClient

func Init added in v1.9.1

func NewPaymentsClient

func NewPaymentsClient(ctx context.Context, opts ...common.ClientOption) (*PaymentClient, error)

NewPaymentsClient creates a new payments Client. / The service that an application uses to access and manipulate payment information

type PaymentServiceClient

type PaymentServiceClient interface {
	// Send method for queueing outbound payments as requested
	Send(ctx context.Context, in *SendRequest, opts ...grpc.CallOption) (*SendResponse, error)
	// Send method for queueing inbound payments as requested
	Receive(ctx context.Context, in *ReceiveRequest, opts ...grpc.CallOption) (*ReceiveResponse, error)
	// Status request to determine if payment is prepared or released
	Status(ctx context.Context, in *v1.StatusRequest, opts ...grpc.CallOption) (*v1.StatusResponse, error)
	// Status update request to allow continuation of payment processing
	StatusUpdate(ctx context.Context, in *v1.StatusUpdateRequest, opts ...grpc.CallOption) (*v1.StatusUpdateResponse, error)
	// Release method for releasing queued payments and returns if status is not released
	Release(ctx context.Context, in *ReleaseRequest, opts ...grpc.CallOption) (*ReleaseResponse, error)
	// Search method is for client request look for payments matching supplied details from the system
	Search(ctx context.Context, in *v1.SearchRequest, opts ...grpc.CallOption) (PaymentService_SearchClient, error)
	Reconcile(ctx context.Context, in *ReconcileRequest, opts ...grpc.CallOption) (*ReconcileResponse, error)
}

PaymentServiceClient is the client API for PaymentService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

type PaymentServiceServer

type PaymentServiceServer interface {
	// Send method for queueing outbound payments as requested
	Send(context.Context, *SendRequest) (*SendResponse, error)
	// Send method for queueing inbound payments as requested
	Receive(context.Context, *ReceiveRequest) (*ReceiveResponse, error)
	// Status request to determine if payment is prepared or released
	Status(context.Context, *v1.StatusRequest) (*v1.StatusResponse, error)
	// Status update request to allow continuation of payment processing
	StatusUpdate(context.Context, *v1.StatusUpdateRequest) (*v1.StatusUpdateResponse, error)
	// Release method for releasing queued payments and returns if status is not released
	Release(context.Context, *ReleaseRequest) (*ReleaseResponse, error)
	// Search method is for client request look for payments matching supplied details from the system
	Search(*v1.SearchRequest, PaymentService_SearchServer) error
	Reconcile(context.Context, *ReconcileRequest) (*ReconcileResponse, error)
	// contains filtered or unexported methods
}

PaymentServiceServer is the server API for PaymentService service. All implementations must embed UnimplementedPaymentServiceServer for forward compatibility

type PaymentService_SearchClient

type PaymentService_SearchClient interface {
	Recv() (*SearchResponse, error)
	grpc.ClientStream
}

type PaymentService_SearchServer

type PaymentService_SearchServer interface {
	Send(*SearchResponse) error
	grpc.ServerStream
}

type ReceiveRequest

type ReceiveRequest struct {
	Data *Payment `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*ReceiveRequest) Descriptor deprecated

func (*ReceiveRequest) Descriptor() ([]byte, []int)

Deprecated: Use ReceiveRequest.ProtoReflect.Descriptor instead.

func (*ReceiveRequest) GetData

func (x *ReceiveRequest) GetData() *Payment

func (*ReceiveRequest) ProtoMessage

func (*ReceiveRequest) ProtoMessage()

func (*ReceiveRequest) ProtoReflect

func (x *ReceiveRequest) ProtoReflect() protoreflect.Message

func (*ReceiveRequest) Reset

func (x *ReceiveRequest) Reset()

func (*ReceiveRequest) String

func (x *ReceiveRequest) String() string

type ReceiveResponse

type ReceiveResponse struct {
	Data *v1.StatusResponse `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*ReceiveResponse) Descriptor deprecated

func (*ReceiveResponse) Descriptor() ([]byte, []int)

Deprecated: Use ReceiveResponse.ProtoReflect.Descriptor instead.

func (*ReceiveResponse) GetData

func (x *ReceiveResponse) GetData() *v1.StatusResponse

func (*ReceiveResponse) ProtoMessage

func (*ReceiveResponse) ProtoMessage()

func (*ReceiveResponse) ProtoReflect

func (x *ReceiveResponse) ProtoReflect() protoreflect.Message

func (*ReceiveResponse) Reset

func (x *ReceiveResponse) Reset()

func (*ReceiveResponse) String

func (x *ReceiveResponse) String() string

type ReconcileRequest

type ReconcileRequest struct {
	ExternalTransactionId string       `` /* 126-byte string literal not displayed */
	Route                 string       `protobuf:"bytes,2,opt,name=route,proto3" json:"route,omitempty"`
	Outbound              bool         `protobuf:"varint,3,opt,name=outbound,proto3" json:"outbound,omitempty"`
	Amount                *money.Money `protobuf:"bytes,4,opt,name=amount,proto3" json:"amount,omitempty"`
	Owner                 string       `protobuf:"bytes,5,opt,name=owner,proto3" json:"owner,omitempty"`
	CountryCode           string       `protobuf:"bytes,6,opt,name=country_code,json=countryCode,proto3" json:"country_code,omitempty"`
	// contains filtered or unexported fields
}

func (*ReconcileRequest) Descriptor deprecated

func (*ReconcileRequest) Descriptor() ([]byte, []int)

Deprecated: Use ReconcileRequest.ProtoReflect.Descriptor instead.

func (*ReconcileRequest) GetAmount

func (x *ReconcileRequest) GetAmount() *money.Money

func (*ReconcileRequest) GetCountryCode

func (x *ReconcileRequest) GetCountryCode() string

func (*ReconcileRequest) GetExternalTransactionId

func (x *ReconcileRequest) GetExternalTransactionId() string

func (*ReconcileRequest) GetOutbound

func (x *ReconcileRequest) GetOutbound() bool

func (*ReconcileRequest) GetOwner

func (x *ReconcileRequest) GetOwner() string

func (*ReconcileRequest) GetRoute

func (x *ReconcileRequest) GetRoute() string

func (*ReconcileRequest) ProtoMessage

func (*ReconcileRequest) ProtoMessage()

func (*ReconcileRequest) ProtoReflect

func (x *ReconcileRequest) ProtoReflect() protoreflect.Message

func (*ReconcileRequest) Reset

func (x *ReconcileRequest) Reset()

func (*ReconcileRequest) String

func (x *ReconcileRequest) String() string

type ReconcileResponse

type ReconcileResponse struct {
	Id            string    `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	TransactionId string    `protobuf:"bytes,2,opt,name=transaction_id,json=transactionId,proto3" json:"transaction_id,omitempty"`
	ReferenceId   string    `protobuf:"bytes,3,opt,name=reference_id,json=referenceId,proto3" json:"reference_id,omitempty"`
	Status        v1.STATUS `protobuf:"varint,4,opt,name=status,proto3,enum=common.v1.STATUS" json:"status,omitempty"`
	Description   string    `protobuf:"bytes,5,opt,name=description,proto3" json:"description,omitempty"`
	// contains filtered or unexported fields
}

func (*ReconcileResponse) Descriptor deprecated

func (*ReconcileResponse) Descriptor() ([]byte, []int)

Deprecated: Use ReconcileResponse.ProtoReflect.Descriptor instead.

func (*ReconcileResponse) GetDescription

func (x *ReconcileResponse) GetDescription() string

func (*ReconcileResponse) GetId

func (x *ReconcileResponse) GetId() string

func (*ReconcileResponse) GetReferenceId

func (x *ReconcileResponse) GetReferenceId() string

func (*ReconcileResponse) GetStatus

func (x *ReconcileResponse) GetStatus() v1.STATUS

func (*ReconcileResponse) GetTransactionId

func (x *ReconcileResponse) GetTransactionId() string

func (*ReconcileResponse) ProtoMessage

func (*ReconcileResponse) ProtoMessage()

func (*ReconcileResponse) ProtoReflect

func (x *ReconcileResponse) ProtoReflect() protoreflect.Message

func (*ReconcileResponse) Reset

func (x *ReconcileResponse) Reset()

func (*ReconcileResponse) String

func (x *ReconcileResponse) String() string

type ReleaseRequest

type ReleaseRequest struct {
	AccessId string `protobuf:"bytes,1,opt,name=access_id,json=accessId,proto3" json:"access_id,omitempty"`
	Id       string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
	Comment  string `protobuf:"bytes,3,opt,name=comment,proto3" json:"comment,omitempty"`
	// contains filtered or unexported fields
}

func (*ReleaseRequest) Descriptor deprecated

func (*ReleaseRequest) Descriptor() ([]byte, []int)

Deprecated: Use ReleaseRequest.ProtoReflect.Descriptor instead.

func (*ReleaseRequest) GetAccessId

func (x *ReleaseRequest) GetAccessId() string

func (*ReleaseRequest) GetComment

func (x *ReleaseRequest) GetComment() string

func (*ReleaseRequest) GetId

func (x *ReleaseRequest) GetId() string

func (*ReleaseRequest) ProtoMessage

func (*ReleaseRequest) ProtoMessage()

func (*ReleaseRequest) ProtoReflect

func (x *ReleaseRequest) ProtoReflect() protoreflect.Message

func (*ReleaseRequest) Reset

func (x *ReleaseRequest) Reset()

func (*ReleaseRequest) String

func (x *ReleaseRequest) String() string

type ReleaseResponse

type ReleaseResponse struct {
	Data *v1.StatusResponse `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*ReleaseResponse) Descriptor deprecated

func (*ReleaseResponse) Descriptor() ([]byte, []int)

Deprecated: Use ReleaseResponse.ProtoReflect.Descriptor instead.

func (*ReleaseResponse) GetData

func (x *ReleaseResponse) GetData() *v1.StatusResponse

func (*ReleaseResponse) ProtoMessage

func (*ReleaseResponse) ProtoMessage()

func (*ReleaseResponse) ProtoReflect

func (x *ReleaseResponse) ProtoReflect() protoreflect.Message

func (*ReleaseResponse) Reset

func (x *ReleaseResponse) Reset()

func (*ReleaseResponse) String

func (x *ReleaseResponse) String() string

type SearchResponse

type SearchResponse struct {
	Data []*Payment `protobuf:"bytes,1,rep,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*SearchResponse) Descriptor deprecated

func (*SearchResponse) Descriptor() ([]byte, []int)

Deprecated: Use SearchResponse.ProtoReflect.Descriptor instead.

func (*SearchResponse) GetData

func (x *SearchResponse) GetData() []*Payment

func (*SearchResponse) ProtoMessage

func (*SearchResponse) ProtoMessage()

func (*SearchResponse) ProtoReflect

func (x *SearchResponse) ProtoReflect() protoreflect.Message

func (*SearchResponse) Reset

func (x *SearchResponse) Reset()

func (*SearchResponse) String

func (x *SearchResponse) String() string

type SendRequest

type SendRequest struct {
	Data *Payment `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*SendRequest) Descriptor deprecated

func (*SendRequest) Descriptor() ([]byte, []int)

Deprecated: Use SendRequest.ProtoReflect.Descriptor instead.

func (*SendRequest) GetData

func (x *SendRequest) GetData() *Payment

func (*SendRequest) ProtoMessage

func (*SendRequest) ProtoMessage()

func (*SendRequest) ProtoReflect

func (x *SendRequest) ProtoReflect() protoreflect.Message

func (*SendRequest) Reset

func (x *SendRequest) Reset()

func (*SendRequest) String

func (x *SendRequest) String() string

type SendResponse

type SendResponse struct {
	Data *v1.StatusResponse `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*SendResponse) Descriptor deprecated

func (*SendResponse) Descriptor() ([]byte, []int)

Deprecated: Use SendResponse.ProtoReflect.Descriptor instead.

func (*SendResponse) GetData

func (x *SendResponse) GetData() *v1.StatusResponse

func (*SendResponse) ProtoMessage

func (*SendResponse) ProtoMessage()

func (*SendResponse) ProtoReflect

func (x *SendResponse) ProtoReflect() protoreflect.Message

func (*SendResponse) Reset

func (x *SendResponse) Reset()

func (*SendResponse) String

func (x *SendResponse) String() string

type UnimplementedPaymentServiceServer

type UnimplementedPaymentServiceServer struct {
}

UnimplementedPaymentServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedPaymentServiceServer) Receive

func (UnimplementedPaymentServiceServer) Reconcile

func (UnimplementedPaymentServiceServer) Release

func (UnimplementedPaymentServiceServer) Search

func (UnimplementedPaymentServiceServer) Send

func (UnimplementedPaymentServiceServer) Status

func (UnimplementedPaymentServiceServer) StatusUpdate

type UnsafePaymentServiceServer

type UnsafePaymentServiceServer interface {
	// contains filtered or unexported methods
}

UnsafePaymentServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to PaymentServiceServer will result in compilation errors.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL