captures

Documentation

Index

• type Client
  • func NewClient(parent *apiresource.APIResource, pathContext map[string]string) *Client
  • func (c *Client) Get(captureID string, context communication.CallContext) (capture.Response, error)
  • func (c *Client) Refund(captureID string, body refund.Request, context communication.CallContext) (refund.Response, error)

Types

type Client

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

Client represents a captures client. Thread-safe.

func NewClient

func NewClient(parent *apiresource.APIResource, pathContext map[string]string) *Client

NewClient constructs a Captures Client

parent is the *apiresource.APIResource on top of which we want to build the new Captures Client

func (*Client) Get

func (c *Client) Get(captureID string, context communication.CallContext) (capture.Response, error)

Get represents the resource /{merchantId}/captures/{captureId} - Get capture Documentation can be found at https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/go/captures/get.html

Can return any of the following errors: * ValidationError if the request was not correct and couldn't be processed (HTTP status code 400) * AuthorizationError if the request was not allowed (HTTP status code 403) * IdempotenceError if an idempotent request caused a conflict (HTTP status code 409) * ReferenceError if an object was attempted to be referenced that doesn't exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410) * GlobalCollectError if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503) * APIError if the Ingenico ePayments platform returned any other error

func (*Client) Refund

func (c *Client) Refund(captureID string, body refund.Request, context communication.CallContext) (refund.Response, error)

Refund represents the resource /{merchantId}/captures/{captureId}/refund - Create Refund Documentation can be found at https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/go/captures/refund.html

Can return any of the following errors: * DeclinedRefundError if the Ingenico ePayments platform declined / rejected the refund. The refund result will be available from the exception. * ValidationError if the request was not correct and couldn't be processed (HTTP status code 400) * AuthorizationError if the request was not allowed (HTTP status code 403) * IdempotenceError if an idempotent request caused a conflict (HTTP status code 409) * ReferenceError if an object was attempted to be referenced that doesn't exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410) * GlobalCollectError if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503) * APIError if the Ingenico ePayments platform returned any other error