links

Documentation

Index

• Constants
• type Client
  • func NewClient(configuration *configuration.Configuration, apiClient client.HttpClient) *Client
  • func (c *Client) CreatePaymentLink(request PaymentLinkRequest) (*PaymentLinkResponse, error)
  • func (c *Client) CreatePaymentLinkWithContext(ctx context.Context, request PaymentLinkRequest) (*PaymentLinkResponse, error)
  • func (c *Client) GetPaymentLink(paymentLinkId string) (*PaymentLinkDetails, error)
  • func (c *Client) GetPaymentLinkWithContext(ctx context.Context, paymentLinkId string) (*PaymentLinkDetails, error)
• type PaymentLinkDetails
• type PaymentLinkRequest
• type PaymentLinkResponse
• type PaymentStatus

Constants

const PaymentLinksPath = "payment-links"

Types

type Client

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

func NewClient

func NewClient(configuration *configuration.Configuration, apiClient client.HttpClient) *Client

func (*Client) CreatePaymentLink

func (c *Client) CreatePaymentLink(request PaymentLinkRequest) (*PaymentLinkResponse, error)

func (*Client) CreatePaymentLinkWithContext

func (c *Client) CreatePaymentLinkWithContext(ctx context.Context, request PaymentLinkRequest) (*PaymentLinkResponse, error)

func (*Client) GetPaymentLink

func (c *Client) GetPaymentLink(paymentLinkId string) (*PaymentLinkDetails, error)

func (*Client) GetPaymentLinkWithContext

func (c *Client) GetPaymentLinkWithContext(ctx context.Context, paymentLinkId string) (*PaymentLinkDetails, error)

type PaymentLinkDetails

type PaymentLinkDetails struct {
	HttpMetadata common.HttpMetadata
	Id           string                       `json:"id,omitempty"`
	Status       PaymentStatus                `json:"status,omitempty"`
	PaymentId    string                       `json:"payment_id,omitempty"`
	Amount       int                          `json:"amount,omitempty"`
	Currency     common.Currency              `json:"currency,omitempty"`
	Reference    string                       `json:"reference,omitempty"`
	Description  string                       `json:"description,omitempty"`
	CreatedOn    string                       `json:"created_on,omitempty"`
	ExpiresOn    string                       `json:"expires_on,omitempty"`
	Customer     *common.CustomerRequest      `json:"customer,omitempty"`
	Shipping     *payments.ShippingDetails    `json:"shipping,omitempty"`
	Billing      *payments.BillingInformation `json:"billing,omitempty"`
	Products     []payments.Product           `json:"products,omitempty"`
	Metadata     map[string]interface{}       `json:"metadata,omitempty"`
	Locale       string                       `json:"locale,omitempty"`
	ReturnUrl    string                       `json:"return_url,omitempty"`
	Links        map[string]common.Link       `json:"_links"`
	//Not available on previous
	ProcessingChannelId string                     `json:"processing_channel_id,omitempty"`
	AmountAllocations   []common.AmountAllocations `json:"amount_allocations,omitempty"`
}

type PaymentLinkRequest

type PaymentLinkRequest struct {
	Amount              int                          `json:"amount,omitempty"`
	Currency            common.Currency              `json:"currency,omitempty"`
	PaymentType         payments.PaymentType         `json:"payment_type,omitempty,omitempty"`
	PaymentIp           string                       `json:"payment_ip,omitempty"`
	BillingDescriptor   *payments.BillingDescriptor  `json:"billing_descriptor,omitempty"`
	Reference           string                       `json:"reference,omitempty"`
	Description         string                       `json:"description,omitempty"`
	ExpiresIn           int                          `json:"expires_in,omitempty"`
	Customer            *common.CustomerRequest      `json:"customer,omitempty"`
	Shipping            *payments.ShippingDetails    `json:"shipping,omitempty"`
	Billing             *payments.BillingInformation `json:"billing,omitempty"`
	Recipient           *payments.PaymentRecipient   `json:"recipient,omitempty"`
	Processing          *payments.ProcessingSettings `json:"processing,omitempty"`
	AllowPaymentMethods []payments.SourceType        `json:"allow_payment_methods,omitempty"`
	Products            []payments.Product           `json:"products,omitempty"`
	Metadata            map[string]interface{}       `json:"metadata,omitempty"`
	ThreeDs             *payments.ThreeDsRequest     `json:"3ds,omitempty"`
	Risk                *payments.RiskRequest        `json:"risk,omitempty"`
	ReturnUrl           string                       `json:"return_url,omitempty"`
	Locale              string                       `json:"locale,omitempty"`
	Capture             bool                         `json:"capture,omitempty"`
	CaptureOn           *time.Time                   `json:"capture_on,omitempty"`
	//Not available on previous
	ProcessingChannelId string                     `json:"processing_channel_id,omitempty"`
	AmountAllocations   []common.AmountAllocations `json:"amount_allocations,omitempty"`
}

type PaymentLinkResponse

type PaymentLinkResponse struct {
	HttpMetadata common.HttpMetadata
	Id           string                 `json:"id,omitempty"`
	ExpiresOn    string                 `json:"expires_on,omitempty"`
	Reference    string                 `json:"reference,omitempty"`
	Warnings     []interface{}          `json:"warnings,omitempty"`
	Links        map[string]common.Link `json:"_links"`
}

type PaymentStatus

type PaymentStatus string

const (
	Active          PaymentStatus = "Active"
	PaymentReceived PaymentStatus = "Payment Received"
	Expired         PaymentStatus = "Expired"
)