adyen

Documentation

Index

• Constants
• type APIClient
  • func NewClient(cfg *common.Config) *APIClient
  • func (c *APIClient) BalanceControl() *balancecontrol.GeneralApi
  • func (c *APIClient) BalancePlatform() *balanceplatform.APIClient
  • func (c *APIClient) BinLookup() *binlookup.GeneralApi
  • func (c *APIClient) Checkout() *checkout.APIClient
  • func (c *APIClient) DataProtection() *dataprotection.GeneralApi
  • func (c *APIClient) Disputes() *disputes.GeneralApi
  • func (c *APIClient) GetConfig() *common.Config
  • func (c *APIClient) LegalEntity() *legalentity.APIClient
  • func (c *APIClient) Management() *management.APIClient
  • func (c *APIClient) Payments() *payments.APIClient
  • func (c *APIClient) PaymentsApp() *paymentsapp.PaymentsAppApi
  • func (c *APIClient) Payout() *payout.APIClient
  • func (c *APIClient) PlatformsAccount() *platformsaccount.PlatformsAccount
  • func (c *APIClient) PlatformsFund() *platformsfund.PlatformsFund
  • func (c *APIClient) PlatformsHostedOnboardingPage() *platformshostedonboardingpage.PlatformsHostedOnboardingPage
  • func (c *APIClient) PlatformsNotificationConfiguration() *platformsnotificationconfiguration.PlatformsNotificationConfiguration
  • func (c *APIClient) PosTerminalManagement() *posterminalmanagement.GeneralApi
  • func (c *APIClient) Recurring() *recurring.GeneralApi
  • func (c *APIClient) SetEnvironment(env common.Environment, liveEndpointURLPrefix string)
  • func (c *APIClient) StoredValue() *storedvalue.GeneralApi
  • func (c *APIClient) Transfers() *transfers.APIClient

Constants

const (
	EndpointTest                      = "https://pal-test.adyen.com"
	EndpointLive                      = "https://pal-live.adyen.com"
	EndpointLiveSuffix                = "-pal-live.adyenpayments.com"
	MarketpayEndpointTest             = "https://cal-test.adyen.com/cal/services"
	MarketpayEndpointLive             = "https://cal-live.adyen.com/cal/services"
	CheckoutEndpointTest              = "https://checkout-test.adyen.com/checkout"
	CheckoutEndpointLiveSuffix        = "-checkout-live.adyenpayments.com/checkout"
	TerminalAPIEndpointTest           = "https://terminal-api-test.adyen.com"
	TerminalAPIEndpointLive           = "https://terminal-api-live.adyen.com"
	DisputesEndpointTest              = "https://ca-test.adyen.com/ca/services/DisputeService"
	DisputesEndpointLive              = "https://ca-live.adyen.com/ca/services/DisputeService"
	BalancePlatformEndpointTest       = "https://balanceplatform-api-test.adyen.com/bcl"
	BalancePlatformEndpointLive       = "https://balanceplatform-api-live.adyen.com/bcl"
	TransfersEndpointTest             = "https://balanceplatform-api-test.adyen.com/btl"
	TransfersEndpointLive             = "https://balanceplatform-api-live.adyen.com/btl"
	ManagementEndpointTest            = "https://management-test.adyen.com"
	ManagementEndpointLive            = "https://management-live.adyen.com"
	LegalEntityEntityTest             = "https://kyc-test.adyen.com/lem"
	LegalEntityEntityLive             = "https://kyc-live.adyen.com/lem"
	PosTerminalManagementEndpointTest = "https://postfmapi-test.adyen.com/postfmapi/terminal"
	PosTerminalManagementEndpointLive = "https://postfmapi-live.adyen.com/postfmapi/terminal"
	DataProtectionEndpointTest        = "https://ca-test.adyen.com/ca/services/DataProtectionService"
	DataProtectionEndpointLive        = "https://ca-live.adyen.com/ca/services/DataProtectionService"
)

Constants used for the client API

const (
	MarketpayAccountAPIVersion      = "v6"
	MarketpayFundAPIVersion         = "v6"
	MarketpayNotificationAPIVersion = "v6"
	MarketpayHopAPIVersion          = "v6"
	PaymentAPIVersion               = "v68"
	PaymentsAppAPIVersion           = "v1"
	RecurringAPIVersion             = "v68"
	CheckoutAPIVersion              = "v71"
	BinLookupAPIVersion             = "v54"
	BalanceControlAPIVersion        = "v1"
	EndpointProtocol                = "https://"
	DisputesAPIVersion              = "v30"
	StoredValueAPIVersion           = "v46"
	BalancePlatformAPIVersion       = "v2"
	TransfersAPIVersion             = "v4"
	ManagementAPIVersion            = "v3"
	LegalEntityAPIVersion           = "v3"
	PosTerminalManagementAPIVersion = "v1"
	DataProtectionAPIVersion        = "v1"
)

also update LibVersion in src/common/configuration.go when a version is updated and a major lib version is released

Types

type APIClient

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

APIClient Manages access to Adyen API services. In most cases there should be only one, shared, APIClient.

func NewClient

func NewClient(cfg *common.Config) *APIClient

NewClient creates a new API client. Requires Config object.

@param config A reference to common.Config object

create a new API client based on provided api key & url prefix for LIVE environment

client := NewClient(&common.Config{
   ApiKey:                "apiKey",
   Environment:           common.LiveEnv,
   LiveEndpointURLPrefix: "liveEndpointURLPrefix",
})

ApiKey                Defines the api key that can be retrieved by back office
Environment           This defines the payment environment live or test
LiveEndpointURLPrefix Provide the unique live url prefix from the "API URLs and Response" menu in the Adyen Customer Area

create a new API client based on provided api key for TEST environment

client := NewClient(&common.Config{
   ApiKey:                "apiKey",
   Environment:           common.TestEnv,
})

ApiKey                Defines the api key that can be retrieved by back office
Environment           This defines the payment environment live or test

creates a new API client based on provided credentials & url prefix for LIVE environment

client := NewClient(&common.Config{
    Username:              "username",
    Password:              "password",
    ApplicationName:       "applicationName",
    Environment:           common.LiveEnv,
    LiveEndpointURLPrefix: "liveEndpointURLPrefix",
})

Username              Your merchant account Username
Password              Your merchant accont Password
Environment           This defines the payment environment live or test
ApplicationName       Application name to be used in user agent
LiveEndpointUrlPrefix Provide the unique live url prefix from the "API URLs and Response" menu in the Adyen Customer Area

creates a new API client based on provided credentials for TEST environment

client := NewClient(&common.Config{
    Username:              "username",
    Password:              "password",
    ApplicationName:       "applicationName",
    Environment:           common.TestEnv,
})

Username              Your merchant account Username
Password              Your merchant accont Password
Environment           This defines the payment environment live or test
ApplicationName       Application name to be used in user agent

optionally a custom http.Client can be passed via the Config allow for advanced features such as caching.

func (*APIClient) BalanceControl

func (c *APIClient) BalanceControl() *balancecontrol.GeneralApi

func (*APIClient) BalancePlatform

func (c *APIClient) BalancePlatform() *balanceplatform.APIClient

func (*APIClient) BinLookup

func (c *APIClient) BinLookup() *binlookup.GeneralApi

func (*APIClient) Checkout

func (c *APIClient) Checkout() *checkout.APIClient

func (*APIClient) DataProtection

func (c *APIClient) DataProtection() *dataprotection.GeneralApi

func (*APIClient) Disputes

func (c *APIClient) Disputes() *disputes.GeneralApi

func (*APIClient) GetConfig

func (c *APIClient) GetConfig() *common.Config

GetConfig Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

func (*APIClient) LegalEntity

func (c *APIClient) LegalEntity() *legalentity.APIClient

func (*APIClient) Management

func (c *APIClient) Management() *management.APIClient

func (*APIClient) Payments

func (c *APIClient) Payments() *payments.APIClient

func (*APIClient) PaymentsApp

func (c *APIClient) PaymentsApp() *paymentsapp.PaymentsAppApi

API Services

func (*APIClient) Payout

func (c *APIClient) Payout() *payout.APIClient

func (*APIClient) PlatformsAccount

func (c *APIClient) PlatformsAccount() *platformsaccount.PlatformsAccount

Deprecated: Please migrate to the new Adyen For Platforms.

func (*APIClient) PlatformsFund

func (c *APIClient) PlatformsFund() *platformsfund.PlatformsFund

Deprecated: Please migrate to the new Adyen For Platforms.

func (*APIClient) PlatformsHostedOnboardingPage

func (c *APIClient) PlatformsHostedOnboardingPage() *platformshostedonboardingpage.PlatformsHostedOnboardingPage

Deprecated: Please migrate to the new Adyen For Platforms.

func (*APIClient) PlatformsNotificationConfiguration

func (c *APIClient) PlatformsNotificationConfiguration() *platformsnotificationconfiguration.PlatformsNotificationConfiguration

Deprecated: Please migrate to the new Adyen For Platforms.

func (*APIClient) PosTerminalManagement

func (c *APIClient) PosTerminalManagement() *posterminalmanagement.GeneralApi

func (*APIClient) Recurring

func (c *APIClient) Recurring() *recurring.GeneralApi

func (*APIClient) SetEnvironment

func (c *APIClient) SetEnvironment(env common.Environment, liveEndpointURLPrefix string)

SetEnvironment This defines the payment environment for live or test

• @param environment This defines the payment environment live or test
• @param liveEndpointUrlPrefix Provide the unique live url prefix from the "API URLs and Response" menu in the Adyen Customer Area

func (*APIClient) StoredValue

func (c *APIClient) StoredValue() *storedvalue.GeneralApi

func (*APIClient) Transfers

func (c *APIClient) Transfers() *transfers.APIClient