platformsnotificationconfiguration

package
v8.2.0 Latest Latest
Warning

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

 Go to latest Published: Dec 19, 2023 License: MIT Imports: 3 Imported by: 0

README

Go API client for platformsnotificationconfiguration

The Notification Configuration API provides endpoints for setting up and testing notifications that inform you of events on your platform, for example when a KYC check or a payout has been completed.

For more information, refer to our documentation.

Authentication

To connect to the Notification Configuration API, you must use basic authentication credentials of your web service user. If you don't have one, contact our Adyen Support Team. Then use its credentials to authenticate your request, for example:

curl
-U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\
-H \"Content-Type: application/json\" \\
...

Note that when going live, you need to generate new web service user credentials to access the live endpoints.

Versioning

The Notification Configuration API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: "vXX", where XX is the version number.

For example:

https://cal-test.adyen.com/cal/services/Notification/v6/createNotificationConfiguration

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 6
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientExperimentalCodegen For more information, please visit https://support.adyen.com/

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CreateNotificationConfigurationRequest 

type CreateNotificationConfigurationRequest struct {
	ConfigurationDetails NotificationConfigurationDetails `json:"configurationDetails"`
}

CreateNotificationConfigurationRequest struct for CreateNotificationConfigurationRequest

type DeleteNotificationConfigurationRequest 

type DeleteNotificationConfigurationRequest struct {
	// A list of IDs of the notification subscription configurations to be deleted.
	NotificationIds []int64 `json:"notificationIds"`
}

DeleteNotificationConfigurationRequest struct for DeleteNotificationConfigurationRequest

type ErrorFieldType 

type ErrorFieldType struct {
	// The validation error code.
	ErrorCode int32 `json:"errorCode,omitempty"`
	// A description of the validation error.
	ErrorDescription string     `json:"errorDescription,omitempty"`
	FieldType        *FieldType `json:"fieldType,omitempty"`
}

ErrorFieldType struct for ErrorFieldType

type ExchangeMessage 

type ExchangeMessage struct {
	MessageCode        string `json:"messageCode,omitempty"`
	MessageDescription string `json:"messageDescription,omitempty"`
}

ExchangeMessage struct for ExchangeMessage

type FieldType 

type FieldType struct {
	// The full name of the property.
	Field string `json:"field,omitempty"`
	// The type of the field.
	FieldName string `json:"fieldName,omitempty"`
	// The code of the shareholder that the field belongs to. If empty, the field belongs to an account holder.
	ShareholderCode string `json:"shareholderCode,omitempty"`
}

FieldType struct for FieldType

type GenericResponse 

type GenericResponse struct {
	// Contains field validation errors that would prevent requests from being processed.
	InvalidFields *[]ErrorFieldType `json:"invalidFields,omitempty"`
	// The reference of a request. Can be used to uniquely identify the request.
	PspReference string `json:"pspReference,omitempty"`
	// The result code.
	ResultCode string `json:"resultCode,omitempty"`
}

GenericResponse struct for GenericResponse

type GetNotificationConfigurationListResponse 

type GetNotificationConfigurationListResponse struct {
	// Details of the notification subscription configurations.
	Configurations []NotificationConfigurationDetails `json:"configurations"`
	// Contains field validation errors that would prevent requests from being processed.
	InvalidFields *[]ErrorFieldType `json:"invalidFields,omitempty"`
	// The reference of a request. Can be used to uniquely identify the request.
	PspReference string `json:"pspReference,omitempty"`
	// The result code.
	ResultCode string `json:"resultCode,omitempty"`
}

GetNotificationConfigurationListResponse struct for GetNotificationConfigurationListResponse

type GetNotificationConfigurationRequest 

type GetNotificationConfigurationRequest struct {
	// The ID of the notification subscription configuration whose details are to be retrieved.
	NotificationId int64 `json:"notificationId"`
}

GetNotificationConfigurationRequest struct for GetNotificationConfigurationRequest

type GetNotificationConfigurationResponse 

type GetNotificationConfigurationResponse struct {
	ConfigurationDetails NotificationConfigurationDetails `json:"configurationDetails"`
	// Contains field validation errors that would prevent requests from being processed.
	InvalidFields *[]ErrorFieldType `json:"invalidFields,omitempty"`
	// The reference of a request. Can be used to uniquely identify the request.
	PspReference string `json:"pspReference,omitempty"`
	// The result code.
	ResultCode string `json:"resultCode,omitempty"`
}

GetNotificationConfigurationResponse struct for GetNotificationConfigurationResponse

type NotificationConfigurationDetails 

type NotificationConfigurationDetails struct {
	// Indicates whether the notification subscription is active.
	Active bool `json:"active,omitempty"`
	// The API version of the notification to send.
	ApiVersion int32 `json:"apiVersion,omitempty"`
	// A description of the notification subscription configuration.
	Description string `json:"description,omitempty"`
	// The types of events whose notifications apply to this configuration.
	EventConfigs []NotificationEventConfiguration `json:"eventConfigs"`
	// A string with which to salt the notification(s) before hashing. If this field is provided, a hash value will be included under the notification header `HmacSignature` and the hash protocol will be included under the notification header `Protocol`. A notification body along with its `hmacSignatureKey` and `Protocol` can be used to calculate a hash value; matching this hash value with the `HmacSignature` will ensure that the notification body has not been tampered with or corrupted.  >Must be a 32-byte hex-encoded string (i.e. a string containing 64 hexadecimal characters; e.g. \"b0ea55c2fe60d4d1d605e9c385e0e7f7e6cafbb939ce07010f31a327a0871f27\").  The omission of this field will preclude the provision of the `HmacSignature` and `Protocol` headers in notification(s).
	HmacSignatureKey string `json:"hmacSignatureKey,omitempty"`
	// The ID of the configuration. >Required if updating an existing configuration, ignored during the creation of a configuration.
	NotificationId int64 `json:"notificationId,omitempty"`
	// The password to use when accessing the notifyURL with the specified username.
	NotifyPassword string `json:"notifyPassword,omitempty"`
	// The URL to which the notifications are to be sent.
	NotifyURL string `json:"notifyURL"`
	// The username to use when accessing the notifyURL.
	NotifyUsername string `json:"notifyUsername,omitempty"`
	// The SSL protocol employed by the endpoint. >Permitted values: `SSL`, `SSLInsecureCiphers`, `TLS`, `TLSv10`, `TLSv10InsecureCiphers`, `TLSv11`, `TLSv12`.
	SslProtocol string `json:"sslProtocol,omitempty"`
}

NotificationConfigurationDetails struct for NotificationConfigurationDetails

type NotificationEventConfiguration 

type NotificationEventConfiguration struct {
	// The type of event triggering the notification. >Permitted values: `ACCOUNT_HOLDER_CREATED`, `ACCOUNT_CREATED`, `ACCOUNT_UPDATED`, `ACCOUNT_HOLDER_UPDATED`, `ACCOUNT_HOLDER_STATUS_CHANGE`, `ACCOUNT_HOLDER_STORE_STATUS_CHANGE`, `ACCOUNT_HOLDER_VERIFICATION`, `ACCOUNT_HOLDER_LIMIT_REACHED`, `ACCOUNT_HOLDER_PAYOUT`, `PAYMENT_FAILURE`, `SCHEDULED_REFUNDS`, `REPORT_AVAILABLE`, `TRANSFER_FUNDS`, `BENEFICIARY_SETUP`, `COMPENSATE_NEGATIVE_BALANCE`.
	EventType string `json:"eventType"`
	// Indicates whether the specified eventType is to be sent to the endpoint or all events other than the specified eventType (and other specified eventTypes) are to be sent. >Permitted values: `INCLUDE`, `EXCLUDE`. >- `INCLUDE`: send the specified eventType. >- `EXCLUDE`: send all eventTypes other than the specified eventType (and other eventTypes marked with `EXCLUDE`).
	IncludeMode string `json:"includeMode"`
}

NotificationEventConfiguration struct for NotificationEventConfiguration

type PlatformsNotificationConfiguration 

type PlatformsNotificationConfiguration common.Service

PlatformsNotificationConfiguration PlatformsNotificationConfiguration service Deprecated: Please migrate to the new Adyen For Platforms.

func (PlatformsNotificationConfiguration) CreateNotificationConfiguration 

func (a PlatformsNotificationConfiguration) CreateNotificationConfiguration(req *CreateNotificationConfigurationRequest, ctxs ..._context.Context) (GetNotificationConfigurationResponse, *_nethttp.Response, error)

PostCreateNotificationConfiguration Subscribe to notifications. Creates a subscription to notifications informing you of events on your platform. After the subscription is created, the events specified in the configuration will be sent to the URL specified in the configuration. Subscriptions must be configured on a per-event basis (as opposed to, for example, a per-account holder basis), so all event notifications of a marketplace and of a given type will be sent to the same endpoint(s). A marketplace may have multiple endpoints if desired; an event notification may be sent to as many or as few different endpoints as configured.

  • @param request CreateNotificationConfigurationRequest - reference of CreateNotificationConfigurationRequest).
  • @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return GetNotificationConfigurationResponse

func (PlatformsNotificationConfiguration) DeleteNotificationConfigurations 

func (a PlatformsNotificationConfiguration) DeleteNotificationConfigurations(req *DeleteNotificationConfigurationRequest, ctxs ..._context.Context) (GenericResponse, *_nethttp.Response, error)

PostDeleteNotificationConfigurations Delete an existing notification subscription configuration. This endpoint is used to delete an existing notification subscription configuration. After the subscription is deleted, no further event notifications will be sent to the URL that was in the subscription.

  • @param request DeleteNotificationConfigurationRequest - reference of DeleteNotificationConfigurationRequest).
  • @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return GenericResponse

func (PlatformsNotificationConfiguration) GetNotificationConfiguration 

func (a PlatformsNotificationConfiguration) GetNotificationConfiguration(req *GetNotificationConfigurationRequest, ctxs ..._context.Context) (GetNotificationConfigurationResponse, *_nethttp.Response, error)

PostGetNotificationConfiguration Retrieve an existing notification subscription configuration. This endpoint is used to retrieve the details of the configuration of a notification subscription.

  • @param request GetNotificationConfigurationRequest - reference of GetNotificationConfigurationRequest).
  • @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return GetNotificationConfigurationResponse

func (PlatformsNotificationConfiguration) GetNotificationConfigurationList 

func (a PlatformsNotificationConfiguration) GetNotificationConfigurationList(req interface{}, ctxs ..._context.Context) (GetNotificationConfigurationListResponse, *_nethttp.Response, error)

PostGetNotificationConfigurationList Retrieve a list of existing notification subscription configurations. This endpoint is used to retrieve the details of the configurations of all of the notification subscriptions in the marketplace of the executing user.

  • @param request Body - reference of interface{}).
  • @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return GetNotificationConfigurationListResponse

func (PlatformsNotificationConfiguration) TestNotificationConfiguration 

func (a PlatformsNotificationConfiguration) TestNotificationConfiguration(req *TestNotificationConfigurationRequest, ctxs ..._context.Context) (TestNotificationConfigurationResponse, *_nethttp.Response, error)

PostTestNotificationConfiguration Test an existing notification configuration. This endpoint is used to test an existing notification subscription configuration. For each event type specified, a test notification will be generated and sent to the URL configured in the subscription specified.

  • @param request TestNotificationConfigurationRequest - reference of TestNotificationConfigurationRequest).
  • @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return TestNotificationConfigurationResponse

func (PlatformsNotificationConfiguration) UpdateNotificationConfiguration 

func (a PlatformsNotificationConfiguration) UpdateNotificationConfiguration(req *UpdateNotificationConfigurationRequest, ctxs ..._context.Context) (GetNotificationConfigurationResponse, *_nethttp.Response, error)

PostUpdateNotificationConfiguration Update an existing notification subscription configuration. This endpoint is used to update an existing notification subscription configuration. If updating the event types, all event types desired must be provided, otherwise the previous event type configuration will be overwritten.

  • @param request UpdateNotificationConfigurationRequest - reference of UpdateNotificationConfigurationRequest).
  • @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return GetNotificationConfigurationResponse

type TestNotificationConfigurationRequest 

type TestNotificationConfigurationRequest struct {
	// The event types to test.  If left blank, then all of the configured event types will be tested. >Permitted values: `ACCOUNT_HOLDER_CREATED`, `ACCOUNT_CREATED`, `ACCOUNT_UPDATED`, `ACCOUNT_HOLDER_UPDATED`, `ACCOUNT_HOLDER_STATUS_CHANGE`, `ACCOUNT_HOLDER_STORE_STATUS_CHANGE` `ACCOUNT_HOLDER_VERIFICATION`, `ACCOUNT_HOLDER_LIMIT_REACHED`, `ACCOUNT_HOLDER_PAYOUT`, `PAYMENT_FAILURE`, `SCHEDULED_REFUNDS`, `REPORT_AVAILABLE`, `TRANSFER_FUNDS`, `BENEFICIARY_SETUP`, `COMPENSATE_NEGATIVE_BALANCE`.
	EventTypes []string `json:"eventTypes,omitempty"`
	// The ID of the notification subscription configuration to be tested.
	NotificationId int64 `json:"notificationId"`
}

TestNotificationConfigurationRequest struct for TestNotificationConfigurationRequest

type TestNotificationConfigurationResponse 

type TestNotificationConfigurationResponse struct {
	// Any error messages encountered.
	ErrorMessages []string `json:"errorMessages,omitempty"`
	// The event types that were tested. >Permitted values: `ACCOUNT_HOLDER_CREATED`, `ACCOUNT_CREATED`, `ACCOUNT_UPDATED`, `ACCOUNT_HOLDER_UPDATED`, `ACCOUNT_HOLDER_STATUS_CHANGE`, `ACCOUNT_HOLDER_STORE_STATUS_CHANGE` `ACCOUNT_HOLDER_VERIFICATION`, `ACCOUNT_HOLDER_LIMIT_REACHED`, `ACCOUNT_HOLDER_PAYOUT`, `PAYMENT_FAILURE`, `SCHEDULED_REFUNDS`, `REPORT_AVAILABLE`, `TRANSFER_FUNDS`, `BENEFICIARY_SETUP`, `COMPENSATE_NEGATIVE_BALANCE`.
	EventTypes []string `json:"eventTypes"`
	// The notification message and related response messages.
	ExchangeMessages []ExchangeMessage `json:"exchangeMessages"`
	// Contains field validation errors that would prevent requests from being processed.
	InvalidFields *[]ErrorFieldType `json:"invalidFields,omitempty"`
	// The ID of the notification subscription configuration.
	NotificationId int64 `json:"notificationId"`
	// A list of messages describing the testing steps.
	OkMessages []string `json:"okMessages"`
	// The reference of a request. Can be used to uniquely identify the request.
	PspReference string `json:"pspReference,omitempty"`
	// The result code.
	ResultCode string `json:"resultCode,omitempty"`
}

TestNotificationConfigurationResponse struct for TestNotificationConfigurationResponse

type UpdateNotificationConfigurationRequest 

type UpdateNotificationConfigurationRequest struct {
	ConfigurationDetails NotificationConfigurationDetails `json:"configurationDetails"`
}

UpdateNotificationConfigurationRequest struct for UpdateNotificationConfigurationRequest

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.