webhooks

Documentation

Index

• type Client
  • func NewClient(config checkout.Config) *Client
  • func (c *Client) PartiallyUpdateWebhook(webhookID string, request *Request) (*Response, error)
  • func (c *Client) RegisterWebhook(request *Request) (*Response, error)
  • func (c *Client) RemoveWebhook(webhookID string) (*Response, error)
  • func (c *Client) Retrieve() (*Response, error)
  • func (c *Client) RetrieveWebhook(webhookID string) (*Response, error)
  • func (c *Client) UpdateWebhook(webhookID string, request *Request) (*Response, error)
• type Headers
• type Request
• type Response
• type Webhook
• type WebhookEvent
• type WebhookResponse

Types

type Client

type Client struct {
	API checkout.HTTPClient
}

Client ...

func NewClient

func NewClient(config checkout.Config) *Client

NewClient ...

func (*Client) PartiallyUpdateWebhook

func (c *Client) PartiallyUpdateWebhook(webhookID string, request *Request) (*Response, error)

PartiallyUpdateWebhook ...

func (*Client) RegisterWebhook

func (c *Client) RegisterWebhook(request *Request) (*Response, error)

RegisterWebhook ...

func (*Client) RemoveWebhook

func (c *Client) RemoveWebhook(webhookID string) (*Response, error)

RemoveWebhook ...

func (*Client) Retrieve

func (c *Client) Retrieve() (*Response, error)

Retrieve ...

func (*Client) RetrieveWebhook

func (c *Client) RetrieveWebhook(webhookID string) (*Response, error)

RetrieveWebhook ...

func (*Client) UpdateWebhook

func (c *Client) UpdateWebhook(webhookID string, request *Request) (*Response, error)

UpdateWebhook ...

type Headers

type Headers struct {
	Authorization string `json:"Authorization,omitempty"`
}

Headers ...

type Request

type Request struct {
	*Webhook
}

Request -

type Response

type Response struct {
	StatusResponse     *checkout.StatusResponse `json:"api_response,omitempty"`
	ConfiguredWebhooks []WebhookResponse        `json:"webhooks,omitempty"`
	Webhook            *WebhookResponse         `json:"webhook,omitempty"`
}

Response -

type Webhook

type Webhook struct {
	URL         string                    `json:"url,omitempty"`
	Active      *bool                     `json:"active,omitempty"`
	Headers     *Headers                  `json:"headers,omitempty"`
	ContentType common.WebhookContentType `json:"content_type,omitempty"`
	EventTypes  []WebhookEvent            `json:"event_types,omitempty"`
}

Webhook ...

type WebhookEvent

type WebhookEvent string

const (
	CardVerifiedEvent             WebhookEvent = "card_verified"
	CardVerificationDeclinedEvent WebhookEvent = "card_verification_declined"
	DisputeCanceledEvent          WebhookEvent = "dispute_canceled"
	DisputeEvidenceRequiredEvent  WebhookEvent = "dispute_evidence_required"
	DisputeExpiredEvent           WebhookEvent = "dispute_expired"
	DisputeLostEvent              WebhookEvent = "dispute_lost"
	DisputeResolvedEvent          WebhookEvent = "dispute_resolved"
	DisputeWonEvent               WebhookEvent = "dispute_won"
	PaymentApprovedEvent          WebhookEvent = "payment_approved"
	PaymentPendingEvent           WebhookEvent = "payment_pending"
	PaymentDeclinedEvent          WebhookEvent = "payment_declined"
	PaymentExpiredEvent           WebhookEvent = "payment_expired"
	PaymentVoidedEvent            WebhookEvent = "payment_voided"
	PaymentCanceledEvent          WebhookEvent = "payment_canceled"
	PaymentVoidDeclinedEvent      WebhookEvent = "payment_void_declined"
	PaymentCapturedEvent          WebhookEvent = "payment_captured"
	PaymentCaptureDeclinedEvent   WebhookEvent = "payment_capture_declined"
	PaymentCapturePendingEvent    WebhookEvent = "payment_capture_pending"
	PaymentRefundedEvent          WebhookEvent = "payment_refunded"
	PaymentRefundDeclinedEvent    WebhookEvent = "payment_refund_declined"
	PaymentRefundPendingEvent     WebhookEvent = "payment_refund_pending"
	PaymentChargebackEvent        WebhookEvent = "payment_chargeback"
	PaymentRetrievalEvent         WebhookEvent = "payment_retrieval"
	SourceUpdatedEvent            WebhookEvent = "source_updated"
	PaymentPaidEvent              WebhookEvent = "payment_paid"
)

type WebhookResponse

type WebhookResponse struct {
	ID          string                    `json:"id,omitempty"`
	URL         string                    `json:"url,omitempty"`
	Active      *bool                     `json:"active,omitempty"`
	Headers     *Headers                  `json:"headers,omitempty"`
	ContentType common.WebhookContentType `json:"content_type,omitempty"`
	EventTypes  []WebhookEvent            `json:"event_types,omitempty"`
	Links       map[string]common.Link    `json:"_links,omitempty"`
	Version     string                    `json:"version,omitempty"`
}

WebhookResponse -