tokens

Documentation

Index

• type Client
  • func NewClient(parent *apiresource.APIResource, pathContext map[string]string) *Client
  • func (c *Client) Approvesepadirectdebit(tokenID string, body token.ApproveRequest, context communication.CallContext) error
  • func (c *Client) Create(body token.CreateRequest, context communication.CallContext) (token.CreateResponse, error)
  • func (c *Client) Delete(tokenID string, query DeleteParams, context communication.CallContext) error
  • func (c *Client) Get(tokenID string, context communication.CallContext) (token.Response, error)
  • func (c *Client) Update(tokenID string, body token.UpdateRequest, context communication.CallContext) error
• type DeleteParams
  • func NewDeleteParams() *DeleteParams
  • func (params *DeleteParams) ToRequestParameters() communicator.RequestParams

Types

type Client

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

Client represents a tokens client. Thread-safe.

func NewClient

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

NewClient constructs a Tokens Client

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

func (*Client) Approvesepadirectdebit

func (c *Client) Approvesepadirectdebit(tokenID string, body token.ApproveRequest, context communication.CallContext) error

Approvesepadirectdebit represents the resource /{merchantId}/tokens/{tokenId}/approvesepadirectdebit - Approve SEPA DD mandate Documentation can be found at https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/go/tokens/approvesepadirectdebit.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) Create

func (c *Client) Create(body token.CreateRequest, context communication.CallContext) (token.CreateResponse, error)

Create represents the resource /{merchantId}/tokens - Create token Documentation can be found at https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/go/tokens/create.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) Delete

func (c *Client) Delete(tokenID string, query DeleteParams, context communication.CallContext) error

Delete represents the resource /{merchantId}/tokens/{tokenId} - Delete token Documentation can be found at https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/go/tokens/delete.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) Get

func (c *Client) Get(tokenID string, context communication.CallContext) (token.Response, error)

Get represents the resource /{merchantId}/tokens/{tokenId} - Get token Documentation can be found at https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/go/tokens/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) Update

func (c *Client) Update(tokenID string, body token.UpdateRequest, context communication.CallContext) error

Update represents the resource /{merchantId}/tokens/{tokenId} - Update token Documentation can be found at https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/go/tokens/update.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

type DeleteParams

type DeleteParams struct {
	MandateCancelDate *string
}

DeleteParams represents query parameters for Delete token Documentation can be found at https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/go/tokens/delete.html

func NewDeleteParams

func NewDeleteParams() *DeleteParams

NewDeleteParams constructs an instance of DeleteParams

func (*DeleteParams) ToRequestParameters

func (params *DeleteParams) ToRequestParameters() communicator.RequestParams

ToRequestParameters converts the query to communicator.RequestParams