mandates

package
v0.0.0-...-1f8cd32 Latest Latest
Warning

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

 Go to latest Published: Mar 18, 2024 License: BSD-3-Clause, MIT Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client 

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

Client represents a mandates client. Thread-safe.

func NewClient 

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

NewClient constructs a Mandates Client

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

func (*Client) Block 

func (c *Client) Block(uniqueMandateReference string, context communication.CallContext) (mandates.GetMandateResponse, error)

Block represents the resource /{merchantId}/mandates/{uniqueMandateReference}/block - Block mandate Documentation can be found at https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/go/mandates/block.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 mandates.CreateMandateRequest, context communication.CallContext) (mandates.CreateMandateResponse, error)

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

func (c *Client) CreateWithMandateReference(uniqueMandateReference string, body mandates.CreateMandateRequest, context communication.CallContext) (mandates.CreateMandateResponse, error)

CreateWithMandateReference represents the resource /{merchantId}/mandates/{uniqueMandateReference} - Create mandate with mandatereference Documentation can be found at https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/go/mandates/createWithMandateReference.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(uniqueMandateReference string, context communication.CallContext) (mandates.GetMandateResponse, error)

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

func (c *Client) Revoke(uniqueMandateReference string, context communication.CallContext) (mandates.GetMandateResponse, error)

Revoke represents the resource /{merchantId}/mandates/{uniqueMandateReference}/revoke - Revoke mandate Documentation can be found at https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/go/mandates/revoke.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) Unblock 

func (c *Client) Unblock(uniqueMandateReference string, context communication.CallContext) (mandates.GetMandateResponse, error)

Unblock represents the resource /{merchantId}/mandates/{uniqueMandateReference}/unblock - Unblock mandate Documentation can be found at https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/go/mandates/unblock.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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.